share/man/man3/pthread_kill.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_KILL 3
  31 .Os
  32 .Sh NAME
  33 .Nm pthread_kill
  34 .Nd send a signal to a specified thread
  35 .Sh LIBRARY
  36 .Lb libpthread
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .In signal.h
  40 .Ft int
  41 .Fn pthread_kill "pthread_t thread" "int sig"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_kill
  45 function sends a signal, specified by
  46 .Fa sig ,
  47 to a thread, specified by
  48 .Fa thread .
  49 If
  50 .Fa sig
  51 is 0, error checking is performed, but no signal is actually sent.
  52 .Sh RETURN VALUES
  53 If successful,
  54 .Fn pthread_kill
  55 returns 0.
  56 Otherwise, an error number is returned.
  57 .Sh ERRORS
  58 The
  59 .Fn pthread_kill
  60 function will fail if:
  61 .Bl -tag -width Er
  62 .It Bq Er ESRCH
  63 .Fa thread
  64 is an invalid thread ID.
  65 .It Bq Er EINVAL
  66 .Fa sig
  67 is an invalid or unsupported signal number.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr kill 2 ,
  71 .Xr pthread_self 3 ,
  72 .Xr raise 3
  73 .Sh STANDARDS
  74 The
  75 .Fn pthread_kill
  76 function conforms to
  77 .St -p1003.1-96