321 lines
8.3 KiB
HTML
321 lines
8.3 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>sigsuspend()--Wait for Signal</title>
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- UNIX5 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- Edited by Kersten Feb 02 -->
|
||
|
|
<!-- This file has undergone error condition cleanup on 04/30/02 by JET -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>sigsuspend()--Wait for Signal</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <signal.h>
|
||
|
|
|
||
|
|
int sigsuspend( const sigset_t <em>*sigmask</em> );
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Service Program Name: QPOSSRV1<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>sigsuspend()</strong> function replaces the current signal mask
|
||
|
|
of a thread with the signal set given by <em>*sigmask</em> and then suspends
|
||
|
|
processing of the calling process. The thread does not resume running until a
|
||
|
|
signal is delivered whose action is to call a signal-catching function, to end
|
||
|
|
the request, or to terminate the process. (Signal sets are described in more
|
||
|
|
detail in <a href="sigeset.htm">sigemptyset()--Initialize and Empty Signal
|
||
|
|
Set</a>.)</p>
|
||
|
|
|
||
|
|
<p>The signal mask indicates a set of signals that should be blocked. Such
|
||
|
|
signals do not "wake up" the suspended function. The signals SIGStop and
|
||
|
|
SIGKILL cannot be blocked or ignored; they are delivered to the thread
|
||
|
|
regardless of what the <em>sigmask</em> argument specifies.</p>
|
||
|
|
|
||
|
|
<p>If an incoming unblocked signal has an action of end the request of
|
||
|
|
terminate the process, <strong>sigsuspend()</strong> never returns to the
|
||
|
|
caller. If an incoming signal is handled by a signal-catching function,
|
||
|
|
<strong>sigsuspend()</strong> returns after the signal-catching function
|
||
|
|
returns. In this case, the signal mask of the thread is restored to whatever it
|
||
|
|
was before <strong>sigsuspend()</strong> was called.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><em>*sigmask</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) A pointer to a set of signals to be used to replace the current
|
||
|
|
signal mask of the process.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top"><strong>sigsuspend()</strong> was not successful.
|
||
|
|
The <em>errno</em> variable is set to indicate the reason.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>There is no return value to indicate successful completion.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p>If <strong>sigsuspend()</strong> returns, <em>errno</em> indicates the
|
||
|
|
following:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>[EINTR]</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<p>Interrupted function call.</p>
|
||
|
|
|
||
|
|
<p>A signal was received and handled by a signal-catching function that
|
||
|
|
returned.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[EINVAL]</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<p>The value specified for the argument is not correct.</p>
|
||
|
|
|
||
|
|
<p>A function was passed incorrect argument values, or an operation was
|
||
|
|
attempted on an object and the operation specified is not supported for that
|
||
|
|
type of object.</p>
|
||
|
|
|
||
|
|
<p>An argument value is not valid, out of range, or NULL. The signal set
|
||
|
|
pointed to by <em>sigmask</em> contains a signal that is not within the valid
|
||
|
|
range or a signal that is not supported.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[ENOTSIGINIT]</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<p>Process not enabled for signals.</p>
|
||
|
|
|
||
|
|
<p>An attempt was made to call a signal function under one of the following
|
||
|
|
conditions:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The signal function is being called for a process that is not enabled for
|
||
|
|
asynchronous signals.</li>
|
||
|
|
|
||
|
|
<li>The signal function is being called when the system signal controls have
|
||
|
|
not been initialized.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[EWOULDBLOCK]</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<p>Operation would have caused the process to be suspended.</p>
|
||
|
|
|
||
|
|
<p>The current thread state would prevent the signal function from
|
||
|
|
completing.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<p>The <strong>sigsuspend</strong> function enables a process for signals if
|
||
|
|
the process is not already enabled for signals. For details, see <a href=
|
||
|
|
"sigeset.htm">Qp0sEnableSignals()--Enable Process for Signals</a>. If the
|
||
|
|
system has not been enabled for signals, <strong>sigsuspend()</strong> is not
|
||
|
|
successful, and an [ENOTSIGINIT] error is returned.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The <<strong>signal.h</strong>> file (see <a href="unix13.htm">Header
|
||
|
|
Files for UNIX-Type Functions</a>)<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigalarm.htm">alarm()</a>--Set Schedule for Alarm Signal<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigpause.htm">pause()</a>--Suspend Process Until Signal
|
||
|
|
Received<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigdsig.htm">Qp0sDisableSignals()</a>--Disable Process for
|
||
|
|
Signals<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigesig.htm">Qp0sEnableSignals()</a>--Enable Process for
|
||
|
|
Signals<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigactn.htm">sigaction()</a>--Examine and Change Signal Action<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigaset.htm">sigaddset()</a>--Add Signal to Signal Set<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigdset.htm">sigdelset()</a>--Delete Signal from Signal Set<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigeset.htm">sigemptyset()</a>--Initialize and Empty Signal
|
||
|
|
Set<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigfset.htm">sigfillset()</a>--Initialize and Fill Signal Set<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigismbr.htm">sigismember()</a>--Test for Signal in Signal Set<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigpend.htm">sigpending()</a>--Examine Pending Signals<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigpmsk.htm">sigprocmask()</a>--Examine and Change Blocked
|
||
|
|
Signals<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigtwait.htm">sigtimedwait()</a>--Synchronously Accept a Signal
|
||
|
|
for Interval of Time<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigwait.htm">sigwait()</a>--Synchronously Accept a Signal<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigwaiti.htm">sigwaitinfo()</a>--Synchronously Accept a Signal and
|
||
|
|
Signal Data<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="sigsleep.htm">sleep()</a>--Suspend Processing for Interval of
|
||
|
|
Time</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Example</h3>
|
||
|
|
|
||
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
||
|
|
for information pertaining to code examples.</p>
|
||
|
|
|
||
|
|
<p>The following example replaces the signal mask and then suspends
|
||
|
|
processing:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <signal.h>
|
||
|
|
#include <unistd.h>
|
||
|
|
#include <stdio.h>
|
||
|
|
#include <time.h>
|
||
|
|
|
||
|
|
void catcher( int sig ) {
|
||
|
|
printf( "inside catcher() function\n" );
|
||
|
|
}
|
||
|
|
|
||
|
|
void timestamp( char *str ) {
|
||
|
|
|
||
|
|
time_t t;
|
||
|
|
|
||
|
|
time( &t );
|
||
|
|
printf( "%s the time is %s\n", str, ctime(&t) );
|
||
|
|
}
|
||
|
|
|
||
|
|
int main( int argc, char *argv[] ) {
|
||
|
|
|
||
|
|
struct sigaction sigact;
|
||
|
|
sigset_t block_set;
|
||
|
|
|
||
|
|
sigfillset( &block_set );
|
||
|
|
sigdelset( &block_set, SIGALRM );
|
||
|
|
|
||
|
|
sigemptyset( &sigact.sa_mask );
|
||
|
|
sigact.sa_flags = 0;
|
||
|
|
sigact.sa_handler = catcher;
|
||
|
|
sigaction( SIGALRM, &sigact, NULL );
|
||
|
|
|
||
|
|
timestamp( "before sigsuspend()" );
|
||
|
|
alarm( 10 );
|
||
|
|
sigsuspend( &block_set );
|
||
|
|
timestamp( "after sigsuspend()" );
|
||
|
|
|
||
|
|
return( 0 );
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<h3>Output:</h3>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
before sigsuspend() the time is Sun Jan 22 17:11:41 1995
|
||
|
|
inside catcher() function
|
||
|
|
after sigsuspend() the time is Sun Jan 22 17:11:51 1995
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V3R6
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|