1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
= gun_ws(3)
== Name
gun_ws - Websocket frame
== Description
[source,erlang]
----
{gun_ws, ConnPid, StreamRef, Frame}
ConnPid :: pid()
StreamRef :: reference()
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
[source,erlang]
----
handle_info({gun_ws, ConnPid, _StreamRef, _Frame},
State=#state{conn_pid=ConnPid}) ->
%% Do something.
{noreply, State}.
----
== See also
link:man:gun(3)[gun(3)],
link:man:gun:ws_upgrade(3)[gun:ws_upgrade(3)],
link:man:gun:ws_send(3)[gun:ws_send(3)],
link:man:gun_upgrade(3)[gun_upgrade(3)]
|
