diff options
| author | Loïc Hoguin <[email protected]> | 2015-04-10 13:16:34 +0300 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2015-04-10 13:16:34 +0300 |
| commit | c46991067a53c81316a69c1df7c7dc590f3ca308 (patch) | |
| tree | 0225a7e2b482cf436feb643eb045404fc8986819 /doc | |
| parent | ba90cb2475c45b5348c4ff7f4f77729f04a98114 (diff) | |
| download | gun-c46991067a53c81316a69c1df7c7dc590f3ca308.tar.gz gun-c46991067a53c81316a69c1df7c7dc590f3ca308.tar.bz2 gun-c46991067a53c81316a69c1df7c7dc590f3ca308.zip | |
Document Websocket options in the manual
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/manual/gun.asciidoc | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc index 902af9a..fb457a4 100644 --- a/doc/src/manual/gun.asciidoc +++ b/doc/src/manual/gun.asciidoc @@ -69,7 +69,16 @@ The following keys are defined: keepalive => pos_integer():: Time between pings in milliseconds. Defaults to 5000. -@todo We need to document Websocket options. +=== ws_opts() = map() + +Configuration for the Websocket protocol. + +The following keys are defined: + +compress => boolean():: + Whether to enable permessage-deflate compression. This does + not guarantee that compression will be used as it is the + server that ultimately decides. Defaults to false. == Messages |