share/man/man3/pthread_sigmask.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$
  29 .Dd April 27, 2000
  30 .Dt PTHREAD_SIGMASK 3
  31 .Os
  32 .Sh NAME
  33 .Nm pthread_sigmask
  34 .Nd examine and/or change a thread's signal mask
  35 .Sh LIBRARY
  36 .Lb libc_r
  37 .Lb libpthread
  38 .Lb libthr
  39 .Sh SYNOPSIS
  40 .In pthread.h
  41 .In signal.h
  42 .Ft int
  43 .Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn pthread_sigmask
  47 function examines and/or changes the calling thread's signal mask.
  48 .Pp
  49 If
  50 .Fa set
  51 is not
  52 .Dv NULL ,
  53 it specifies a set of signals to be modified, and
  54 .Fa how
  55 specifies what to set the signal mask to:
  56 .Bl -tag -width SIG_UNBLOCK
  57 .It Dv SIG_BLOCK
  58 Union of the current mask and
  59 .Fa set .
  60 .It Dv SIG_UNBLOCK
  61 Intersection of the current mask and the complement of
  62 .Fa set .
  63 .It Dv SIG_SETMASK
  64 .Fa set .
  65 .El
  66 .Pp
  67 If
  68 .Fa oset
  69 is not NULL, the previous signal mask is stored in the location pointed to by
  70 .Fa oset .
  71 .Pp
  72 .Dv SIGKILL
  73 and
  74 .Dv SIGSTOP
  75 cannot be blocked, and will be silently ignored if included in the signal mask.
  76 .Sh RETURN VALUES
  77 If successful,
  78 .Fn pthread_sigmask
  79 returns 0.
  80 Otherwise, an error is returned.
  81 .Sh ERRORS
  82 The
  83 .Fn pthread_sigmask
  84 function will fail if:
  85 .Bl -tag -width Er
  86 .It Bq Er EINVAL
  87 .Fa how
  88 is not one of the defined values.
  89 .El
  90 .Sh SEE ALSO
  91 .Xr sigaction 2 ,
  92 .Xr sigpending 2 ,
  93 .Xr sigprocmask 2 ,
  94 .Xr sigsuspend 2 ,
  95 .Xr sigsetops 3
  96 .Sh STANDARDS
  97 The
  98 .Fn pthread_sigmask
  99 function conforms to
 100 .St -p1003.1-96