Commit | Line | Data |
---|---|---|
15637ed4 RG |
1 | .\" Copyright (c) 1983, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms, with or without | |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
31 | .\" | |
32 | .\" @(#)sigsuspend.2 6.3 (Berkeley) 7/23/91 | |
33 | .\" | |
34 | .Dd July 23, 1991 | |
35 | .Dt SIGSUSPEND 2 | |
36 | .Os | |
37 | .Sh NAME | |
38 | .Nm sigsuspend | |
39 | .Nd atomically release blocked signals and wait for interrupt | |
40 | .Sh SYNOPSIS | |
41 | .Fd #include <sys/signal.h> | |
42 | .Ft int | |
43 | .Fn sigsuspend "const sigset_t *sigmask" | |
44 | .Sh DESCRIPTION | |
45 | .Fn Sigsuspend | |
46 | temporarily changes the blocked signal mask to the set to which | |
47 | .Fa sigmask | |
48 | points, | |
49 | and then waits for a signal to arrive; | |
50 | on return the previous set of masked signals is restored. | |
51 | The signal mask set | |
52 | is usually empty to indicate that all | |
53 | signals are to be unblocked for the duration of the call. | |
54 | .Pp | |
55 | In normal usage, a signal is blocked using | |
56 | .Xr sigprocmask 2 | |
57 | to begin a critical section, variables modified on the occurrence | |
58 | of the signal are examined to determine that there is no work | |
59 | to be done, and the process pauses awaiting work by using | |
60 | .Fn sigsuspend | |
61 | with the previous mask returned by | |
62 | .Xr sigprocmask . | |
63 | .Sh RETURN VALUES | |
64 | The | |
65 | .Fn sigsuspend | |
66 | function | |
67 | always terminates by being interrupted, returning -1 with | |
68 | .Va errno | |
69 | set to | |
70 | .Dv EINTR . | |
71 | .Sh SEE ALSO | |
72 | .Xr sigprocmask 2 , | |
73 | .Xr sigaction 2 , | |
74 | .Xr sigsetops 3 | |
75 | .Sh STANDARDS | |
76 | The | |
77 | .Nm sigsupend | |
78 | function call | |
79 | conforms to | |
80 | .St -p1003.1-88 . |