lib/libpthread/sigwait.3

   1 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
   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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc_r/man/sigwait.3,v 1.2.2.6 2001/12/17 10:08:26 ru Exp $
  29 .\" $DragonFly: src/lib/libc_r/man/sigwait.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  30 .Dd April 15, 2009
  31 .Dt SIGWAIT 3
  32 .Os
  33 .Sh NAME
  34 .Nm sigwait
  35 .Nd select a set of signals
  36 .Sh LIBRARY
  37 .Lb libpthread
  38 .Sh SYNOPSIS
  39 .In signal.h
  40 .Ft int
  41 .Fn sigwait "const sigset_t *set" "int *sig"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn sigwait
  45 function selects a set of signals, specified by
  46 .Fa set .
  47 If none of the selected signals are pending,
  48 .Fn sigwait
  49 waits until one or more of the selected signals has been generated.
  50 Then
  51 .Fn sigwait
  52 atomically clears one of the selected signals from the set of pending signals
  53 for the process and sets the location pointed to by
  54 .Fa sig
  55 to the signal number that was cleared.
  56 .Pp
  57 The signals specified by
  58 .Fa set
  59 should be blocked at the time of the call to
  60 .Fn sigwait .
  61 .Sh RETURN VALUES
  62 If successful,
  63 .Fn sigwait
  64 returns 0 and sets the location pointed to by
  65 .Fa sig
  66 to the cleared signal number.
  67 Otherwise, an error number is returned.
  68 .Sh ERRORS
  69 .Fn sigwait
  70 will fail if:
  71 .Bl -tag -width Er
  72 .It Bq Er EINVAL
  73 .Fa set
  74 specifies one or more invalid signal numbers.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr sigaction 2 ,
  78 .Xr sigpending 2 ,
  79 .Xr sigsuspend 2 ,
  80 .Xr pause 3 ,
  81 .Xr pthread_sigmask 3
  82 .Sh STANDARDS
  83 .Fn sigwait
  84 conforms to
  85 .St -p1003.1-96 .