original/man3/sockatmark.3

   1 .\" Copyright (c) 2006, Michael Kerrisk (mtk.manpages@gmail.com)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH SOCKATMARK 3 2008-12-03 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 sockatmark \- determine whether socket is at out-of-band mark
  28 .SH SYNOPSIS
  29 .B #include <sys/socket.h>
  30 .sp
  31 .BI "int sockatmark(int " sockfd );
  32 .sp
  33 .in -4n
  34 Feature Test Macro Requirements for glibc (see
  35 .BR feature_test_macros (7)):
  36 .in
  37 .sp
  38 .ad l
  39 .BR sockatmark ():
  40 _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
  41 .ad b
  42 .SH DESCRIPTION
  43 .BR sockatmark ()
  44 returns a value indicating whether or not the socket referred
  45 to by the file descriptor
  46 .I sockfd
  47 is at the out-of-band mark.
  48 If the socket is at the mark, then 1 is returned;
  49 if the socket is not at the mark, 0 is returned.
  50 This function does not remove the out-of-band mark.
  51 .SH RETURN VALUE
  52 A successful call to
  53 .BR sockatmark ()
  54 returns 1 if the socket is at the out-of-band mark, or 0 if it is not.
  55 On error, \-1 is returned and
  56 .I errno
  57 is set to indicate the error.
  58 .SH ERRORS
  59 .TP
  60 .B EBADF
  61 .I sockfd
  62 is not a valid file descriptor.
  63 .TP
  64 .B EINVAL
  65 .\" POSIX.1 says ENOTTY for this case
  66 .I sockfd
  67 is not a file descriptor to which
  68 .BR sockatmark ()
  69 can be applied.
  70 .SH VERSIONS
  71 .BR sockatmark ()
  72 was added to glibc in version 2.2.4.
  73 .SH CONFORMING TO
  74 POSIX.1-2001.
  75 .SH NOTES
  76 If
  77 .BR sockatmark ()
  78 returns 1, then the out-of-band data can be read using the
  79 .B MSG_OOB
  80 flag of
  81 .BR recv (2).
  82
  83 Out-of-band data is supported only on some stream socket protocols.
  84
  85 .BR sockatmark ()
  86 can safely be called from a handler for the
  87 .B SIGURG
  88 signal.
  89
  90 .BR sockatmark ()
  91 is implemented using the
  92 .B SIOCATMARK
  93 .BR ioctl (2)
  94 operation.
  95 .SH BUGS
  96 Prior to glibc 2.4,
  97 .BR sockatmark ()
  98 did not work.
  99 .SH EXAMPLE
 100 The following code can be used after receipt of a
 101 .B SIGURG
 102 signal to read (and discard) all data up to the mark,
 103 and then read the byte of data at the mark:
 104 .nf
 105
 106     char buf[BUF_LEN];
 107     char oobdata;
 108     int atmark, s;
 109
 110     for (;;) {
 111         atmark = sockatmark(sockfd);
 112         if (atmark == \-1) {
 113             perror("sockatmark");
 114             break;
 115         }
 116
 117         if (atmark)
 118             break;
 119
 120         s = read(sockfd, buf, BUF_LEN) <= 0);
 121         if (s == \-1)
 122             perror("read");
 123         if (s <= 0)
 124             break;
 125     }
 126
 127     if (atmark == 1) {
 128         if (recv(sockfd, &oobdata, 1, MSG_OOB) == \-1) {
 129             perror("recv");
 130             ...
 131         }
 132     }
 133 .fi
 134 .SH SEE ALSO
 135 .BR fcntl (2),
 136 .BR recv (2),
 137 .BR send (2),
 138 .BR tcp (7)