From 5e05fe8e7877ffd6bc473b77b8ca0a12ad26bd67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Mar 2024 16:23:56 +0100 Subject: Cowboy 2.12, Cowlib 2.13, Gun 2.1 --- docs/en/gun/2.1/manual/gun_ws/index.html | 207 +++++++++++++++++++++++++++++++ 1 file changed, 207 insertions(+) create mode 100644 docs/en/gun/2.1/manual/gun_ws/index.html (limited to 'docs/en/gun/2.1/manual/gun_ws/index.html') diff --git a/docs/en/gun/2.1/manual/gun_ws/index.html b/docs/en/gun/2.1/manual/gun_ws/index.html new file mode 100644 index 00000000..5d6fd65b --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_ws/index.html @@ -0,0 +1,207 @@ + + + + + + + + + + Nine Nines: gun_ws(3) + + + + + + + + + + + + + +
+
+
+
+

99s

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

gun_ws(3)

+ +

Name

+

gun_ws - Websocket frame

+

Description

+
+
{gun_ws, ConnPid, StreamRef, Frame}
+
+ConnPid   :: pid()
+StreamRef :: gun:stream_ref()
+Frame     :: close | ping | pong
+           | {text | binary | close, binary()}
+           | {close, non_neg_integer(), binary()}
+           | {ping | pong, binary()}
+
+

Websocket frame.

+

This message informs the relevant process that the server sent the enclosed frame.

+

This message can only be sent on streams that were upgraded to the Websocket protocol.

+

Elements

+
ConnPid
+

The pid of the Gun connection process.

+
+
StreamRef
+

Identifier of the stream that was upgraded to Websocket.

+
+
Frame
+

The Websocket frame in question.

+
+
+

Changelog

+
  • 2.0: Depending on the option silence_pings, ping and pong frames may be sent as well. +
    • +
  • 1.0: Message introduced. +
    • +
+

Examples

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

See also

+

gun(3), gun:ws_upgrade(3), gun:ws_send(3), gun_upgrade(3)

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

+ Gun + 2.1 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3