Files
oldlinux-files/study/Ref-docs/POSIX/susv3/functions/sigsuspend.html
2024-02-19 00:25:23 -05:00

153 lines
5.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>sigsuspend</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="sigsuspend"></a> <a name="tag_03_698"></a><!-- sigsuspend -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_698_01"></a>NAME</h4>
<blockquote>sigsuspend - wait for a signal</blockquote>
<h4><a name="tag_03_698_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/signal.h.html">signal.h</a>&gt;<br>
<br>
int sigsuspend(const sigset_t *</tt><i>sigmask</i><tt>); <img src="../images/opt-end.gif" alt="[Option End]" border=
"0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_698_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>sigsuspend</i>() function shall replace the current signal mask of the calling thread with the set of signals pointed to
by <i>sigmask</i> and then suspend the thread until delivery of a signal whose action is either to execute a signal-catching
function or to terminate the process. This shall not cause any other signals that may have been pending on the process to become
pending on the thread.</p>
<p>If the action is to terminate the process then <i>sigsuspend</i>() shall never return. If the action is to execute a
signal-catching function, then <i>sigsuspend</i>() shall return after the signal-catching function returns, with the signal mask
restored to the set that existed prior to the <i>sigsuspend</i>() call.</p>
<p>It is not possible to block signals that cannot be ignored. This is enforced by the system without causing an error to be
indicated.</p>
</blockquote>
<h4><a name="tag_03_698_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Since <i>sigsuspend</i>() suspends thread execution indefinitely, there is no successful completion return value. If a return
occurs, -1 shall be returned and <i>errno</i> set to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_698_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>sigsuspend</i>() function shall fail if:</p>
<dl compact>
<dt>[EINTR]</dt>
<dd>A signal is caught by the calling process and control is returned from the signal-catching function.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_698_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_698_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>Normally, at the beginning of a critical code section, a specified set of signals is blocked using the <a href=
"../functions/sigprocmask.html"><i>sigprocmask</i>()</a> function. When the thread has completed the critical section and needs to
wait for the previously blocked signal(s), it pauses by calling <i>sigsuspend</i>() with the mask that was returned by the <a href=
"../functions/sigprocmask.html"><i>sigprocmask</i>()</a> call.</p>
</blockquote>
<h4><a name="tag_03_698_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_698_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_698_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="xsh_chap02_04.html#tag_02_04"><i>Signal Concepts</i></a> , <a href="pause.html"><i>pause</i>()</a> , <a href=
"sigaction.html"><i>sigaction</i>()</a> , <a href="sigaddset.html"><i>sigaddset</i>()</a> , <a href=
"sigdelset.html"><i>sigdelset</i>()</a> , <a href="sigemptyset.html"><i>sigemptyset</i>()</a> , <a href=
"sigfillset.html"><i>sigfillset</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/signal.h.html"><i>&lt;signal.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_698_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 3. Included for alignment with the POSIX.1-1988 standard.</p>
</blockquote>
<h4><a name="tag_03_698_12"></a>Issue 5</h4>
<blockquote>
<p>The DESCRIPTION is updated for alignment with the POSIX Threads Extension.</p>
</blockquote>
<h4><a name="tag_03_698_13"></a>Issue 6</h4>
<blockquote>
<p>The text in the RETURN VALUE section has been changed from &quot;suspends process execution&quot; to &quot;suspends thread execution&quot;. This
reflects IEEE PASC Interpretation 1003.1c #40.</p>
<p>Text in the APPLICATION USAGE section has been replaced.</p>
<p>The SYNOPSIS is marked CX since the presence of this function in the <a href=
"../basedefs/signal.h.html"><i>&lt;signal.h&gt;</i></a> header is an extension over the ISO&nbsp;C standard.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>