usr/src/man/man3c/pthread_kill.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_KILL 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_kill \- send a signal to a thread
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  19 #include <signal.h>
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_kill\fR(\fBpthread_t\fR \fIthread\fR, \fBint\fR \fIsig\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBpthread_kill()\fR function sends the \fIsig\fR signal to the thread
  29 designated by thread.  The \fIthread\fR argument must be a member of the same
  30 process as the calling thread. The \fIsig\fR argument must be  one of the
  31 signals listed in \fBsignal.h\fR(3HEAD), with the exception of \fBSIGCANCEL\fR
  32 being reserved and off limits to \fBpthread_kill()\fR.  If \fIsig\fR is 0, a
  33 validity check is performed for the existence of the target thread; no signal
  34 is sent.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 Upon successful completion, the function returns a value of  \fB0\fR. Otherwise
  39 the function returns an error number. If the \fBpthread_kill()\fR function
  40 fails, no signal is sent.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 The  \fBpthread_kill()\fR function will fail if:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBESRCH\fR\fR
  49 .ad
  50 .RS 10n
  51 No thread could be found corresponding to that specified by the given thread
  52 \fBID.\fR
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBEINVAL\fR\fR
  59 .ad
  60 .RS 10n
  61 The value of the \fIsig\fR argument is an invalid or unsupported signal number.
  62 .RE
  63
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for descriptions of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Interface Stability     Standard
  78 _
  79 MT-Level        MT-Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBkill\fR(1), \fBpthread_self\fR(3C), \fBpthread_sigmask\fR(3C),
  86 \fBraise\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)