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