Imported Upstream version 4.14.1
[platform/upstream/rpm.git] / doc / librpm / html / rpmsq_8h.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>rpm: rpmsq.h File Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">rpm
22    &#160;<span id="projectnumber">4.14.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 <div id="nav-path" class="navpath">
40   <ul>
41 <li class="navelem"><a class="el" href="dir_14c931ba4d22b4eaaf008543ee4d9331.html">rpmio</a></li>  </ul>
42 </div>
43 </div><!-- top -->
44 <div class="header">
45   <div class="summary">
46 <a href="#define-members">Macros</a> &#124;
47 <a href="#typedef-members">Typedefs</a> &#124;
48 <a href="#func-members">Functions</a>  </div>
49   <div class="headertitle">
50 <div class="title">rpmsq.h File Reference<div class="ingroups"><a class="el" href="group__io.html">I/O</a> &raquo; <a class="el" href="group__rpmio.html">RPM IO API.</a></div></div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Signal Queue API.  
55 <a href="#details">More...</a></p>
56 <div class="textblock"><code>#include &lt;rpm/rpmsw.h&gt;</code><br />
57 <code>#include &lt;signal.h&gt;</code><br />
58 </div><div class="textblock"><div class="dynheader">
59 Include dependency graph for rpmsq.h:</div>
60 <div class="dyncontent">
61 <div class="center"><img src="rpmsq_8h__incl.png" border="0" usemap="#rpmsq_8h" alt=""/></div>
62 <map name="rpmsq_8h" id="rpmsq_8h">
63 </map>
64 </div>
65 </div>
66 <p><a href="rpmsq_8h_source.html">Go to the source code of this file.</a></p>
67 <table class="memberdecls">
68 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
69 Macros</h2></td></tr>
70 <tr class="memitem:ga2c587f9155ff973ea09662f6494eaf80"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga2c587f9155ff973ea09662f6494eaf80">RPMSQ_DFL</a>&#160;&#160;&#160;((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)0)</td></tr>
71 <tr class="memdesc:ga2c587f9155ff973ea09662f6494eaf80"><td class="mdescLeft">&#160;</td><td class="mdescRight">SIG_DFL, SIG_IGN and SIG_ERR counterparts.  <a href="group__rpmsq.html#ga2c587f9155ff973ea09662f6494eaf80">More...</a><br /></td></tr>
72 <tr class="separator:ga2c587f9155ff973ea09662f6494eaf80"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a326692ac4a909c17c5fa074770e76ea3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpmsq_8h.html#a326692ac4a909c17c5fa074770e76ea3">RPMSQ_IGN</a>&#160;&#160;&#160;((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)1)</td></tr>
74 <tr class="separator:a326692ac4a909c17c5fa074770e76ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
75 <tr class="memitem:a811f0c74c25c1423016ac022026ea556"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpmsq_8h.html#a811f0c74c25c1423016ac022026ea556">RPMSQ_ERR</a>&#160;&#160;&#160;((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)-1)</td></tr>
76 <tr class="separator:a811f0c74c25c1423016ac022026ea556"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 </table><table class="memberdecls">
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
79 Typedefs</h2></td></tr>
80 <tr class="memitem:gafd54980a788d8e9767f7b31f04604252"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</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>
81 <tr class="memdesc:gafd54980a788d8e9767f7b31f04604252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default signal handler prototype.  <a href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">More...</a><br /></td></tr>
82 <tr class="separator:gafd54980a788d8e9767f7b31f04604252"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 </table><table class="memberdecls">
84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
85 Functions</h2></td></tr>
86 <tr class="memitem:ga07972540d07ec41922891e8dbdc8e823"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga07972540d07ec41922891e8dbdc8e823">rpmsqIsCaught</a> (int signum)</td></tr>
87 <tr class="memdesc:ga07972540d07ec41922891e8dbdc8e823"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if given signal has been caught (while signals blocked).  <a href="group__rpmsq.html#ga07972540d07ec41922891e8dbdc8e823">More...</a><br /></td></tr>
88 <tr class="separator:ga07972540d07ec41922891e8dbdc8e823"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:ga0260fed4e99cd3c1c635ce5366775357"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga0260fed4e99cd3c1c635ce5366775357">rpmsqActivate</a> (int state)</td></tr>
90 <tr class="memdesc:ga0260fed4e99cd3c1c635ce5366775357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate (or disable) the signal queue.  <a href="group__rpmsq.html#ga0260fed4e99cd3c1c635ce5366775357">More...</a><br /></td></tr>
91 <tr class="separator:ga0260fed4e99cd3c1c635ce5366775357"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>&#160;</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>
93 <tr class="memdesc:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set or delete a signal handler for a signal.  <a href="group__rpmsq.html#gad3fd7ab24150b8862dfa888dd8e08e8b">More...</a><br /></td></tr>
94 <tr class="separator:gad3fd7ab24150b8862dfa888dd8e08e8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:gaa4efc24f5d48092f17db49767b537213"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#gaa4efc24f5d48092f17db49767b537213">rpmsqBlock</a> (int op)</td></tr>
96 <tr class="memdesc:gaa4efc24f5d48092f17db49767b537213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block or unblock (almost) all signals.  <a href="group__rpmsq.html#gaa4efc24f5d48092f17db49767b537213">More...</a><br /></td></tr>
97 <tr class="separator:gaa4efc24f5d48092f17db49767b537213"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsq.html#ga90d55dcd7c2ccc15c5ef5b66ba9b286d">rpmsqPoll</a> (void)</td></tr>
99 <tr class="memdesc:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for caught signals, executing their handlers.  <a href="group__rpmsq.html#ga90d55dcd7c2ccc15c5ef5b66ba9b286d">More...</a><br /></td></tr>
100 <tr class="separator:ga90d55dcd7c2ccc15c5ef5b66ba9b286d"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:ad417c0e3e55d3afd736361e251f20eda"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpmsq_8h.html#ad417c0e3e55d3afd736361e251f20eda">rpmsqSetInterruptSafety</a> (int on)</td></tr>
102 <tr class="separator:ad417c0e3e55d3afd736361e251f20eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 </table>
104 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
105 <div class="textblock"><p>Signal Queue API. </p>
106
107 <p class="definition">Definition in file <a class="el" href="rpmsq_8h_source.html">rpmsq.h</a>.</p>
108 </div><h2 class="groupheader">Macro Definition Documentation</h2>
109 <a id="a811f0c74c25c1423016ac022026ea556"></a>
110 <h2 class="memtitle"><span class="permalink"><a href="#a811f0c74c25c1423016ac022026ea556">&#9670;&nbsp;</a></span>RPMSQ_ERR</h2>
111
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname">#define RPMSQ_ERR&#160;&#160;&#160;((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)-1)</td>
117         </tr>
118       </table>
119 </div><div class="memdoc">
120
121 <p class="definition">Definition at line <a class="el" href="rpmsq_8h_source.html#l00029">29</a> of file <a class="el" href="rpmsq_8h_source.html">rpmsq.h</a>.</p>
122
123 </div>
124 </div>
125 <a id="a326692ac4a909c17c5fa074770e76ea3"></a>
126 <h2 class="memtitle"><span class="permalink"><a href="#a326692ac4a909c17c5fa074770e76ea3">&#9670;&nbsp;</a></span>RPMSQ_IGN</h2>
127
128 <div class="memitem">
129 <div class="memproto">
130       <table class="memname">
131         <tr>
132           <td class="memname">#define RPMSQ_IGN&#160;&#160;&#160;((<a class="el" href="group__rpmsq.html#gafd54980a788d8e9767f7b31f04604252">rpmsqAction_t</a>)1)</td>
133         </tr>
134       </table>
135 </div><div class="memdoc">
136
137 <p class="definition">Definition at line <a class="el" href="rpmsq_8h_source.html#l00028">28</a> of file <a class="el" href="rpmsq_8h_source.html">rpmsq.h</a>.</p>
138
139 </div>
140 </div>
141 <h2 class="groupheader">Function Documentation</h2>
142 <a id="ad417c0e3e55d3afd736361e251f20eda"></a>
143 <h2 class="memtitle"><span class="permalink"><a href="#ad417c0e3e55d3afd736361e251f20eda">&#9670;&nbsp;</a></span>rpmsqSetInterruptSafety()</h2>
144
145 <div class="memitem">
146 <div class="memproto">
147       <table class="memname">
148         <tr>
149           <td class="memname">void rpmsqSetInterruptSafety </td>
150           <td>(</td>
151           <td class="paramtype">int&#160;</td>
152           <td class="paramname"><em>on</em></td><td>)</td>
153           <td></td>
154         </tr>
155       </table>
156 </div><div class="memdoc">
157
158 </div>
159 </div>
160 </div><!-- contents -->
161 <!-- start footer part -->
162 <hr class="footer"/><address class="footer"><small>
163 Generated by &#160;<a href="http://www.doxygen.org/index.html">
164 <img class="footer" src="doxygen.png" alt="doxygen"/>
165 </a> 1.8.13
166 </small></address>
167 </body>
168 </html>