original/man3/pthread_kill.3

   1 .\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_KILL 3 2012-08-19 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_kill \- send a signal to a thread
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <signal.h>
  32
  33 .BI "int pthread_kill(pthread_t " thread ", int " sig );
  34 .fi
  35 .sp
  36 Compile and link with \fI\-pthread\fP.
  37 .SH DESCRIPTION
  38 The
  39 .BR pthread_kill ()
  40 function sends the signal
  41 .I sig
  42 to
  43 .IR thread ,
  44 a thread in the same process as the caller.
  45 The signal is asynchronously directed to
  46 .IR thread .
  47
  48 If
  49 .I sig
  50 is 0, then no signal is sent, but error checking is still performed;
  51 this can be used to check for the existence of a thread ID.
  52 .SH RETURN VALUE
  53 On success,
  54 .BR pthread_kill ()
  55 returns 0;
  56 on error, it returns an error number, and no signal is sent.
  57 .SH ERRORS
  58 .TP
  59 .B EINVAL
  60 An invalid signal was specified.
  61 .TP
  62 .B ESRCH
  63 No thread with the ID
  64 .I thread
  65 could be found.
  66 .SH CONFORMING TO
  67 POSIX.1-2001.
  68 .SH NOTES
  69 Signal dispositions are process-wide:
  70 if a signal handler is installed,
  71 the handler will be invoked in the thread
  72 .IR thread ,
  73 but if the disposition of the signal is "stop", "continue", or "terminate",
  74 this action will affect the whole process.
  75 .SH SEE ALSO
  76 .BR kill (2),
  77 .BR sigaction (2),
  78 .BR sigpending (2),
  79 .BR pthread_self (3),
  80 .BR pthread_sigmask (3),
  81 .BR raise (3),
  82 .BR pthreads (7),
  83 .BR signal (7)