aboutsummaryrefslogtreecommitdiffstats
path: root/manual
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
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')
-rw-r--r--manual/ranch.md11
-rw-r--r--manual/ranch_ssl.md8
-rw-r--r--manual/ranch_tcp.md8
3 files changed, 23 insertions, 4 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.
diff --git a/manual/ranch_ssl.md b/manual/ranch_ssl.md
index af271a5..e8a41ec 100644
--- a/manual/ranch_ssl.md
+++ b/manual/ranch_ssl.md
@@ -6,7 +6,7 @@ The `ranch_ssl` module implements an SSL Ranch transport.
Types
-----
-### opts() = [{backlog, non_neg_integer()}
+### opt() = {backlog, non_neg_integer()}
| {cacertfile, string()}
| {cacerts, [Der::binary()]}
| {cert, Der::binary()}
@@ -32,7 +32,7 @@ Types
| {send_timeout_close, boolean()}
| {verify, ssl:verify_type()}
| {verify_fun, {fun(), InitialUserState::term()}},
- | {versions, [atom()]}].
+ | {versions, [atom()]}
> Listen options.
>
@@ -40,6 +40,10 @@ Types
> be set on the socket, but only the options that should be
> set independently of protocol implementation.
+### opts() = [opt()]
+
+> Listen options.
+
Option descriptions
-------------------
diff --git a/manual/ranch_tcp.md b/manual/ranch_tcp.md
index 0e27e11..2967392 100644
--- a/manual/ranch_tcp.md
+++ b/manual/ranch_tcp.md
@@ -11,14 +11,14 @@ the threads stuck indefinitely.
Types
-----
-### opts() = [{backlog, non_neg_integer()}
+### opt() = {backlog, non_neg_integer()}
| {ip, inet:ip_address()}
| {linger, {boolean(), non_neg_integer()}}
| {nodelay, boolean()}
| {port, inet:port_number()}
| {raw, non_neg_integer(), non_neg_integer(), non_neg_integer() | binary()}
| {send_timeout, timeout()}
- | {send_timeout_close, boolean()}]
+ | {send_timeout_close, boolean()}
> Listen options.
>
@@ -26,6 +26,10 @@ Types
> be set on the socket, but only the options that should be
> set independently of protocol implementation.
+### opts() = [opt()]
+
+> Listen options.
+
Option descriptions
-------------------