<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rpm: Signal Queue API.</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rpm
 <span id="projectnumber">4.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Signal Queue API.</div> </div>
</div><!--header-->
<div class="contents">
<p>Signal Queue API.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2c587f9155ff973ea09662f6494eaf80"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga2c587f9155ff973ea09662f6494eaf80">RPMSQ_DFL</a>   ((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)0)</td></tr>
<tr class="memdesc:ga2c587f9155ff973ea09662f6494eaf80"><td class="mdescLeft"> </td><td class="mdescRight">SIG_DFL, SIG_IGN and SIG_ERR counterparts. <a href="#ga2c587f9155ff973ea09662f6494eaf80">More...</a><br /></td></tr>
<tr class="separator:ga2c587f9155ff973ea09662f6494eaf80"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gafd54980a788d8e9767f7b31f04604252"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>) (int signum, siginfo_t *info, void *context)</td></tr>
<tr class="memdesc:gafd54980a788d8e9767f7b31f04604252"><td class="mdescLeft"> </td><td class="mdescRight">Default signal handler prototype. <a href="#gafd54980a788d8e9767f7b31f04604252">More...</a><br /></td></tr>
<tr class="separator:gafd54980a788d8e9767f7b31f04604252"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga07972540d07ec41922891e8dbdc8e823"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga07972540d07ec41922891e8dbdc8e823">rpmsqIsCaught</a> (int signum)</td></tr>
<tr class="memdesc:ga07972540d07ec41922891e8dbdc8e823"><td class="mdescLeft"> </td><td class="mdescRight">Test if given signal has been caught (while signals blocked). <a href="#ga07972540d07ec41922891e8dbdc8e823">More...</a><br /></td></tr>
<tr class="separator:ga07972540d07ec41922891e8dbdc8e823"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0260fed4e99cd3c1c635ce5366775357"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga0260fed4e99cd3c1c635ce5366775357">rpmsqActivate</a> (int state)</td></tr>
<tr class="memdesc:ga0260fed4e99cd3c1c635ce5366775357"><td class="mdescLeft"> </td><td class="mdescRight">Activate (or disable) the signal queue. <a href="#ga0260fed4e99cd3c1c635ce5366775357">More...</a><br /></td></tr>
<tr class="separator:ga0260fed4e99cd3c1c635ce5366775357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#gad3fd7ab24150b8862dfa888dd8e08e8b">rpmsqSetAction</a> (int signum, <a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a> handler)</td></tr>
<tr class="memdesc:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="mdescLeft"> </td><td class="mdescRight">Set or delete a signal handler for a signal. <a href="#gad3fd7ab24150b8862dfa888dd8e08e8b">More...</a><br /></td></tr>
<tr class="separator:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4efc24f5d48092f17db49767b537213"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#gaa4efc24f5d48092f17db49767b537213">rpmsqBlock</a> (int op)</td></tr>
<tr class="memdesc:gaa4efc24f5d48092f17db49767b537213"><td class="mdescLeft"> </td><td class="mdescRight">Block or unblock (almost) all signals. <a href="#gaa4efc24f5d48092f17db49767b537213">More...</a><br /></td></tr>
<tr class="separator:gaa4efc24f5d48092f17db49767b537213"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga90d55dcd7c2ccc15c5ef5b66ba9b286d">rpmsqPoll</a> (void)</td></tr>
<tr class="memdesc:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="mdescLeft"> </td><td class="mdescRight">Poll for caught signals, executing their handlers. <a href="#ga90d55dcd7c2ccc15c5ef5b66ba9b286d">More...</a><br /></td></tr>
<tr class="separator:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Signal Queue API. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga2c587f9155ff973ea09662f6494eaf80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c587f9155ff973ea09662f6494eaf80">◆ </a></span>RPMSQ_DFL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RPMSQ_DFL   ((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SIG_DFL, SIG_IGN and SIG_ERR counterparts. </p>
<p class="definition">Definition at line <a class="el" href="rpmsq_8h_source.html#l00027">27</a> of file <a class="el" href="rpmsq_8h_source.html">rpmsq.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gafd54980a788d8e9767f7b31f04604252"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd54980a788d8e9767f7b31f04604252">◆ </a></span>rpmsqAction_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* rpmsqAction_t) (int signum, siginfo_t *info, void *context)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default signal handler prototype. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>signal number </td></tr>
<tr><td class="paramname">info</td><td>(siginfo_t) signal info </td></tr>
<tr><td class="paramname">context</td><td>signal context </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="rpmsq_8h_source.html#l00022">22</a> of file <a class="el" href="rpmsq_8h_source.html">rpmsq.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0260fed4e99cd3c1c635ce5366775357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0260fed4e99cd3c1c635ce5366775357">◆ </a></span>rpmsqActivate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rpmsqActivate </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate (or disable) the signal queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>1 to enable, 0 to disable </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, negative on error </dd></dl>
</div>
</div>
<a id="gaa4efc24f5d48092f17db49767b537213"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4efc24f5d48092f17db49767b537213">◆ </a></span>rpmsqBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rpmsqBlock </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>op</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block or unblock (almost) all signals. </p>
<p>The operation is "reference counted" so the calls can be nested, and signals are only unblocked when the reference count falls to zero. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>SIG_BLOCK/SIG_UNBLOCK </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error </dd></dl>
</div>
</div>
<a id="ga07972540d07ec41922891e8dbdc8e823"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga07972540d07ec41922891e8dbdc8e823">◆ </a></span>rpmsqIsCaught()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rpmsqIsCaught </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signum</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if given signal has been caught (while signals blocked). </p>
<p>Similar to sigismember() but operates on internal signal queue. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>signal to test for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if caught, 0 if not and -1 on error </dd></dl>
</div>
</div>
<a id="ga90d55dcd7c2ccc15c5ef5b66ba9b286d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga90d55dcd7c2ccc15c5ef5b66ba9b286d">◆ </a></span>rpmsqPoll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rpmsqPoll </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Poll for caught signals, executing their handlers. </p>
<dl class="section return"><dt>Returns</dt><dd>no. active signals found </dd></dl>
</div>
</div>
<a id="gad3fd7ab24150b8862dfa888dd8e08e8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad3fd7ab24150b8862dfa888dd8e08e8b">◆ </a></span>rpmsqSetAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a> rpmsqSetAction </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a> </td>
<td class="paramname"><em>handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set or delete a signal handler for a signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signum</td><td>signal number </td></tr>
<tr><td class="paramname">handler</td><td>signal handler or NULL to delete </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>previous handler, RPMSQ_ERR on error </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>