sys/pthread_kill.2

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