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

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