diff options
| author | Loïc Hoguin <[email protected]> | 2025-03-28 15:18:59 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2025-03-28 15:18:59 +0100 |
| commit | 5a0c8f31c4ae1885fd05f627f89c088bcbe2b4d0 (patch) | |
| tree | cd4b49afe1f5b450a441fbabc0588a62e14a947f /doc/src | |
| parent | 694fed991b4611147f2da73a183d3b8768f4b45d (diff) | |
| download | gun-5a0c8f31c4ae1885fd05f627f89c088bcbe2b4d0.tar.gz gun-5a0c8f31c4ae1885fd05f627f89c088bcbe2b4d0.tar.bz2 gun-5a0c8f31c4ae1885fd05f627f89c088bcbe2b4d0.zip | |
Recommend disabling automatic reconnect for Websocket
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/guide/protocols.asciidoc | 5 | ||||
| -rw-r--r-- | doc/src/guide/websocket.asciidoc | 17 |
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/src/guide/protocols.asciidoc b/doc/src/guide/protocols.asciidoc index daf2d66..cb354fa 100644 --- a/doc/src/guide/protocols.asciidoc +++ b/doc/src/guide/protocols.asciidoc @@ -87,6 +87,11 @@ is sending Websocket frames using `gun:ws_send/3`. Gun will send a `gun_ws` message for every frame received. +It is recommended to disable automatic reconnect when +Websocket is used because Gun cannot automatically upgrade +to Websocket on reconnect, and so an undetected disconnect +may lead to many error messages from Gun. + === Summary The two following tables summarize the supported operations diff --git a/doc/src/guide/websocket.asciidoc b/doc/src/guide/websocket.asciidoc index ba06e2c..31b014b 100644 --- a/doc/src/guide/websocket.asciidoc +++ b/doc/src/guide/websocket.asciidoc @@ -122,3 +122,20 @@ receive handle_frame(ConnPid, StreamRef, Frame) end. ---- + +=== Automatic reconnect gotchas + +It is recommended to disable automatic reconnect when +Websocket is used because Gun cannot automatically upgrade +to Websocket on reconnect, and so an undetected disconnect +may lead to many error messages from Gun. + +This can be done by setting the `retry` option to `0` +when opening a connection: + +[source,erlang] +---- +{ok, ConnPid} = gun:open("localhost", 12345, #{ + retry ⇒ 0 +}). +---- |