File 0523-kernel-tcp-Improve-the-linger-option-docum... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0523-kernel-tcp-Improve-the-linger-option-documentation.patch of Package erlang (Revision 7787e944ee03c956fdcc5c0c5c91f052)

Currently displaying revision 7787e944ee03c956fdcc5c0c5c91f052 , Show latest

From 45a64afabbe7b413a377a1c0cbb8786842a8357e Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Thu, 20 Dec 2018 12:51:21 +0100
Subject: [PATCH] [kernel|tcp] Improve the linger option documentation

The documentation for the tcp linger option was somewhat
obtuse. This has been improved upon by listing and describing
the three basic alternatives.

OTP-15491
---
 lib/kernel/doc/src/inet.xml | 33 +++++++++++++++++++++++++++------
 1 file changed, 27 insertions(+), 6 deletions(-)

diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index 104c698591..709ba8e8fd 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -1007,13 +1007,34 @@ get_tcpi_sacked(Sock) ->
 <marker id="option-linger"></marker>
 </item>
 <tag><c>{linger, {true|false, Seconds}}</c></tag>
- <item>
+	 <item>
 Determines the time-out, in seconds, for flushing unsent data
- in the <c>close/1</c> socket call. If the first component of
- the value tuple is <c>false</c>, the second is ignored. This
- means that <c>close/1</c> returns immediately, not waiting
- for data to be flushed. Otherwise, the second component is
- the flushing time-out, in seconds.
+ in the <c>close/1</c> socket call. 
+	 The first component is if linger is enabled, the second component
+	 is the flushing time-out, in seconds. There are 3 alternatives:
+	 <taglist>
+	 <tag><c>{false, _}</c></tag>
+	 <item>
+		close/1 or shutdown/2 returns immediately,
+		not waiting for data to be flushed, with closing
+		happening in the background.
+	 </item>
+	 <tag><c>{true, 0}</c></tag>
+	 <item>
+		Aborts the connection when it is closed.
+		Discards any data still remaining in the send buffers
+		and sends RST to the peer.
+		This avoids TCP's TIME_WAIT state, but leaves open
+		the possibility that another "incarnation" of this connection
+		being created.
+	 </item>
+	 <tag><c>{true, Time} when Time > 0</c></tag>
+	 <item>
+		close/1 or shutdown/2 will not return until
+		all queued messages for the socket have been successfully
+		sent or the linger timeout (Time) has been reached.
+	 </item>
+	 </taglist>
 </item>
 <tag><c>{low_msgq_watermark, Size}</c></tag>
 <item>
-- 
2.16.4

Places

File 0523-kernel-tcp-Improve-the-linger-option-documentation.patch of Package erlang (Revision 7787e944ee03c956fdcc5c0c5c91f052)

Places