diff options
| author | Micael Karlberg <[email protected]> | 2019-01-10 11:15:03 +0100 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2019-01-10 11:15:03 +0100 |
| commit | b215d0d2e33cf7515f63c3d70d0ef5fc77b582ee (patch) | |
| tree | 9c38106e8471acd1735438e854b397e0928d7ed2 /lib/kernel | |
| parent | cb9993b93175edca260d0a470816a300c1320f6c (diff) | |
| parent | 45a64afabbe7b413a377a1c0cbb8786842a8357e (diff) | |
| download | otp-b215d0d2e33cf7515f63c3d70d0ef5fc77b582ee.tar.gz otp-b215d0d2e33cf7515f63c3d70d0ef5fc77b582ee.tar.bz2 otp-b215d0d2e33cf7515f63c3d70d0ef5fc77b582ee.zip | |
Merge branch 'bmk/20181220/improve_linger_doc/OTP-15491'
Diffstat (limited to 'lib/kernel')
| -rw-r--r-- | lib/kernel/doc/src/inet.xml | 33 |
1 files 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> <p>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.</p> + in the <c>close/1</c> socket call. </p> + <p>The first component is if linger is enabled, the second component + is the flushing time-out, in seconds. There are 3 alternatives:</p> + <taglist> + <tag><c>{false, _}</c></tag> + <item> + <p>close/1 or shutdown/2 returns immediately, + not waiting for data to be flushed, with closing + happening in the background.</p> + </item> + <tag><c>{true, 0}</c></tag> + <item> + <p>Aborts the connection when it is closed. + Discards any data still remaining in the send buffers + and sends RST to the peer.</p> + <p>This avoids TCP's TIME_WAIT state, but leaves open + the possibility that another "incarnation" of this connection + being created.</p> + </item> + <tag><c>{true, Time} when Time > 0</c></tag> + <item> + <p>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.</p> + </item> + </taglist> </item> <tag><c>{low_msgq_watermark, Size}</c></tag> <item> |