original/man3/sigwait.3

   1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH SIGWAIT 3 2013-12-16 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 sigwait \- wait for a signal
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <signal.h>
  32
  33 .BI " int sigwait(const sigset_t *" set ", int *" sig );
  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 .ad l
  42 .BR sigwait ():
  43 _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE
  44 .ad b
  45 .SH DESCRIPTION
  46 The
  47 .BR sigwait ()
  48 function suspends execution of the calling thread until
  49 one of the signals specified in the signal set
  50 .IR set
  51 becomes pending.
  52 The function accepts the signal
  53 (removes it from the pending list of signals),
  54 and returns the signal number in
  55 .IR sig .
  56
  57 The operation of
  58 .BR sigwait ()
  59 is the same as
  60 .BR sigwaitinfo (2),
  61 except that:
  62 .IP * 2
  63 .BR sigwait ()
  64 returns only the signal number, rather than a
  65 .I siginfo_t
  66 structure describing the signal.
  67 .IP *
  68 The return values of the two functions are different.
  69 .SH RETURN VALUE
  70 On success,
  71 .BR sigwait ()
  72 returns 0.
  73 On error, it returns a positive error number (listed in ERRORS).
  74 .SH ERRORS
  75 .TP
  76 .B EINVAL
  77 .\" Does not occur for glibc.
  78 .I set
  79 contains an invalid signal number.
  80 .SH ATTRIBUTES
  81 .SS Multithreading (see pthreads(7))
  82 The
  83 .BR sigwait ()
  84 function is thread-safe.
  85 .SH CONFORMING TO
  86 POSIX.1-2001.
  87 .SH NOTES
  88 .BR sigwait ()
  89 is implemented using
  90 .BR sigtimedwait (2).
  91 .SH EXAMPLE
  92 See
  93 .BR pthread_sigmask (3).
  94 .SH SEE ALSO
  95 .BR sigaction (2),
  96 .BR signalfd (2),
  97 .BR sigpending (2),
  98 .BR sigsuspend (2),
  99 .BR sigwaitinfo (2),
 100 .BR sigsetops (3),
 101 .BR signal (7)
 102 .SH COLOPHON
 103 This page is part of release 3.79 of the Linux
 104 .I man-pages
 105 project.
 106 A description of the project,
 107 information about reporting bugs,
 108 and the latest version of this page,
 109 can be found at
 110 \%http://www.kernel.org/doc/man\-pages/.