From eb808a3f8bbd97d2a2ea0114b43b708a17b44066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 11 Apr 2025 14:34:51 +0200 Subject: Gun 2.2.0 --- docs/en/gun/2.2/manual/gun.ws_send/index.html | 219 ++++++++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100644 docs/en/gun/2.2/manual/gun.ws_send/index.html (limited to 'docs/en/gun/2.2/manual/gun.ws_send') diff --git a/docs/en/gun/2.2/manual/gun.ws_send/index.html b/docs/en/gun/2.2/manual/gun.ws_send/index.html new file mode 100644 index 00000000..578c0d1a --- /dev/null +++ b/docs/en/gun/2.2/manual/gun.ws_send/index.html @@ -0,0 +1,219 @@ + + + + + + + + + + Nine Nines: gun:ws_send(3) + + + + + + + + + + + + + +
+
+
+
+

99s

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

gun:ws_send(3)

+ +

Name

+

gun:ws_send - Send Websocket frames

+

Description

+
+
ws_send(ConnPid, StreamRef, Frames) -> ok
+
+ConnPid   :: pid()
+StreamRef :: gun:stream_ref()
+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 gun:ws_upgrade(3).

+

Arguments

+
ConnPid
+

The pid of the Gun connection process.

+
+
StreamRef
+

Identifier of the stream that was upgraded to Websocket.

+
+
Frames
+

One or more Websocket frame(s).

+
+
+

Return value

+

The atom ok is returned.

+

Changelog

+
  • 2.0: The mandatory StreamRef argument was added. +
    • +
  • 2.0: It is now possible to send multiple frames at once. +
    • +
  • 1.0: Function introduced. +
    • +
+

Examples

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

See also

+

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

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

+ Gun + 2.2 + 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