Differential D3687 Diff 24154 lib/libc/sys/getsockopt.2

Changeset View

Standalone View

lib/libc/sys/getsockopt.2

	Show All 22 Lines
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" @(#)getsockopt.2 8.4 (Berkeley) 5/2/95			.\" @(#)getsockopt.2 8.4 (Berkeley) 5/2/95
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd April 5, 2013			.Dd January 18, 2017
	.Dt GETSOCKOPT 2			.Dt GETSOCKOPT 2
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm getsockopt ,			.Nm getsockopt ,
	.Nm setsockopt			.Nm setsockopt
	.Nd get and set options on sockets			.Nd get and set options on sockets
	.Sh LIBRARY			.Sh LIBRARY
	.Lb libc			.Lb libc
	▲ Show 20 Lines • Show All 143 Lines • ▼ Show 20 Lines
	.Bl -column SO_LISTENINCQLEN -offset indent			.Bl -column SO_LISTENINCQLEN -offset indent
	.It Dv SO_LABEL Ta "get MAC label of the socket (get only)"			.It Dv SO_LABEL Ta "get MAC label of the socket (get only)"
	.It Dv SO_PEERLABEL Ta "get socket's peer's MAC label (get only)"			.It Dv SO_PEERLABEL Ta "get socket's peer's MAC label (get only)"
	.It Dv SO_LISTENQLIMIT Ta "get backlog limit of the socket (get only)"			.It Dv SO_LISTENQLIMIT Ta "get backlog limit of the socket (get only)"
	.It Dv SO_LISTENQLEN Ta "get complete queue length of the socket (get only)"			.It Dv SO_LISTENQLEN Ta "get complete queue length of the socket (get only)"
	.It Dv SO_LISTENINCQLEN Ta "get incomplete queue length of the socket (get only)"			.It Dv SO_LISTENINCQLEN Ta "get incomplete queue length of the socket (get only)"
	.It Dv SO_USER_COOKIE Ta "set the 'so_user_cookie' value for the socket (uint32_t, set only)"			.It Dv SO_USER_COOKIE Ta "set the 'so_user_cookie' value for the socket (uint32_t, set only)"
	.It Dv SO_TS_CLOCK Ta "set specific format of timestamp returned by SO_TIMESTAMP"			.It Dv SO_TS_CLOCK Ta "set specific format of timestamp returned by SO_TIMESTAMP"
				.It Dv SO_MAX_PACING_RATE "set the maximum transmit rate in bytes per second for the socket"
	.El			.El
	.Pp			.Pp
	.Dv SO_DEBUG			.Dv SO_DEBUG
	enables debugging in the underlying protocol modules.			enables debugging in the underlying protocol modules.
	.Pp			.Pp
	.Dv SO_REUSEADDR			.Dv SO_REUSEADDR
	indicates that the rules used in validating addresses supplied			indicates that the rules used in validating addresses supplied
	in a			in a
	▲ Show 20 Lines • Show All 311 Lines • ▼ Show 20 Lines
	for more information.			for more information.
	.Dv SO_LISTENQLIMIT			.Dv SO_LISTENQLIMIT
	returns the maximal number of queued connections, as set by			returns the maximal number of queued connections, as set by
	.Xr listen 2 .			.Xr listen 2 .
	.Dv SO_LISTENQLEN			.Dv SO_LISTENQLEN
	returns the number of unaccepted complete connections.			returns the number of unaccepted complete connections.
	.Dv SO_LISTENINCQLEN			.Dv SO_LISTENINCQLEN
	returns the number of unaccepted incomplete connections.			returns the number of unaccepted incomplete connections.
				.Pp
				.Dv SO_MAX_PACING_RATE
				instruct the socket and underlying network adapter layers to limit the
				transfer rate to the given unsigned 32-bit value in bytes per second.
				wblockUnsubmitted Done Inline Actions This "should be" is kind of ambiguous. Maybe it is meant to imply that the limit can be set but might not be a hard limit? Otherwise, how about: instruct the socket and underlying network adapter layers to limit the transfer rate to the given unsigned 32-bit value in bytes per second. wblock: This "should be" is kind of ambiguous. Maybe it is meant to imply that the limit can be set…
	.Sh RETURN VALUES			.Sh RETURN VALUES
	.Rv -std			.Rv -std
	.Sh ERRORS			.Sh ERRORS
	The call succeeds unless:			The call succeeds unless:
	.Bl -tag -width Er			.Bl -tag -width Er
	.It Bq Er EBADF			.It Bq Er EBADF
	The argument			The argument
	.Fa s			.Fa s
	▲ Show 20 Lines • Show All 46 Lines • Show Last 20 Lines