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

99s

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

gun_error(3)

+ +
+

Name

+
+

gun_error - Stream or connection-wide error

+
+
+
+

Description

+
+
+
+
{gun_error, ConnPid, StreamRef, Reason}
+{gun_error, ConnPid, Reason}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Reason    :: any()
+

Stream or connection-wide error.

+

These messages inform the relevant process that an error +occurred. A reference is given when the error pertains +to a specific stream. Connection-wide errors do not +imply that the connection is no longer usable, they are +used for all errors that are not specific to a stream.

+
+
+
+

Elements

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+StreamRef +
+
+

+Identifier of the stream that resulted in an error. +

+
+
+Reason +
+
+

+The reason for the error. +

+

It is present for debugging purposes only. You should not +rely on this value to perform operations programmatically.

+
+
+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Message introduced. +

    +
    • +
+
+
+
+

Examples

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

See also

+
+

gun(3), +gun_up(3), +gun_down(3)

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

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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