sockatmark(3) [netbsd man page]

SOCKATMARK(3)						   BSD Library Functions Manual 					     SOCKATMARK(3)

NAME

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

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/socket.h>

     int
     sockatmark(int s);

DESCRIPTION

     The sockatmark function determines whether the socket referenced by the file descriptor s is at the out-of-band mark.

RETURN VALUES

     If successful, the sockatmark function returns 1 to indicate that the socket is at an out-of-band mark; 0 is returned if there is no out-of-
     band mark or the mark is preceded by in-band data.  Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

     The sockatmark function will fail if:

     [EBADF]		The argument s is not a valid file descriptor.

     [ENOTTY]		The file descriptor s does not refer to a socket.

SEE ALSO

     ioctl(2), recv(2), socket(2)

     Stuart Sechrest, An Introductory 4.4BSD Interprocess Communication Tutorial.  (see /usr/share/doc/psd/20.ipctut)

     Samuel J. Leffler, Robert S. Fabry, William N. Joy, Phil Lapsley, Steve Miller, and Chris Torek, Advanced 4.4BSD IPC Tutorial.  (see
     /usr/share/doc/psd/21.ipc)

STANDARDS

     The sockatmark function conforms to IEEE Std 1003.1-2001 (``POSIX.1'').

HISTORY

     The sockatmark function appeared in IEEE Std 1003.1g-2000 (``POSIX.1'') as a replacement for the SIOCATMARK ioctl(2) interface.

BSD
								   May 15, 2003 							       BSD

sockatmark(3)						     Library Functions Manual						     sockatmark(3)

NAME

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

LIBRARY

       Standard C Library: (libc.so, libc.a)

SYNOPSIS

       #include <sys/socket.h>

       int sockatmark (int socket);

STANDARDS

       The sockatmark function also supports POSIX.1g Draft 6.6.

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

PARAMETERS

       Specifies the file descriptor associated with a socket.

DESCRIPTION

       The sockatmark() function enables applications to determine which received data precede the out-of-band data and which data follow the out-
       of-band data.  The function uses the file descriptor for the socket to locate the data.	Applications typically use this  function  between
       receive operations.

       The sockatmark() function does not remove the mark from the stream.

RETURN VALUES

       Upon  successful completion, the sockatmark() function returns 1 if the protocol has marked the data stream and all data preceding the mark
       have been read, or 0 (zero) if there is no mark or if data precede the mark in the receive queue.

       If the sockatmark() function fails, a value of -1 is returned and errno is set to indicate the error.

ERRORS

       If the sockatmark() function fails, errno may be set to one of the following values: The socket parameter is not a valid  file  descriptor.
       The socket parameter does not specify a descriptor for a socket.

RELATED INFORMATION

       Functions: recv(2), recvmsg(2).

       Standards: standards(5).  delim off

																     sockatmark(3)