sockatmark(3xnet) [sunos man page]

sockatmark(3XNET)				   X/Open Networking Services Library Functions 				 sockatmark(3XNET)

NAME

       sockatmark - determine whether a socket is at the out-of-band mark

SYNOPSIS

       cc [ flag ... ] file ... -lxnet [ library ... ]
       #include <sys/socket.h>

       int sockatmark(int s);

DESCRIPTION

       The  sockatmark() function determines whether the socket specified by the descriptor s is at the out-of-band data mark. If the protocol for
       the socket supports out-of-band data by marking the stream with an out-of-band data mark, the sockatmark() function returns 1 when all data
       preceding  the  mark  has been read and the out-of-band data mark is the first element in the receive queue. The sockatmark() function does
       not remove the mark from the stream.

RETURN VALUES

       Upon successful completion, the sockatmark() function returns a value indicating whether the socket is at an out-of-band data mark. If  the
       protocol  has  marked the data stream and all data preceding the mark has been read, the return value is 1. If there is no mark, or if data
       precedes the mark in the receive queue, the sockatmark() function returns 0. Otherwise, it returns -1 and sets errno to indicate the error.

ERRORS

       The sockatmark() function will fail if:

       EBADF	       The s argument is not a valid file descriptor.

       ENOTTY	       The s argument does not specify a descriptor for a socket.

USAGE

       The use of this function between receive operations allows an application to determine which received data precedes  the  out-of-band  data
       and which follows the out-of-band data.

       There  is an inherent race condition in the use of this function. On an empty receive queue, the current read of the location might well be
       at the "mark", but the system has no way of knowing that the next data segment that will arrive from the network will carry the	mark,  and
       sockatmark() will return false, and the next read operation will silently consume the mark.

       Hence,  this function can only be used reliably when the application already knows that the out-of-band data has been seen by the system or
       that it is known that there is data waiting to be read at the socket, either by SIGURG or select(3C).

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       recv(3XNET), recvmsg(3XNET), select(3C), attributes(5), standards(5)

SunOS 5.10							    1 Oct 2003							 sockatmark(3XNET)

Check Out this Related Man Page

SOCKATMARK(3)						     Linux Programmer's Manual						     SOCKATMARK(3)

NAME

       sockatmark - determine whether socket is at out-of-band mark

SYNOPSIS

       #include <sys/socket.h>

       int sockatmark(int sockfd);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

       sockatmark(): _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600

DESCRIPTION

       sockatmark() returns a value indicating whether or not the socket referred to by the file descriptor sockfd is at the out-of-band mark.	If
       the socket is at the mark, then 1 is returned; if the socket is not at the mark, 0 is returned.	This function does not remove the  out-of-
       band mark.

RETURN VALUE

       A  successful  call  to	sockatmark()  returns 1 if the socket is at the out-of-band mark, or 0 if it is not.  On error, -1 is returned and
       errno is set to indicate the error.

ERRORS

       EBADF  sockfd is not a valid file descriptor.

       EINVAL sockfd is not a file descriptor to which sockatmark() can be applied.

VERSIONS

       sockatmark() was added to glibc in version 2.2.4.

CONFORMING TO

       POSIX.1-2001.

NOTES

       If sockatmark() returns 1, then the out-of-band data can be read using the MSG_OOB flag of recv(2).

       Out-of-band data is only supported on some stream socket protocols.

       sockatmark() can safely be called from a handler for the SIGURG signal.

       sockatmark() is implemented using the SIOCATMARK ioctl(2) operation.

BUGS

       Prior to glibc 2.4, sockatmark() did not work.

EXAMPLE

       The following code can be used after receipt of a SIGURG signal to read (and discard) all data up to the mark, and then read  the  byte	of
       data at the mark:

	   char buf[BUF_LEN];
	   char oobdata;
	   int atmark, s;

	   for (;;) {
	       atmark = sockatmark(sockfd);
	       if (atmark == -1) {
		   perror("sockatmark");
		   break;
	       }

	       if (atmark)
		   break;

	       s = read(sockfd, buf, BUF_LEN) <= 0);
	       if (s == -1)
		   perror("read");
	       if (s <= 0)
		   break;
	   }

	   if (atmark == 1) {
	       if (recv(sockfd, &oobdata, 1, MSG_OOB) == -1) {
		   perror("recv");
		   ...
	       }
	   }

SEE ALSO

       fcntl(2), recv(2), send(2), tcp(7)

COLOPHON

       This  page is part of release 3.44 of the Linux man-pages project.  A description of the project, and information about reporting bugs, can
       be found at http://www.kernel.org/doc/man-pages/.

Linux								    2008-12-03							     SOCKATMARK(3)

Linux and UNIX Man Pages

sockatmark(3xnet) [sunos man page]

Check Out this Related Man Page