aboutsummaryrefslogtreecommitdiffstats
path: root/manual/ranch.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-08-17 18:18:07 +0200
committerLoïc Hoguin <[email protected]>2015-08-17 18:51:55 +0200
commitd440a2c1d26e4f0770a66279de151806b1ad5ac2 (patch)
tree774bbcf04a147e10284454a05aa8daecf04d3ec2 /manual/ranch.md
parentf5f480c5750b76b662430b62ef85ebceea5aadc6 (diff)
downloadranch-d440a2c1d26e4f0770a66279de151806b1ad5ac2.tar.gz
ranch-d440a2c1d26e4f0770a66279de151806b1ad5ac2.tar.bz2
ranch-d440a2c1d26e4f0770a66279de151806b1ad5ac2.zip
Don't pass Ranch-specific options down to transports
Should fix Dialyzer issues. The options are now also documented in the Ranch module, and there's new ranch:opt(), ranch_tcp:opt() and ranch_ssl:opt() for use in third party code.
Diffstat (limited to 'manual/ranch.md')
-rw-r--r--manual/ranch.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/manual/ranch.md b/manual/ranch.md
index cf4ebe5..52c792e 100644
--- a/manual/ranch.md
+++ b/manual/ranch.md
@@ -17,6 +17,17 @@ Types
> also be removed from this count explicitly by the user
> code.
+### opt() = {ack_timeout, timeout()}
+ | {connection_type, worker | supervisor}
+ | {max_connections, max_conns()}
+ | {shutdown, timeout() | brutal_kill}
+ | {socket, any()}
+
+> Ranch-specific transport options.
+>
+> These options are not passed on to the transports.
+> They are used by Ranch while setting up the listeners.
+
### ref() = any()
> Unique name used to refer to a listener.