lib/libc/net/sockatmark.3

   1 .\"     $NetBSD: sockatmark.3,v 1.9 2008/04/30 13:10:50 martin 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 15, 2003
  31 .Dt SOCKATMARK 3
  32 .Os
  33 .Sh NAME
  34 .Nm sockatmark
  35 .Nd determine whether a socket is at the out-of-band mark
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/socket.h
  40 .Ft int
  41 .Fn sockatmark "int s"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm sockatmark
  45 function determines whether the socket referenced by the file descriptor
  46 .Fa s
  47 is at the out-of-band mark.
  48 .Sh RETURN VALUES
  49 If successful, the
  50 .Nm sockatmark
  51 function returns 1 to indicate that the socket is at an out-of-band mark;
  52 0 is returned if there is no out-of-band mark or the mark is preceded
  53 by in-band data.
  54 Otherwise, -1 is returned and
  55 .Va errno
  56 is set to indicate the error.
  57 .Sh ERRORS
  58 The
  59 .Nm sockatmark
  60 function will fail if:
  61 .Bl -tag -width Er
  62 .It Bq Er EBADF
  63 The argument
  64 .Fa s
  65 is not a valid file descriptor.
  66 .It Bq Er ENOTTY
  67 The file descriptor
  68 .Fa s
  69 does not refer to a socket.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr ioctl 2 ,
  73 .Xr recv 2 ,
  74 .Xr socket 2
  75 .Rs
  76 .%T "An Introductory 4.4BSD Interprocess Communication Tutorial"
  77 .%A Stuart Sechrest
  78 .Re
  79 .Pq see Pa /usr/share/doc/psd/20.ipctut
  80 .Rs
  81 .%T "Advanced 4.4BSD IPC Tutorial"
  82 .%A Samuel J. Leffler
  83 .%A Robert S. Fabry
  84 .%A William N. Joy
  85 .%A Phil Lapsley
  86 .%A Steve Miller
  87 .%A Chris Torek
  88 .Re
  89 .Pq see Pa /usr/share/doc/psd/21.ipc
  90 .Sh STANDARDS
  91 The
  92 .Nm sockatmark
  93 function conforms to
  94 .St -p1003.1-2001 .
  95 .Sh HISTORY
  96 The
  97 .Nm sockatmark
  98 function appeared in
  99 .St -p1003.1g-2000
 100 as a replacement for the
 101 .Dv SIOCATMARK
 102 .Xr ioctl 2
 103 interface.