home   contributing   bugs   download   online pages  

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | CONFORMING TO | NOTES | SEE ALSO | COLOPHON


SIGWAIT(3)                    Linux Programmer's Manual                    SIGWAIT(3)

NAME         top

       sigwait - wait for a signal

SYNOPSIS         top

       #include <signal.h>

        int sigwait(const sigset_t *set, int *sig);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

       sigwait(): _POSIX_C_SOURCE >= 1 || _XOPEN_SOURCE || _POSIX_SOURCE

DESCRIPTION         top

       The sigwait() function suspends execution of the calling thread until the
       delivery of one of the signals specified in the signal set set.  The function
       accepts the signal (removes it from the pending list of signals), and returns
       the signal number in set.

       The operation of sigwait() is the same as sigwaitinfo(), except that:

       * sigwait() only returns the signal number, rather than a siginfo_t structure
         describing the signal.

       * The return values of the two functions are different.

RETURN VALUE         top

       On success, sigwait() returns 0.  On error, it returns a positive error
       number.

ERRORS         top

       EINVAL set contains an invalid signal number.

CONFORMING TO         top

       POSIX.1-2001.

NOTES         top

       sigwait() is implemented using sigtimedwait(2).

SEE ALSO         top

       sigaction(2), signalfd(2), sigpending(2), sigsuspend(2), sigwaitinfo(2),
       sigsetops(3), signal(7)

COLOPHON         top

       This page is part of release 3.11 of the Linux man-pages project.  A
       description of the project, and information about reporting bugs, can be found
       at http://www.kernel.org/doc/man-pages/.

Linux                                 2008-08-29                           SIGWAIT(3)