From 7d61b485e47e247d7ecac500c83a902ab934f569 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 16 Nov 2020 16:12:55 +0100 Subject: Update documentation --- docs/en/gun/2.0/manual/gun.ws_send/index.html | 28 +++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) (limited to 'docs/en/gun/2.0/manual/gun.ws_send/index.html') diff --git a/docs/en/gun/2.0/manual/gun.ws_send/index.html b/docs/en/gun/2.0/manual/gun.ws_send/index.html index f7318b1d..9761cf74 100644 --- a/docs/en/gun/2.0/manual/gun.ws_send/index.html +++ b/docs/en/gun/2.0/manual/gun.ws_send/index.html @@ -69,13 +69,14 @@ by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -
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()}
+
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).

@@ -83,6 +84,9 @@ http://www.gnu.org/software/src-highlite -->
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).

@@ -90,7 +94,11 @@ http://www.gnu.org/software/src-highlite -->

Return value

The atom ok is returned.

Changelog

-