aboutsummaryrefslogtreecommitdiffstats
path: root/manual/ranch_tcp.md
diff options
context:
space:
mode:
Diffstat (limited to 'manual/ranch_tcp.md')
-rw-r--r--manual/ranch_tcp.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/manual/ranch_tcp.md b/manual/ranch_tcp.md
index d0f6054..0e27e11 100644
--- a/manual/ranch_tcp.md
+++ b/manual/ranch_tcp.md
@@ -13,9 +13,12 @@ Types
### opts() = [{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()}]
+ | {raw, non_neg_integer(), non_neg_integer(), non_neg_integer() | binary()}
+ | {send_timeout, timeout()}
+ | {send_timeout_close, boolean()}]
> Listen options.
>
@@ -34,10 +37,16 @@ The default value is given next to the option name.
- Max length of the queue of pending connections.
- ip
- Interface to listen on. Listen on all interfaces by default.
+ - linger ({false, 0})
+ - Whether to wait and how long to flush data sent before closing the socket.
- nodelay (true)
- Whether to enable TCP_NODELAY.
- port (0)
- TCP port number to listen on. 0 means a random port will be used.
+ - send_timeout (30000)
+ - How long the send call may wait for confirmation before returning.
+ - send_timeout_close (true)
+ - Whether to close the socket when the confirmation wasn't received.
The `raw` option is unsupported.