lib/libpthread/pthread_kill.3

   1 .\" $NetBSD: pthread_kill.3,v 1.7 2008/05/04 19:43:05 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice(s), this list of conditions and the following disclaimer as
  33 .\"    the first lines of this file unmodified other than the possible
  34 .\"    addition of one or more copyright notices.
  35 .\" 2. Redistributions in binary form must reproduce the above copyright
  36 .\"    notice(s), this list of conditions and the following disclaimer in
  37 .\"    the documentation and/or other materials provided with the
  38 .\"    distribution.
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  41 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  44 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  45 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  46 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  47 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  48 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  49 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  50 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .\" $FreeBSD: src/lib/libpthread/man/pthread_kill.3,v 1.9 2002/09/16 19:29:28 mini Exp $
  53 .Dd October 30, 2003
  54 .Dt PTHREAD_KILL 3
  55 .Os
  56 .Sh NAME
  57 .Nm pthread_kill
  58 .Nd send a signal to a specified thread
  59 .Sh LIBRARY
  60 .Lb libpthread
  61 .Sh SYNOPSIS
  62 .In pthread.h
  63 .In signal.h
  64 .Ft int
  65 .Fn pthread_kill "pthread_t thread" "int sig"
  66 .Sh DESCRIPTION
  67 The
  68 .Fn pthread_kill
  69 function sends a signal, specified by
  70 .Fa sig ,
  71 to a thread, specified by
  72 .Fa thread .
  73 The signal will be handled in the context of
  74 .Fa thread ,
  75 but the signal action may alter the process as a whole.
  76 If
  77 .Fa sig
  78 is 0, error checking is performed, but no signal is actually sent.
  79 .Sh RETURN VALUES
  80 If successful,
  81 .Fn pthread_kill
  82 returns 0.
  83 Otherwise, an error number is returned.
  84 .Sh ERRORS
  85 .Fn pthread_kill
  86 shall fail if:
  87 .Bl -tag -width Er
  88 .It Bq Er EINVAL
  89 .Fa sig
  90 is an invalid or unsupported signal number.
  91 .It Bq Er ESRCH
  92 .Fa thread
  93 is an invalid thread ID.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr kill 2 ,
  97 .Xr sigwait 2 ,
  98 .Xr pthread_self 3 ,
  99 .Xr raise 3
 100 .Sh STANDARDS
 101 .Fn pthread_kill
 102 conforms to
 103 .St -p1003.1-96 .