aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.ws_send.asciidoc
blob: b39f3f082a87985936b64dc043158412d85306bd (plain) (blame)
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_send(3)

== Name

gun:ws_send - Send Websocket frames

== Description

[source,erlang]
----
ws_send(ConnPid, Frames) -> ok

ConnPid :: pid()
Frames  :: Frame | [Frame]
Frame   :: close | ping | pong
         | {text | binary | close | ping | pong, iodata()}
         | {close, non_neg_integer(), iodata()}
----

Send Websocket frames.

The connection must first be upgraded to Websocket using
the function link:man:gun:ws_upgrade(3)[gun:ws_upgrade(3)].

== Arguments

ConnPid::

The pid of the Gun connection process.

Frames::

One or more Websocket frame(s).

== Return value

The atom `ok` is returned.

== Changelog

* *1.0*: Function introduced.

== Examples

.Send a single frame
[source,erlang]
----
gun:ws_send(ConnPid, {text, <<"Hello world!">>}).
----

.Send many frames including a close frame
[source,erlang]
----
gun:ws_send(ConnPid, [
    {text, <<"See you later, world!">>},
    close
]).
----

== See also

link:man:gun(3)[gun(3)],
link:man:gun:ws_upgrade(3)[gun:ws_upgrade(3)],
link:man:gun_upgrade(3)[gun_upgrade(3)],
link:man:gun_ws(3)[gun_ws(3)]