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_inform/index.html | 239 +++++++++++++++++++++++++++ 1 file changed, 239 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun_inform/index.html (limited to 'docs/en/gun/1.0/manual/gun_inform') diff --git a/docs/en/gun/1.0/manual/gun_inform/index.html b/docs/en/gun/1.0/manual/gun_inform/index.html new file mode 100644 index 00000000..7f04b59b --- /dev/null +++ b/docs/en/gun/1.0/manual/gun_inform/index.html @@ -0,0 +1,239 @@ + + + + + + + + + + Nine Nines: gun_inform(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

gun_inform(3)

+ +
+

Name

+
+

gun_inform - Informational response

+
+
+
+

Description

+
+
+
+
{gun_inform, ConnPid, StreamRef, Status, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Status    :: 100..199
+Headers   :: [{binary(), binary()}]
+

Informational response.

+

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

+

Informational responses are only intermediate responses +and provide no guarantees as to what the final response +will be. An informational response always precedes the +response to the original request.

+
+
+
+

Elements

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+StreamRef +
+
+

+Identifier of the stream for the original request. +

+
+
+Status +
+
+

+Status code for the informational response. +

+
+
+Headers +
+
+

+Headers sent with the informational response. +

+
+
+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Message introduced. +

    +
    • +
+
+
+
+

Examples

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

See also

+
+

gun(3), +gun:get(3), +gun:patch(3), +gun:post(3), +gun:put(3), +gun_response(3)

+
+
+ + + + + +
+ +
+ + +

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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