From 2b588340af501825f3ab03f2e76dba0353c98fae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Jun 2018 12:59:26 +0200 Subject: Update documentation for Gun 1.0 --- docs/en/gun/1.0/manual/gun_response/index.html | 249 +++++++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun_response/index.html (limited to 'docs/en/gun/1.0/manual/gun_response/index.html') diff --git a/docs/en/gun/1.0/manual/gun_response/index.html b/docs/en/gun/1.0/manual/gun_response/index.html new file mode 100644 index 00000000..379142ba --- /dev/null +++ b/docs/en/gun/1.0/manual/gun_response/index.html @@ -0,0 +1,249 @@ + + + + + + + + + + Nine Nines: gun_response(3) + + + + + + + + + + + + + + + + +
+
+
+
+ +

gun_response(3)

+ +
+

Name

+
+

gun_response - Response

+
+
+
+

Description

+
+
+
+
{gun_response, ConnPid, StreamRef, IsFin, Status, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+IsFin     :: fin | nofin
+Status    :: non_neg_integer()
+Headers   :: [{binary(), binary()}]
+

Response.

+

This message informs the relevant process that the server +sent a response to the original request.

+
+
+
+

Elements

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+StreamRef +
+
+

+Identifier of the stream for the original request. +

+
+
+IsFin +
+
+

+Whether this message terminates the response. +

+
+
+Status +
+
+

+Status code for the response. +

+
+
+Headers +
+
+

+Headers sent with the response. +

+
+
+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Message introduced. +

    +
  • +
+
+
+
+

Examples

+
+
+
Receive a gun_response message in a gen_server
+
+
handle_info({gun_response, ConnPid, _StreamRef,
+             _IsFin, _Status, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
+
+
+ + + + + + +
+ +
+ + +

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 1.0
  • + +
+ +
+
+
+
+ + + + + + + + + -- cgit v1.2.3