original/man2/sigwaitinfo.2

   1 .\" Copyright (c) 2002 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .TH SIGWAITINFO 2 2008-10-04 "Linux" "Linux Programmer's Manual"
  24 .SH NAME
  25 sigwaitinfo, sigtimedwait \- synchronously wait for queued signals
  26 .SH SYNOPSIS
  27 .nf
  28 .B #include <signal.h>
  29 .sp
  30 .BI "int sigwaitinfo(const sigset_t *" set ", siginfo_t *" info ");"
  31 .sp
  32 .BI "int sigtimedwait(const sigset_t *" set ", siginfo_t *" info ", "
  33 .BI "                 const struct timespec *" timeout ");"
  34 .fi
  35 .sp
  36 .in -4n
  37 Feature Test Macro Requirements for glibc (see
  38 .BR feature_test_macros (7)):
  39 .in
  40 .sp
  41 .BR sigwaitinfo (),
  42 .BR sigtimedwait ():
  43 _POSIX_C_SOURCE\ >=\ 199309L
  44 .SH DESCRIPTION
  45 .BR sigwaitinfo ()
  46 suspends execution of the calling thread until one of the signals in
  47 .I set
  48 is delivered.
  49 (If one of the signals in
  50 .I set
  51 is already pending for the calling thread,
  52 .BR sigwaitinfo ()
  53 will return immediately with information about that signal.)
  54
  55 .BR sigwaitinfo ()
  56 removes the delivered signal from the set of pending
  57 signals and returns the signal number as its function result.
  58 If the
  59 .I info
  60 argument is not NULL,
  61 then it returns a structure of type
  62 .I siginfo_t
  63 (see
  64 .BR sigaction (2))
  65 containing information about the signal.
  66 .PP
  67 Signals returned via
  68 .BR sigwaitinfo ()
  69 are delivered in the usual order; see
  70 .BR signal (7)
  71 for further details.
  72 .PP
  73 .BR sigtimedwait ()
  74 operates in exactly the same way as
  75 .BR sigwaitinfo ()
  76 except that it has an additional argument,
  77 .IR timeout ,
  78 which enables an upper bound to be placed on the time for which
  79 the thread is suspended.
  80 This argument is of the following type:
  81 .sp
  82 .in +4n
  83 .nf
  84 struct timespec {
  85     long    tv_sec;         /* seconds */
  86     long    tv_nsec;        /* nanoseconds */
  87 }
  88 .fi
  89 .in
  90 .sp
  91 If both fields of this structure are specified as 0, a poll is performed:
  92 .BR sigtimedwait ()
  93 returns immediately, either with information about a signal that
  94 was pending for the caller, or with an error
  95 if none of the signals in
  96 .I set
  97 was pending.
  98 .SH "RETURN VALUE"
  99 On success, both
 100 .BR sigwaitinfo ()
 101 and
 102 .BR sigtimedwait ()
 103 return a signal number (i.e., a value greater than zero).
 104 On failure both calls return \-1, with
 105 .I errno
 106 set to indicate the error.
 107 .SH ERRORS
 108 .TP
 109 .B EAGAIN
 110 No signal in
 111 .I set
 112 was delivered within the
 113 .I timeout
 114 period specified to
 115 .BR sigtimedwait ().
 116 .TP
 117 .B EINTR
 118 The wait was interrupted by a signal handler; see
 119 .BR signal (7).
 120 (This handler was for a signal other than one of those in
 121 .IR set .)
 122 .TP
 123 .B EINVAL
 124 .I timeout
 125 was invalid.
 126 .SH "CONFORMING TO"
 127 POSIX.1-2001.
 128 .SH NOTES
 129 In normal usage, the calling program blocks the signals in
 130 .I set
 131 via a prior call to
 132 .BR sigprocmask (2)
 133 (so that the default disposition for these signals does not occur if they
 134 are delivered between successive calls to
 135 .BR sigwaitinfo ()
 136 or
 137 .BR sigtimedwait ())
 138 and does not establish handlers for these signals.
 139 In a multithreaded program,
 140 the signal should be blocked in all threads to prevent
 141 the signal being delivered to a thread other than the one calling
 142 .BR sigwaitinfo ()
 143 or
 144 .BR sigtimedwait ()).
 145
 146 The set of signals that is pending for a given thread is the
 147 union of the set of signals that is pending specifically for that thread
 148 and the set of signals that is pending for the process as a whole (see
 149 .BR signal (7)).
 150
 151 If multiple threads of a process are blocked
 152 waiting for the same signal(s) in
 153 .BR sigwaitinfo ()
 154 or
 155 .BR sigtimedwait (),
 156 then exactly one of the threads will actually receive the
 157 signal if it is delivered to the process as a whole;
 158 which of the threads receives the signal is indeterminate.
 159
 160 POSIX leaves the meaning of a NULL value for the
 161 .I timeout
 162 argument of
 163 .BR sigtimedwait ()
 164 unspecified, permitting the possibility that this has the same meaning
 165 as a call to
 166 .BR sigwaitinfo (),
 167 and indeed this is what is done on Linux.
 168
 169 On Linux,
 170 .BR sigwaitinfo ()
 171 is a library function implemented on top of
 172 .BR sigtimedwait ().
 173 .SH "SEE ALSO"
 174 .BR kill (2),
 175 .BR sigaction (2),
 176 .BR signal (2),
 177 .BR signalfd (2),
 178 .BR sigpending (2),
 179 .BR sigprocmask (2),
 180 .BR sigqueue (3),
 181 .BR sigsetops (3),
 182 .BR sigwait (3),
 183 .BR signal (7),
 184 .BR time (7)