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

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   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 SIGQUEUE 3C "Feb 5, 2008"
  13 .SH NAME
  14 sigqueue \- queue a signal to a process
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sys/types.h>
  19 #include <signal.h>
  20
  21 \fBint\fR \fBsigqueue\fR(\fBpid_t\fR \fIpid\fR, \fBint\fR \fIsigno\fR, \fBconst union sigval\fR \fIvalue\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBsigqueue()\fR function causes the signal specified by \fIsigno\fR to be
  28 sent with the value specified by \fIvalue\fR to the process specified by
  29 \fIpid\fR. If \fIsigno\fR is 0 (the null signal), error checking is performed
  30 but no signal is actually sent. The null signal can be used to check the
  31 validity of \fIpid\fR.
  32 .sp
  33 .LP
  34 The conditions required for a process to have permission to queue a signal to
  35 another process are the same as for the \fBkill\fR(2) function.
  36 .sp
  37 .LP
  38 The \fBsigqueue()\fR function returns immediately. If \fBSA_SIGINFO\fR is set
  39 for \fIsigno\fR and if the resources were available to queue the signal, the
  40 signal is queued and sent to the receiving process. If \fBSA_SIGINFO\fR is not
  41 set for \fIsigno\fR, then \fIsigno\fR is sent at least once to the receiving
  42 process; it is unspecified whether \fIvalue\fR will be sent to the receiving
  43 process as a result of this call.
  44 .sp
  45 .LP
  46 If the value of \fIpid\fR causes \fIsigno\fR to be generated for the sending
  47 process, and if \fIsigno\fR is not blocked for the calling thread and if no
  48 other thread has \fIsigno\fR unblocked or is waiting in a \fBsigwait\fR(2)
  49 function for \fIsigno\fR, either \fIsigno\fR or at least the pending, unblocked
  50 signal will be delivered to the calling thread before the \fBsigqueue()\fR
  51 function returns. Should any of multiple pending signals in the range
  52 \fBSIGRTMIN\fR to \fBSIGRTMAX\fR be selected for delivery, it will be the
  53 lowest numbered one. The selection order between realtime and non-realtime
  54 signals, or between multiple pending non-realtime signals, is unspecified.
  55 .SH RETURN VALUES
  56 .sp
  57 .LP
  58 Upon successful completion, the specified signal will have been queued, and the
  59 \fBsigqueue()\fR function returns  \fB0\fR. Otherwise, the function returns
  60 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  61 .SH ERRORS
  62 .sp
  63 .LP
  64 The \fBsigqueue()\fR function will fail if:
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBEAGAIN\fR \fR
  69 .ad
  70 .RS 11n
  71 No resources are available to queue the signal. The process has already queued
  72 \fBSIGQUEUE_MAX\fR signals that are still pending at the receiver(s), or a
  73 system wide resource limit has been exceeded.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBEINVAL\fR \fR
  80 .ad
  81 .RS 11n
  82 The value of \fIsigno\fR is an invalid or unsupported signal number.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBENOSYS\fR \fR
  89 .ad
  90 .RS 11n
  91 The \fBsigqueue()\fR function is not supported by the system.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEPERM\fR \fR
  98 .ad
  99 .RS 11n
 100 The process does not have the appropriate privilege to send the signal to the
 101 receiving process.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBESRCH\fR \fR
 108 .ad
 109 .RS 11n
 110 The process \fIpid\fR does not exist.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 Interface Stability     Committed
 127 _
 128 MT-Level        Async-Signal-Safe
 129 _
 130 Standard        See \fBstandards\fR(5).
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBkill\fR(2), \fBsiginfo.h\fR(3HEAD), \fBsignal.h\fR(3HEAD),
 137 \fBsigwaitinfo\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)