aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-09-26 13:40:26 +0200
committerLoïc Hoguin <[email protected]>2019-09-26 13:41:02 +0200
commitddc87f339f441fe5b62455606cf6ed6fb8dbc461 (patch)
tree7d33d7bf37d2216b2e6a72c0280c1e26dea2c7b8 /doc
parent00cc1f385f94823a0684deee001b643091e235b0 (diff)
downloadgun-ddc87f339f441fe5b62455606cf6ed6fb8dbc461.tar.gz
gun-ddc87f339f441fe5b62455606cf6ed6fb8dbc461.tar.bz2
gun-ddc87f339f441fe5b62455606cf6ed6fb8dbc461.zip
Remove UnprocessedStreams from the gun_down message
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun_down.asciidoc16
1 files changed, 4 insertions, 12 deletions
diff --git a/doc/src/manual/gun_down.asciidoc b/doc/src/manual/gun_down.asciidoc
index 6c72898..6785cb5 100644
--- a/doc/src/manual/gun_down.asciidoc
+++ b/doc/src/manual/gun_down.asciidoc
@@ -8,13 +8,12 @@ gun_down - The connection is down
[source,erlang]
----
-{gun_down, ConnPid, Protocol, Reason, KilledStreams, UnprocessedStreams}
+{gun_down, ConnPid, Protocol, Reason, KilledStreams}
ConnPid :: pid()
Protocol :: http | http2 | socks | ws
Reason :: any()
KilledStreams :: [reference()]
-UnprocessedStreams :: [reference()]
----
The connection is down.
@@ -53,16 +52,10 @@ They are active streams that did not complete before the closing
of the connection. Whether they can be retried safely depends
on the protocol used and the idempotence property of the requests.
-UnprocessedStreams::
-
-List of streams that have not been processed by the server.
-+
-They are streams that the server did not start processing yet.
-They may be retried safely depending on whether related streams
-were killed.
-
== Changelog
+* *2.0*: The last element of the message's tuple, `UnprocessedStreams`
+ has been removed.
* *1.0*: Message introduced.
== Examples
@@ -70,8 +63,7 @@ were killed.
.Receive a gun_down message in a gen_server
[source,erlang]
----
-handle_info({gun_down, ConnPid, _Protocol,
- _Reason, _Killed, _Unprocessed},
+handle_info({gun_down, ConnPid, _Protocol, _Reason, _Killed},
State=#state{conn_pid=ConnPid}) ->
%% Do something.
{noreply, State}.