Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sigtimedwait(2) [freebsd man page]

SIGTIMEDWAIT(2) 					      BSD System Calls Manual						   SIGTIMEDWAIT(2)

NAME
sigtimedwait, sigwaitinfo -- wait for queued signals (REALTIME) LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <signal.h> int sigtimedwait(const sigset_t *restrict set, siginfo_t *restrict info, const struct timespec *restrict timeout); int sigwaitinfo(const sigset_t * restrict set, siginfo_t * restrict info); DESCRIPTION
The sigtimedwait() system call is equivalent to sigwaitinfo() except that if none of the signals specified by set are pending, sigtimedwait() waits for the time interval specified in the timespec structure referenced by timeout. If the timespec structure pointed to by timeout is zero-valued and if none of the signals specified by set are pending, then sigtimedwait() returns immediately with an error. If timeout is the NULL pointer, the behavior is unspecified. CLOCK_MONOTONIC clock is used to measure the time interval specified by the timeout argument. The sigwaitinfo() system call selects the pending signal from the set specified by set. Should any of multiple pending signals in the range SIGRTMIN to SIGRTMAX be selected, it shall be the lowest numbered one. The selection order between realtime and non-realtime signals, or between multiple pending non-realtime signals, is unspecified. If no signal in set is pending at the time of the call, the calling thread is suspended until one or more signals in set become pending or until it is interrupted by an unblocked, caught signal. The sigwaitinfo() system call is equivalent to the sigwait() system call if the info argument is NULL. If the info argument is non-NULL, the sigwaitinfo() function is equivalent to sigwait(), except that the selected signal number shall be stored in the si_signo member, and the cause of the signal shall be stored in the si_code member. Besides this, the sigwaitinfo() and sigtimedwait() system calls may return EINTR if interrupted by signal, which is not allowed for the sigwait() function. If any value is queued to the selected signal, the first such queued value is dequeued and, if the info argument is non-NULL, the value is stored in the si_value member of info. The system resource used to queue the signal is released and returned to the system for other use. If no value is queued, the content of the si_value member is zero-valued. If no further signals are queued for the selected signal, the pending indication for that signal is reset. RETURN VALUES
Upon successful completion (that is, one of the signals specified by set is pending or is generated) sigwaitinfo() and sigtimedwait() return the selected signal number. Otherwise, the functions return a value of -1 and set the global variable errno to indicate the error. ERRORS
The sigtimedwait() system call will fail if: [EAGAIN] No signal specified by set was generated within the specified timeout period. The sigtimedwait() and sigwaitinfo() system calls fail if: [EINTR] The wait was interrupted by an unblocked, caught signal. The sigtimedwait() system call may also fail if: [EINVAL] The timeout argument specified a tv_nsec value less than zero or greater than or equal to 1000 million. Kernel only checks for this error if no signal is pending in set and it is necessary to wait. SEE ALSO
sigaction(2), sigpending(2), sigqueue(2), sigsuspend(2), sigwait(2), pause(3), pthread_sigmask(3), siginfo(3) STANDARDS
The sigtimedwait() and sigwaitinfo() system calls conform to ISO/IEC 9945-1:1996 (``POSIX.1''). BSD
September 27, 2012 BSD

Check Out this Related Man Page

SIGTIMEDWAIT(2) 					      BSD System Calls Manual						   SIGTIMEDWAIT(2)

NAME
sigtimedwait, sigwaitinfo, sigwait -- wait for queued signals LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <signal.h> int sigtimedwait(const sigset_t * restrict set, siginfo_t * restrict info, const struct timespec * restrict timeout); int sigwaitinfo(const sigset_t * restrict set, siginfo_t * restrict info); int sigwait(const sigset_t * restrict set, int * restrict sig); DESCRIPTION
sigwaitinfo() and sigwait() return the first pending signal from the set specified by set. Should multiple signals from set be pending, the lowest numbered one is returned. The selection order between realtime and non-realtime signals is unspecified. If there is no signal from set pending at the time of the call, the calling thread is suspended until one of the specified signals is generated. sigtimedwait() is exactly equal to sigwaitinfo(), except timeout specifies the maximum time interval for which the calling thread will be suspended. If timeout is zero (tv_sec == tv_nsec == 0), sigtimedwait() only checks the currently pending signals and returns immediately. If NULL is used for timeout, sigtimedwait() behaves exactly like sigwaitinfo() in all regards. If several threads are waiting for a given signal, exactly one of them returns from the signal wait when the signal is generated. Behaviour of these functions is unspecified if any of the signals in set are unblocked at the time these functions are called. RETURN VALUES
Upon successful completion of sigtimedwait() or sigwaitinfo() info is updated with signal information, and the function returns the signal number. Otherwise, -1 is returned and the global variable errno indicates the error. Upon successful completion of sigwait() sig is updated with ihe signal number, and the function returns 0. Otherwise, a non-zero error code is returned, ERRORS
sigwaitinfo() and sigwait() always succeed. sigtimedwait() will fail and the info pointer will remain unchanged if: [EAGAIN] No signal specified in set was generated in the specified timeout. sigtimedwait() may also fail if: [EINVAL] The specified timeout was invalid. This error is only checked if no signal from set is pending and it would be necessary to wait. SEE ALSO
sigaction(2), sigprocmask(2), signal(7) STANDARDS
The functions sigtimedwait(), sigwaitinfo(), and sigwait() conform to IEEE Std 1003.1-2001 (``POSIX.1''). HISTORY
The sigtimedwait(), sigwaitinfo(), and sigwait() functions appeared in NetBSD 2.0. BSD
May 30, 2010 BSD
Man Page