tcp.7: Clarify header file details for SIOCINQ and SIOCOUTQ

Also note synonymous FIONREAD and TIOCOUTQ.

Reported-by: Jim Belton <jim.belton@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2010-09-10 05:35:56 +02:00
parent be0349596f
commit f73df7253d
1 changed files with 17 additions and 1 deletions

View File

@ -13,7 +13,7 @@
.\" be more or less up to date and complete as at Linux 2.6.27
.\" (other than the remaining FIXMEs in the page source below).
.\"
.TH TCP 7 2009-09-30 "Linux" "Linux Programmer's Manual"
.TH TCP 7 2010-09-10 "Linux" "Linux Programmer's Manual"
.SH NAME
tcp \- TCP protocol
.SH SYNOPSIS
@ -1013,6 +1013,14 @@ Returns the amount of queued unread data in the receive buffer.
The socket must not be in LISTEN state, otherwise an error
.RB ( EINVAL )
is returned.
.B SIOCINQ
is defined in
.IR <linux/sockios.h> .
Alternatively,
you can use the synonymous
.BR FIONREAD ,
defined in
.IR <sys/ioctl.h> .
.TP
.B SIOCATMARK
Returns true (i.e.,
@ -1054,6 +1062,14 @@ Returns the amount of unsent data in the socket send queue.
The socket must not be in LISTEN state, otherwise an error
.RB ( EINVAL )
is returned.
.B SIOCOUTQ
is defined in
.IR <linux/sockios.h> .
Alternatively,
you can use the synonymous
.BR TIOCOUTQ ,
defined in
.IR <sys/ioctl.h> .
.SS Error Handling
When a network error occurs, TCP tries to resend the packet.
If it doesn't succeed after some time, either