aboutsummaryrefslogtreecommitdiffstats
path: root/manual/ranch_tcp.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_tcp.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_tcp.md')
-rw-r--r--manual/ranch_tcp.md8
1 files changed, 6 insertions, 2 deletions
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
-------------------