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

99s

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

gun_upgrade(3)

+ +
+

Name

+
+

gun_upgrade - Successful protocol upgrade

+
+
+
+

Description

+
+
+
+
{gun_upgrade, ConnPid, StreamRef, Protocols, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Protocols :: [<<"websocket">>]
+Headers   :: [{binary(), binary()}]
+

Successful protocol upgrade.

+

This message informs the relevant process that the server +accepted to upgrade to one or more protocols given in the +original request.

+

The exact semantics of this message depend on the original +protocol. HTTP/1.1 upgrades apply to the entire connection. +HTTP/2 uses a different mechanism which allows switching +specific streams to a different protocol.

+

Gun currently only supports upgrading HTTP/1.1 connections +to the Websocket protocol.

+
+
+
+

Elements

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+StreamRef +
+
+

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

+
+
+Protocols +
+
+

+List of protocols this stream was upgraded to. +

+
+
+Headers +
+
+

+Headers sent with the upgrade response. +

+
+
+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Message introduced. +

    +
    • +
+
+
+
+

Examples

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

See also

+
+

gun(3), +gun:ws_upgrade(3), +gun:ws_send(3), +gun_ws(3)

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

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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