2001-10-23 02:29:39 +04:00
|
|
|
.\" $NetBSD: sockatmark.3,v 1.2 2001/10/22 22:29:39 kleink Exp $
|
2001-10-22 21:53:43 +04:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
|
|
|
.\" by Klaus Klein.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
|
.\" This product includes software developed by the NetBSD
|
|
|
|
|
.\" Foundation, Inc. and its contributors.
|
|
|
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
|
|
|
.\" contributors may be used to endorse or promote products derived
|
|
|
|
|
.\" from this software without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
|
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
|
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
|
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
|
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
.\" CONTRACT, STRICT 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 SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.Dd October 22, 2001
|
|
|
|
|
.Dt SOCKATMARK 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
.Nd determine whether a socket is at the out-of-band mark
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Fd #include <sys/socket.h>
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn sockatmark "int s"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
function determines whether the socket referenced by the file descriptor
|
|
|
|
|
.Fa s
|
|
|
|
|
is at the out-of-band mark.
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
If successful, the
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
function returns 1 to indicate that the socket is at an out-of-band mark;
|
|
|
|
|
0 is returned if there is no out-of-band mark or the mark is preceeded
|
|
|
|
|
by in-band data.
|
|
|
|
|
Otherwise, -1 is returned and
|
|
|
|
|
.Va errno
|
|
|
|
|
is set to indicate the error.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
The
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
function will fail if:
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EBADF
|
|
|
|
|
The argument
|
|
|
|
|
.Fa s
|
|
|
|
|
is not a valid file descriptor.
|
|
|
|
|
.It Bq Er ENOTTY
|
|
|
|
|
The file desciptor
|
|
|
|
|
.Fa s
|
|
|
|
|
does not refer to a socket.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr ioctl 2 ,
|
2001-10-23 02:29:39 +04:00
|
|
|
.Xr recv 2 ,
|
2001-10-22 21:53:43 +04:00
|
|
|
.Xr socket 2
|
|
|
|
|
.Rs
|
|
|
|
|
.%T "BSD Interprocess Communication Tutorial"
|
|
|
|
|
.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1"
|
|
|
|
|
.Re
|
|
|
|
|
.Rs
|
|
|
|
|
.%T "Advanced 4.4BSD IPC Tutorial"
|
|
|
|
|
.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1"
|
|
|
|
|
.Re
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
function appeared in
|
|
|
|
|
.St -p1003.1g-2000
|
|
|
|
|
as a replacement for the
|
|
|
|
|
.Dv SIOCATMARK
|
|
|
|
|
.Xr ioctl 2
|
|
|
|
|
interface.
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
The
|
|
|
|
|
.Nm sockatmark
|
|
|
|
|
function conforms to
|
|
|
|
|
.St -p1003.1g-2000 .
|
|
|
|
|
.\" XXX add POSIX-1:200x reference when finalized
|
