summaryrefslogtreecommitdiffstats
path: root/share/man/man4/tcp.4
diff options
context:
space:
mode:
authorbms <bms@FreeBSD.org>2007-01-22 14:16:47 +0000
committerbms <bms@FreeBSD.org>2007-01-22 14:16:47 +0000
commit3530b41545d66416a3c151e414ce5b1e7b3da0e6 (patch)
tree65669bd8f9b378dedf425d5e0e6b59372f19b505 /share/man/man4/tcp.4
parent710b7025d15c07e261cb11e550f6d7f9937135db (diff)
downloadFreeBSD-src-3530b41545d66416a3c151e414ce5b1e7b3da0e6.zip
FreeBSD-src-3530b41545d66416a3c151e414ce5b1e7b3da0e6.tar.gz
Document the existence of the TCP_INFO socket option.
Approved by: rwatson
Diffstat (limited to 'share/man/man4/tcp.4')
-rw-r--r--share/man/man4/tcp.425
1 files changed, 24 insertions, 1 deletions
diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4
index 29ec72b..ac8589a 100644
--- a/share/man/man4/tcp.4
+++ b/share/man/man4/tcp.4
@@ -32,7 +32,7 @@
.\" From: @(#)tcp.4 8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
-.Dd September 13, 2006
+.Dd January 22, 2007
.Dt TCP 4
.Os
.Sh NAME
@@ -117,6 +117,23 @@ supports a number of socket options which can be set with
and tested with
.Xr getsockopt 2 :
.Bl -tag -width ".Dv TCP_NODELAY"
+.It Dv TCP_INFO
+Information about a socket's underlying TCP session may be retrieved
+by passing the read-only option
+.Dv TCP_INFO
+to
+.Xr getsockopt 2 .
+It accepts a single argument: a pointer to an instance of
+.Vt "struct tcp_info" .
+.Pp
+This API is subject to change; consult the source to determine
+which fields are currently filled out by this option.
+.Fx
+specific additions include
+send window size,
+receive window size,
+and
+bandwidth-controlled window space.
.It Dv TCP_NODELAY
Under most circumstances,
.Tn TCP
@@ -540,3 +557,9 @@ protocol appeared in
The RFC 1323 extensions for window scaling and timestamps were added
in
.Bx 4.4 .
+The
+.Dv TCP_INFO
+option was introduced in
+.Tn Linux 2.6
+and is
+.Em subject to change .
OpenPOWER on IntegriCloud