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