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