From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/gun/1.0/manual/gun_upgrade/index.html | 125 +++++++------------------- 1 file changed, 34 insertions(+), 91 deletions(-) (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 index 56e8e569..ec4fdff2 100644 --- a/docs/en/gun/1.0/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun_upgrade/index.html @@ -62,114 +62,57 @@

gun_upgrade(3)

-

Name

-
-

gun_upgrade - Successful protocol upgrade

-
-
-
+

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.

-
-
-
+
{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. -

+
ConnPid
+

The pid of the Gun connection process.

-
-StreamRef -
-
-

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

+
StreamRef
+

Identifier of the stream that resulted in an upgrade.

-
-Protocols -
-
-

-List of protocols this stream was upgraded to. -

+
Protocols
+

List of protocols this stream was upgraded to.

-
-Headers -
-
-

-Headers sent with the upgrade response. -

+
Headers
+

Headers sent with the upgrade response.

-
-
- -
+

Changelog

-
-
    -
  • -

    -1.0: Message introduced. -

    +
    • 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}.
-
-
-
+
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(3), gun:ws_upgrade(3), gun:ws_send(3), gun_ws(3)

+ -- cgit v1.2.3