]>
Commit | Line | Data |
---|---|---|
e95c1726 MK |
1 | .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk |
2 | .\" <mtk.manpages@gmail.com> | |
3 | .\" | |
93015253 | 4 | .\" %%%LICENSE_START(VERBATIM) |
e95c1726 MK |
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. | |
4b72fb64 | 24 | .\" %%%LICENSE_END |
e95c1726 | 25 | .\" |
f55a6d59 | 26 | .TH SIGWAIT 3 2017-07-13 "Linux" "Linux Programmer's Manual" |
e95c1726 MK |
27 | .SH NAME |
28 | sigwait \- wait for a signal | |
29 | .SH SYNOPSIS | |
30 | .nf | |
31 | .B #include <signal.h> | |
dbfe9c70 | 32 | .PP |
e95c1726 MK |
33 | .BI " int sigwait(const sigset_t *" set ", int *" sig ); |
34 | .fi | |
26bab9df | 35 | .PP |
0f200f07 MK |
36 | .in -4n |
37 | Feature Test Macro Requirements for glibc (see | |
38 | .BR feature_test_macros (7)): | |
39 | .in | |
68e4db0a | 40 | .PP |
0f200f07 MK |
41 | .ad l |
42 | .BR sigwait (): | |
06adeea5 MK |
43 | .RS 4 |
44 | Since glibc 2.26: | |
45 | _POSIX_C_SOURCE >= 199506L | |
46 | .br | |
47 | Glibc 2.25 and earlier: | |
48 | _POSIX_C_SOURCE | |
49 | .RE | |
0f200f07 | 50 | .ad b |
e95c1726 MK |
51 | .SH DESCRIPTION |
52 | The | |
53 | .BR sigwait () | |
5011ecfd MK |
54 | function suspends execution of the calling thread until |
55 | one of the signals specified in the signal set | |
56 | .IR set | |
57 | becomes pending. | |
e95c1726 MK |
58 | The function accepts the signal |
59 | (removes it from the pending list of signals), | |
60 | and returns the signal number in | |
a3dadfe8 | 61 | .IR sig . |
26bab9df | 62 | .PP |
e95c1726 MK |
63 | The operation of |
64 | .BR sigwait () | |
65 | is the same as | |
0b80cf56 | 66 | .BR sigwaitinfo (2), |
e95c1726 MK |
67 | except that: |
68 | .IP * 2 | |
69 | .BR sigwait () | |
33a0ccb2 | 70 | returns only the signal number, rather than a |
e95c1726 MK |
71 | .I siginfo_t |
72 | structure describing the signal. | |
73 | .IP * | |
74 | The return values of the two functions are different. | |
75 | .SH RETURN VALUE | |
76 | On success, | |
77 | .BR sigwait () | |
78 | returns 0. | |
535f0df5 | 79 | On error, it returns a positive error number (listed in ERRORS). |
e95c1726 MK |
80 | .SH ERRORS |
81 | .TP | |
82 | .B EINVAL | |
83 | .\" Does not occur for glibc. | |
84 | .I set | |
85 | contains an invalid signal number. | |
598a7a2d | 86 | .SH ATTRIBUTES |
8e09ed53 PH |
87 | For an explanation of the terms used in this section, see |
88 | .BR attributes (7). | |
89 | .TS | |
90 | allbox; | |
91 | lb lb lb | |
92 | l l l. | |
93 | Interface Attribute Value | |
94 | T{ | |
598a7a2d | 95 | .BR sigwait () |
8e09ed53 PH |
96 | T} Thread safety MT-Safe |
97 | .TE | |
e95c1726 | 98 | .SH CONFORMING TO |
696a8483 | 99 | POSIX.1-2001, POSIX.1-2008. |
e95c1726 MK |
100 | .SH NOTES |
101 | .BR sigwait () | |
102 | is implemented using | |
103 | .BR sigtimedwait (2). | |
26bab9df | 104 | .PP |
4ff3769f MK |
105 | The glibc implementation of |
106 | .BR sigwait () | |
107 | silently ignores attempts to wait for the two real-time signals that | |
108 | are used internally by the NPTL threading implementation. | |
109 | See | |
110 | .BR nptl (7) | |
111 | for details. | |
44a720e3 | 112 | .SH EXAMPLE |
cf499212 MK |
113 | See |
114 | .BR pthread_sigmask (3). | |
e95c1726 | 115 | .SH SEE ALSO |
e95c1726 MK |
116 | .BR sigaction (2), |
117 | .BR signalfd (2), | |
118 | .BR sigpending (2), | |
119 | .BR sigsuspend (2), | |
120 | .BR sigwaitinfo (2), | |
121 | .BR sigsetops (3), | |
122 | .BR signal (7) |