Blame man3/pthread_sigqueue.3

Packit 7cfc04
.\" Copyright (c) 2010 Michael Kerrisk, <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH PTHREAD_SIGQUEUE 3 2017-09-15 "Linux" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
pthread_sigqueue \- queue a signal and data to a thread
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <signal.h>
Packit 7cfc04
.B #include <pthread.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "int pthread_sigqueue(pthread_t " thread ", int " sig ,
Packit 7cfc04
.BI "                     const union sigval " value );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
Compile and link with \fI\-pthread\fP.
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR pthread_sigqueue ():
Packit 7cfc04
_GNU_SOURCE
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
function performs a similar task to
Packit 7cfc04
.BR sigqueue (3),
Packit 7cfc04
but, rather than sending a signal to a process,
Packit 7cfc04
it sends a signal to a thread in the same process as the
Packit 7cfc04
calling thread.
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.I thread
Packit 7cfc04
argument is the ID of a thread in the same process as the caller.
Packit 7cfc04
The
Packit 7cfc04
.I sig
Packit 7cfc04
argument specifies the signal to be sent.
Packit 7cfc04
The
Packit 7cfc04
.I value
Packit 7cfc04
argument specifies data to accompany the signal; see
Packit 7cfc04
.BR sigqueue (3)
Packit 7cfc04
for details.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
On success,
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
returns 0;
Packit 7cfc04
on error, it returns an error number.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EAGAIN
Packit 7cfc04
The limit of signals which may be queued has been reached.
Packit 7cfc04
(See
Packit 7cfc04
.BR signal (7)
Packit 7cfc04
for further information.)
Packit 7cfc04
.TP
Packit 7cfc04
.B EINVAL
Packit 7cfc04
.I sig
Packit 7cfc04
was invalid.
Packit 7cfc04
.TP
Packit 7cfc04
.B ENOSYS
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
is not supported on this system.
Packit 7cfc04
.TP
Packit 7cfc04
.B ESRCH
Packit 7cfc04
.I thread
Packit 7cfc04
is not valid.
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
The
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
function first appeared in glibc 2.11.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
This function is a GNU extension.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
The glibc implementation of
Packit 7cfc04
.BR pthread_sigqueue ()
Packit 7cfc04
gives an error
Packit 7cfc04
.RB ( EINVAL )
Packit 7cfc04
on attempts to send either of the real-time signals
Packit 7cfc04
used internally by the NPTL threading implementation.
Packit 7cfc04
See
Packit 7cfc04
.BR nptl (7)
Packit 7cfc04
for details.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR rt_tgsigqueueinfo (2),
Packit 7cfc04
.BR sigaction (2),
Packit 7cfc04
.BR pthread_sigmask (3),
Packit 7cfc04
.BR sigqueue (3),
Packit 7cfc04
.BR sigwait (3),
Packit 7cfc04
.BR pthreads (7),
Packit 7cfc04
.BR signal (7)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.