From 3634e392a8634eb716210204999f3b4c481dd4b1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sat, 7 Dec 2013 15:03:05 +0100
Subject: Add transport options linger, send_timeout, send_timeout_close

---
 manual/ranch_ssl.md |  9 +++++++++
 manual/ranch_tcp.md | 11 ++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

(limited to 'manual')

diff --git a/manual/ranch_ssl.md b/manual/ranch_ssl.md
index d8bb140..4d473ba 100644
--- a/manual/ranch_ssl.md
+++ b/manual/ranch_ssl.md
@@ -17,6 +17,7 @@ Types
 	| {ip, inet:ip_address()}
 	| {key, Der::binary()}
 	| {keyfile, string()}
+	| {linger, {boolean(), non_neg_integer()}}
 	| {next_protocols_advertised, [binary()]}
 	| {nodelay, boolean()}
 	| {password, string()}
@@ -25,6 +26,8 @@ Types
 	| {reuse_session, fun()}
 	| {reuse_sessions, boolean()}
 	| {secure_renegotiate, boolean()}
+	| {send_timeout, timeout()}
+	| {send_timeout_close, boolean()}
 	| {verify, ssl:verify_type()}
 	| {verify_fun, {fun(), InitialUserState::term()}}]
 
@@ -64,6 +67,8 @@ The default value is given next to the option name.
    -  DER encoded user private key.
  -  keyfile
    -  Path to the PEM encoded private key file, if different than the certfile.
+ -  linger ({false, 0})
+   -  Whether to wait and how long to flush data sent before closing the socket.
  -  next_protocols_advertised
    -  List of protocols to send to the client if it supports the Next Protocol extension.
  -  nodelay (true)
@@ -78,6 +83,10 @@ The default value is given next to the option name.
    -  Whether to allow session reuse.
  -  secure_renegotiate (false)
    -  Whether to reject renegotiation attempts that do not conform to RFC5746.
+ -  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.
  -  verify (verify_none)
    -  Use `verify_peer` to request a certificate from the client.
  -  verify_fun
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.
 
-- 
cgit v1.2.3