aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-09-23 11:55:36 +0200
committerLoïc Hoguin <[email protected]>2019-09-23 11:55:36 +0200
commit5793cfb2ca439eada5a3a0be168d83ed7b2d2a13 (patch)
tree532e38c31f11183b1b6b60a3744edf84eddd4333
parentd143c3677c9fa93fa2fde648c878faccae12520a (diff)
downloadgun-5793cfb2ca439eada5a3a0be168d83ed7b2d2a13.tar.gz
gun-5793cfb2ca439eada5a3a0be168d83ed7b2d2a13.tar.bz2
gun-5793cfb2ca439eada5a3a0be168d83ed7b2d2a13.zip
Document sending N Websocket frames in the guide
-rw-r--r--doc/src/guide/websocket.asciidoc23
1 files changed, 11 insertions, 12 deletions
diff --git a/doc/src/guide/websocket.asciidoc b/doc/src/guide/websocket.asciidoc
index 8503670..662b9ea 100644
--- a/doc/src/guide/websocket.asciidoc
+++ b/doc/src/guide/websocket.asciidoc
@@ -96,20 +96,19 @@ Use `gun:ws_send/2` to send messages to the server.
gun:ws_send(ConnPid, {text, "Hello!"}).
----
-// @todo Implement sending of N frames
-//
-//.Send a text frame, a binary frame and then close the connection
-//[source,erlang]
-//----
-//gun:ws_send(ConnPid, [
-// {text, "Hello!"},
-// {binary, BinaryValue},
-// close
-//]).
-//----
+.Send a text frame, a binary frame and then close the connection
+[source,erlang]
+----
+gun:ws_send(ConnPid, [
+ {text, "Hello!"},
+ {binary, BinaryValue},
+ close
+]).
+----
Note that if you send a close frame, Gun will close the connection
-cleanly but will attempt to reconnect afterwards.
+cleanly but may attempt to reconnect afterwards depending on the
+`retry` configuration.
=== Receiving data