Index for Section 3

Alphabetical listing for S

Bottom of page

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
  socket
      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:

  [EBADF]   The socket parameter is not a valid file descriptor.

  [ENOTTY]  The socket parameter does not specify a descriptor for a socket.

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

  Standards: standards(5).

Index for Section 3

Alphabetical listing for S

Top of page