diff options
| author | Loïc Hoguin <[email protected]> | 2019-09-24 19:18:35 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-09-24 19:28:48 +0200 |
| commit | d9a970be90d0105af215531d74809878f9c21338 (patch) | |
| tree | eb891e8c9373dee9f7353a9920aaf25f6b2f2570 /doc/src/manual/gun_ws.asciidoc | |
| parent | a18ca0ae8ff76594c7b629f4340adab0a30954c4 (diff) | |
| download | gun-d9a970be90d0105af215531d74809878f9c21338.tar.gz gun-d9a970be90d0105af215531d74809878f9c21338.tar.bz2 gun-d9a970be90d0105af215531d74809878f9c21338.zip | |
Add auto-ping to Websocket and a silence_pings option
The auto-ping will at regular interval send a ping frame.
The silence_pings option defaults to true. It can be set
to false when the user needs to receive ping/pong frames.
Diffstat (limited to 'doc/src/manual/gun_ws.asciidoc')
| -rw-r--r-- | doc/src/manual/gun_ws.asciidoc | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/src/manual/gun_ws.asciidoc b/doc/src/manual/gun_ws.asciidoc index 127f2a2..374b0b3 100644 --- a/doc/src/manual/gun_ws.asciidoc +++ b/doc/src/manual/gun_ws.asciidoc @@ -12,9 +12,10 @@ gun_ws - Websocket frame ConnPid :: pid() StreamRef :: reference() -Frame :: close +Frame :: close | ping | pong | {text | binary | close, binary()} | {close, non_neg_integer(), binary()} + | {ping | pong, binary()} ---- Websocket frame. @@ -41,6 +42,8 @@ The Websocket frame in question. == Changelog +* *2.0*: Depending on the option `silence_pings`, ping and + pong frames may be sent as well. * *1.0*: Message introduced. == Examples |