aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.ws_send.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/gun.ws_send.asciidoc')
-rw-r--r--doc/src/manual/gun.ws_send.asciidoc65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/src/manual/gun.ws_send.asciidoc b/doc/src/manual/gun.ws_send.asciidoc
new file mode 100644
index 0000000..307cfae
--- /dev/null
+++ b/doc/src/manual/gun.ws_send.asciidoc
@@ -0,0 +1,65 @@
+= gun:ws_send(3)
+
+== Name
+
+gun:ws_send - Send one or more Websocket frame(s)
+
+== 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 one or more Websocket frame(s).
+
+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)]