PTHREAD_KILL(3)            POSIX Programmer's Manual           PTHREAD_KILL(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       pthread_kill -- send a signal to a thread

SSYYNNOOPPSSIISS
       #include <signal.h>

       int pthread_kill(pthread_t _t_h_r_e_a_d, int _s_i_g);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___k_i_l_l() function shall request that a signal be delivered to
       the specified thread.

       As in _k_i_l_l(), if _s_i_g is zero, error checking shall be performed but no
       signal shall actually be sent.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, the function shall return a value of zero.
       Otherwise, the function shall return an error number. If the
       _p_t_h_r_e_a_d___k_i_l_l() function fails, no signal shall be sent.

EERRRROORRSS
       The _p_t_h_r_e_a_d___k_i_l_l() function shall fail if:

       EEIINNVVAALL The value of the _s_i_g argument is an invalid or unsupported
              signal number.

       The _p_t_h_r_e_a_d___k_i_l_l() function shall not return an error code of [[EEIINNTTRR]].

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       The _p_t_h_r_e_a_d___k_i_l_l() function provides a mechanism for asynchronously
       directing a signal at a thread in the calling process. This could be
       used, for example, by one thread to affect broadcast delivery of a
       signal to a set of threads.

       Note that _p_t_h_r_e_a_d___k_i_l_l() only causes the signal to be handled in the
       context of the given thread; the signal action (termination or
       stopping) affects the process as a whole.

RRAATTIIOONNAALLEE
       If an implementation detects use of a thread ID after the end of its
       lifetime, it is recommended that the function should fail and report an
       [[EESSRRCCHH]] error.

       Existing implementations vary on the result of a _p_t_h_r_e_a_d___k_i_l_l() with a
       thread ID indicating an inactive thread (a terminated thread that has
       not been detached or joined). Some indicate success on such a call,
       while others give an error of [[EESSRRCCHH]].  Since the definition of thread
       lifetime in this volume of POSIX.1-2017 covers inactive threads, the
       [[EESSRRCCHH]] error as described is inappropriate in this case. In
       particular, this means that an application cannot have one thread check
       for termination of another with _p_t_h_r_e_a_d___k_i_l_l().

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       A future version of this standard may require that _p_t_h_r_e_a_d___k_i_l_l() not
       fail with [[EESSRRCCHH]] in the case of sending signals to an inactive thread
       (a terminated thread not yet detached or joined), even though no signal
       will be delivered because the thread is no longer running.

SSEEEE AALLSSOO
       _k_i_l_l(), _p_t_h_r_e_a_d___s_e_l_f(), _r_a_i_s_e()

       The Base Definitions volume of POSIX.1-2017, <<ssiiggnnaall..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version 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 .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                      PTHREAD_KILL(3)
