original/man3/sigwait.3

   1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   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 .\"
  24 .TH SIGWAIT 3 2010-09-10 "Linux" "Linux Programmer's Manual"
  25 .SH NAME
  26 sigwait \- wait for a signal
  27 .SH SYNOPSIS
  28 .nf
  29 .B #include <signal.h>
  30
  31 .BI " int sigwait(const sigset_t *" set ", int *" sig );
  32 .fi
  33 .sp
  34 .in -4n
  35 Feature Test Macro Requirements for glibc (see
  36 .BR feature_test_macros (7)):
  37 .in
  38 .sp
  39 .ad l
  40 .BR sigwait ():
  41 _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE
  42 .ad b
  43 .SH DESCRIPTION
  44 The
  45 .BR sigwait ()
  46 function suspends execution of the calling thread until the
  47 delivery of one of the signals specified in the signal set
  48 .IR set .
  49 The function accepts the signal
  50 (removes it from the pending list of signals),
  51 and returns the signal number in
  52 .IR sig .
  53
  54 The operation of
  55 .BR sigwait ()
  56 is the same as
  57 .BR sigwaitinfo (2),
  58 except that:
  59 .IP * 2
  60 .BR sigwait ()
  61 only returns the signal number, rather than a
  62 .I siginfo_t
  63 structure describing the signal.
  64 .IP *
  65 The return values of the two functions are different.
  66 .SH RETURN VALUE
  67 On success,
  68 .BR sigwait ()
  69 returns 0.
  70 On error, it returns a positive error number (listed in ERRORS).
  71 .SH ERRORS
  72 .TP
  73 .B EINVAL
  74 .\" Does not occur for glibc.
  75 .I set
  76 contains an invalid signal number.
  77 .SH CONFORMING TO
  78 POSIX.1-2001.
  79 .SH NOTES
  80 .BR sigwait ()
  81 is implemented using
  82 .BR sigtimedwait (2).
  83 .SH EXAMPLES
  84 See
  85 .BR pthread_sigmask (3).
  86 .SH SEE ALSO
  87 .BR sigaction (2),
  88 .BR signalfd (2),
  89 .BR sigpending (2),
  90 .BR sigsuspend (2),
  91 .BR sigwaitinfo (2),
  92 .BR sigsetops (3),
  93 .BR signal (7)