usr/src/man/man3xnet/sockatmark.3xnet

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH SOCKATMARK 3XNET "Oct 1, 2003"
  47 .SH NAME
  48 sockatmark \- determine whether a socket is at the out-of-band mark
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  53 #include <sys/socket.h>
  54
  55 \fBint\fR \fBsockatmark\fR(\fBint\fR \fIs\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBsockatmark()\fR function determines whether the socket specified by the
  62 descriptor \fIs\fR is at the out-of-band data mark. If the protocol for the
  63 socket supports out-of-band data by marking the stream with an out-of-band data
  64 mark, the \fBsockatmark()\fR function returns 1 when all data preceding the
  65 mark has been read and the out-of-band data mark is the first element in the
  66 receive queue. The \fBsockatmark()\fR function does not remove the mark from
  67 the stream.
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 Upon successful completion, the \fBsockatmark()\fR function returns a value
  72 indicating whether the socket is at an out-of-band data mark. If the protocol
  73 has marked the data stream and all data preceding the mark has been read, the
  74 return value is 1. If there is no mark, or if data precedes the mark in the
  75 receive queue, the \fBsockatmark()\fR function returns 0. Otherwise, it returns
  76 \(mi1 and sets \fBerrno\fR to indicate the error.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 The \fBsockatmark()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEBADF\fR\fR
  85 .ad
  86 .RS 10n
  87 The \fIs\fR argument is not a valid file descriptor.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBENOTTY\fR\fR
  94 .ad
  95 .RS 10n
  96 The \fIs\fR argument does not specify a descriptor for a socket.
  97 .RE
  98
  99 .SH USAGE
 100 .sp
 101 .LP
 102 The use of this function between receive operations allows an application to
 103 determine which received data precedes the out-of-band data and which follows
 104 the out-of-band data.
 105 .sp
 106 .LP
 107 There is an inherent race condition in the use of this function. On an empty
 108 receive queue, the current read of the location might well be at the "mark",
 109 but the system has no way of knowing that the next data segment that will
 110 arrive from the network will carry the mark, and \fBsockatmark()\fR will return
 111 false, and the next read operation will silently consume the mark.
 112 .sp
 113 .LP
 114 Hence, this function can only be used reliably when the application already
 115 knows that the out-of-band data has been seen by the system or that it is known
 116 that there is data waiting to be read at the socket, either by \fBSIGURG\fR or
 117 \fBselect\fR(3C).
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Standard
 132 _
 133 MT-Level        Safe
 134 .TE
 135
 136 .SH SEE ALSO
 137 .sp
 138 .LP
 139 \fBrecv\fR(3XNET), \fBrecvmsg\fR(3XNET), \fBselect\fR(3C), \fBattributes\fR(5),
 140 \fBstandards\fR(5)