From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/gun/1.0/manual/gun_push/index.html | 161 +++++++++-------------------- 1 file changed, 48 insertions(+), 113 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun_push') diff --git a/docs/en/gun/1.0/manual/gun_push/index.html b/docs/en/gun/1.0/manual/gun_push/index.html index 86229224..15075e15 100644 --- a/docs/en/gun/1.0/manual/gun_push/index.html +++ b/docs/en/gun/1.0/manual/gun_push/index.html @@ -62,141 +62,76 @@

gun_push(3)

-

Name

-
-

gun_push - Server-initiated push

-
-
-
+

gun_push - Server-initiated push

Description

-
-
-
-
{gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers}
-
-ConnPid      :: pid()
-StreamRef    :: reference()
-NewStreamRef :: reference()
-Method       :: binary()
-URI          :: binary()
-Headers      :: [{binary(), binary()}]
-

Server-initiated push.

-

This message informs the relevant process that the server -is pushing a resource related to the effective target URI -of the original request.

-

A server-initiated push message always precedes the response -to the original request.

-

This message will not be sent when using the HTTP/1.1 protocol -because it lacks the concept of server-initiated push.

-
-
-
+
{gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers}
+
+ConnPid      :: pid()
+StreamRef    :: reference()
+NewStreamRef :: reference()
+Method       :: binary()
+URI          :: binary()
+Headers      :: [{binary(), binary()}]
+
+

Server-initiated push.

+

This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request.

+

A server-initiated push message always precedes the response to the original request.

+

This message will not be sent when using the HTTP/1.1 protocol because it lacks the concept of server-initiated push.

Elements

-
-
-
-ConnPid -
-
-

-The pid of the Gun connection process. -

+
ConnPid
+

The pid of the Gun connection process.

-
-StreamRef -
-
-

-Identifier of the stream for the original request. -

+
StreamRef
+

Identifier of the stream for the original request.

-
-NewStreamRef -
-
-

-Identifier of the stream being pushed. -

+
NewStreamRef
+

Identifier of the stream being pushed.

-
-Method -
-
-

-Method of the equivalent HTTP request. -

+
Method
+

Method of the equivalent HTTP request.

-
-URI -
-
-

-URI of the resource being pushed. -

+
URI
+

URI of the resource being pushed.

-
-Headers -
-
-

-Headers of the equivalent HTTP request. -

+
Headers
+

Headers of the equivalent HTTP request.

-
-
- -
+

Changelog

-
-
    -
  • -

    -1.0: Message introduced. -

    +
    • 1.0: Message introduced.
      • -
-
-
-
+

Examples

-
-
-
Receive a gun_push message in a gen_server
-
-
handle_info({gun_push, ConnPid, _StreamRef,
-             _NewStreamRef, _Method, _URI, _Headers},
-            State=#state{conn_pid=ConnPid}) ->
-    %% Do something.
-    {noreply, State}.
-
-
Cancel an unwanted push
-
-
handle_info({gun_push, ConnPid, _StreamRef,
-             NewStreamRef, _Method, _URI, _Headers},
-            State=#state{conn_pid=ConnPid}) ->
-    gun:cancel(ConnPid, NewStreamRef),
-    {noreply, State}.
-
-
-
+
handle_info({gun_push, ConnPid, _StreamRef,
+             NewStreamRef, _Method, _URI, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    gun:cancel(ConnPid, NewStreamRef),
+    {noreply, State}.
+

See also

-
-

gun(3), -gun:get(3), -gun:cancel(3), -gun_response(3)

-
- +

gun(3), gun:get(3), gun:cancel(3), gun_response(3)

+ -- cgit v1.2.3