1.\" $NetBSD: sockatmark.3,v 1.4 2002/02/07 07:00:22 ross Exp $ 2.\" 3.\" Copyright (c) 2001 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Klaus Klein. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd October 22, 2001 38.Dt SOCKATMARK 3 39.Os 40.Sh NAME 41.Nm sockatmark 42.Nd determine whether a socket is at the out-of-band mark 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.Fd #include \*[Lt]sys/socket.h\*[Gt] 47.Ft int 48.Fn sockatmark "int s" 49.Sh DESCRIPTION 50The 51.Nm sockatmark 52function determines whether the socket referenced by the file descriptor 53.Fa s 54is at the out-of-band mark. 55.Sh RETURN VALUES 56If successful, the 57.Nm sockatmark 58function returns 1 to indicate that the socket is at an out-of-band mark; 590 is returned if there is no out-of-band mark or the mark is preceeded 60by in-band data. 61Otherwise, -1 is returned and 62.Va errno 63is set to indicate the error. 64.Sh ERRORS 65The 66.Nm sockatmark 67function will fail if: 68.Bl -tag -width Er 69.It Bq Er EBADF 70The argument 71.Fa s 72is not a valid file descriptor. 73.It Bq Er ENOTTY 74The file desciptor 75.Fa s 76does not refer to a socket. 77.El 78.Sh SEE ALSO 79.Xr ioctl 2 , 80.Xr recv 2 , 81.Xr socket 2 82.Rs 83.%T "BSD Interprocess Communication Tutorial" 84.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1" 85.Re 86.Rs 87.%T "Advanced 4.4BSD IPC Tutorial" 88.%O "reprinted in UNIX Programmer's Supplementary Documents Volume 1" 89.Re 90.Sh STANDARDS 91The 92.Nm sockatmark 93function conforms to 94.St -p1003.1g-2000 . 95.\" XXX add POSIX-1:200x reference when finalized 96.Sh HISTORY 97The 98.Nm sockatmark 99function appeared in 100.St -p1003.1g-2000 101as a replacement for the 102.Dv SIOCATMARK 103.Xr ioctl 2 104interface. 105