NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | CONFORMING TO | NOTES | SEE ALSO | COLOPHON

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

NAME         top

       pthread_kill - send a signal to a thread

SYNOPSIS         top

       #include <signal.h>

       int pthread_kill(pthread_t thread, int sig);

       Compile and link with -pthread.

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

       pthread_kill():
           _POSIX_C_SOURCE >= 199506L || _XOPEN_SOURCE >= 500

DESCRIPTION         top

       The pthread_kill() function sends the signal sig to thread, a thread
       in the same process as the caller.  The signal is asynchronously
       directed to thread.

       If sig is 0, then no signal is sent, but error checking is still
       performed.

RETURN VALUE         top

       On success, pthread_kill() returns 0; on error, it returns an error
       number, and no signal is sent.

ERRORS         top

       EINVAL An invalid signal was specified.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).

       ┌───────────────┬───────────────┬─────────┐
       │Interface      Attribute     Value   │
       ├───────────────┼───────────────┼─────────┤
       │pthread_kill() │ Thread safety │ MT-Safe │
       └───────────────┴───────────────┴─────────┘

CONFORMING TO         top

       POSIX.1-2001, POSIX.1-2008.

NOTES         top

       Signal dispositions are process-wide: if a signal handler is
       installed, the handler will be invoked in the thread thread, but if
       the disposition of the signal is "stop", "continue", or "terminate",
       this action will affect the whole process.

       The glibc implementation of pthread_kill() gives an error (EINVAL) on
       attempts to send either of the real-time signals used internally by
       the NPTL threading implementation.  See nptl(7) for details.

       POSIX.1-2008 recommends that if an implementation detects the use of
       a thread ID after the end of its lifetime, pthread_kill() should
       return the error ESRCH.  The glibc implementation returns this error
       in the cases where an invalid thread ID can be detected.  But note
       also that POSIX says that an attempt to use a thread ID whose
       lifetime has ended produces undefined behavior, and an attempt to use
       an invalid thread ID in a call to pthread_kill() can, for example,
       cause a segmentation fault.

SEE ALSO         top

       kill(2), sigaction(2), sigpending(2), pthread_self(3),
       pthread_sigmask(3), raise(3), pthreads(7), signal(7)

COLOPHON         top

       This page is part of release 4.07 of the Linux man-pages project.  A
       description of the project, information about reporting bugs, and the
       latest version of this page, can be found at
       https://www.kernel.org/doc/man-pages/.

Linux                            2015-08-08                  PTHREAD_KILL(3)