lib/libc/sys/sigsuspend.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  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        8.2 (Berkeley) 5/16/95
  33 .\" $FreeBSD: src/lib/libc/sys/sigsuspend.2,v 1.9.2.4 2001/12/14 18:34:01 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/sigsuspend.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd May 16, 1995
  37 .Dt SIGSUSPEND 2
  38 .Os
  39 .Sh NAME
  40 .Nm sigsuspend
  41 .Nd atomically release blocked signals and wait for interrupt
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In signal.h
  46 .Ft int
  47 .Fn sigsuspend "const sigset_t *sigmask"
  48 .Sh DESCRIPTION
  49 .Fn Sigsuspend
  50 temporarily changes the blocked signal mask to the set to which
  51 .Fa sigmask
  52 points,
  53 and then waits for a signal to arrive;
  54 on return the previous set of masked signals is restored.
  55 The signal mask set
  56 is usually empty to indicate that all
  57 signals are to be unblocked for the duration of the call.
  58 .Pp
  59 In normal usage, a signal is blocked using
  60 .Xr sigprocmask 2
  61 to begin a critical section, variables modified on the occurrence
  62 of the signal are examined to determine that there is no work
  63 to be done, and the process pauses awaiting work by using
  64 .Fn sigsuspend
  65 with the previous mask returned by
  66 .Xr sigprocmask .
  67 .Sh RETURN VALUES
  68 The
  69 .Fn sigsuspend
  70 function
  71 always terminates by being interrupted, returning -1 with
  72 .Va errno
  73 set to
  74 .Er EINTR .
  75 .Sh SEE ALSO
  76 .Xr sigaction 2 ,
  77 .Xr sigprocmask 2 ,
  78 .Xr sigsetops 3
  79 .Sh STANDARDS
  80 The
  81 .Fn sigsupend
  82 function call is expected to conform to
  83 .St -p1003.1-90 .