diff options
| author | Loïc Hoguin <[email protected]> | 2019-04-26 20:30:51 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-04-26 20:30:51 +0200 |
| commit | cee8c6625bd7a09db88daf5e9767cced66fb5c15 (patch) | |
| tree | 7948616a11e1025c10e60c60f563b6d331d88ee8 /doc | |
| parent | 352206dee80905b10fa9af97f065ce7bee928d87 (diff) | |
| download | gun-cee8c6625bd7a09db88daf5e9767cced66fb5c15.tar.gz gun-cee8c6625bd7a09db88daf5e9767cced66fb5c15.tar.bz2 gun-cee8c6625bd7a09db88daf5e9767cced66fb5c15.zip | |
Add upgrade/ws tuples to gun:await/2,3,4
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/manual/gun.await.asciidoc | 8 | ||||
| -rw-r--r-- | doc/src/manual/gun.await_body.asciidoc | 1 | ||||
| -rw-r--r-- | doc/src/manual/gun.await_up.asciidoc | 1 |
3 files changed, 9 insertions, 1 deletions
diff --git a/doc/src/manual/gun.await.asciidoc b/doc/src/manual/gun.await.asciidoc index 09c244b..0af6cee 100644 --- a/doc/src/manual/gun.await.asciidoc +++ b/doc/src/manual/gun.await.asciidoc @@ -69,6 +69,8 @@ Result :: {inform, Status, Headers} | {data, IsFin, Data} | {trailers, Trailers} | {push, NewStreamRef, Method, URI, Headers} + | {upgrade, Protocols, Headers} + | {ws, Frame} | {error, Reason} Reason :: {stream_error | connection_error | down, any()} @@ -79,14 +81,18 @@ Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information: -* link:man:gun_push(3)[gun_push(3)] - Server-initiated push * link:man:gun_inform(3)[gun_inform(3)] - Informational response * link:man:gun_response(3)[gun_response(3)] - Response * link:man:gun_data(3)[gun_data(3)] - Response body * link:man:gun_trailers(3)[gun_trailers(3)] - Response trailers +* link:man:gun_push(3)[gun_push(3)] - Server-initiated push +* link:man:gun_upgrade(3)[gun_upgrade(3)] - Successful protocol upgrade +* link:man:gun_ws(3)[gun_ws(3)] - Websocket frame == Changelog +* *2.0*: `upgrade` and `ws` tuples can now be returned. +* *2.0*: The error tuple type now includes the type of error. * *1.0*: Function introduced. == Examples diff --git a/doc/src/manual/gun.await_body.asciidoc b/doc/src/manual/gun.await_body.asciidoc index 0505112..c2c7133 100644 --- a/doc/src/manual/gun.await_body.asciidoc +++ b/doc/src/manual/gun.await_body.asciidoc @@ -61,6 +61,7 @@ may also be returned when a timeout or an error occur. == Changelog +* *2.0*: The error tuple type now includes the type of error. * *1.0*: Function introduced. == Examples diff --git a/doc/src/manual/gun.await_up.asciidoc b/doc/src/manual/gun.await_up.asciidoc index 2639943..dfd4da9 100644 --- a/doc/src/manual/gun.await_up.asciidoc +++ b/doc/src/manual/gun.await_up.asciidoc @@ -54,6 +54,7 @@ may also be returned when a timeout or an error occur. == Changelog +* *2.0*: The error tuple type now includes the type of error. * *1.0*: Function introduced. == Examples |