From c46991067a53c81316a69c1df7c7dc590f3ca308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 10 Apr 2015 13:16:34 +0300 Subject: Document Websocket options in the manual --- doc/src/manual/gun.asciidoc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'doc') 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 -- cgit v1.2.3