/usr/share/gtk-doc/html/libxfce4util/libxfce4util-POSIX-Signal-Handling.html is in libxfce4util-dev 4.12.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>POSIX Signal Handling</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="libxfce4util Reference Manual">
<link rel="up" href="libxfce4util-core.html" title="Xfce Core Application support">
<link rel="prev" href="libxfce4util-Xfce-Kiosk-functions.html" title="Xfce Kiosk functions">
<link rel="next" href="libxfce4util-utilities.html" title="Xfce Utilities">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libxfce4util-POSIX-Signal-Handling.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libxfce4util-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libxfce4util-Xfce-Kiosk-functions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libxfce4util-utilities.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4util-POSIX-Signal-Handling.top_of_page"></a>POSIX Signal Handling</span></h2>
<p>POSIX Signal Handling — a callback system for handling POSIX signals safely</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a href="libxfce4util-POSIX-Signal-Handling.html#XfcePosixSignalHandler" title="XfcePosixSignalHandler ()">*XfcePosixSignalHandler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a href="libxfce4util-POSIX-Signal-Handling.html#xfce-posix-signal-handler-init" title="xfce_posix_signal_handler_init ()">xfce_posix_signal_handler_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a href="libxfce4util-POSIX-Signal-Handling.html#xfce-posix-signal-handler-restore-handler" title="xfce_posix_signal_handler_restore_handler ()">xfce_posix_signal_handler_restore_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a href="libxfce4util-POSIX-Signal-Handling.html#xfce-posix-signal-handler-set-handler" title="xfce_posix_signal_handler_set_handler ()">xfce_posix_signal_handler_set_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a href="libxfce4util-POSIX-Signal-Handling.html#xfce-posix-signal-handler-shutdown" title="xfce_posix_signal_handler_shutdown ()">xfce_posix_signal_handler_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libxfce4util/libxfce4util.h>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling.description"></a><h2>Description</h2>
<p>
Due to reentrancy issues, there is a restricted set of functions/syscalls
that are allowed to be performed inside a POSIX signal handler. In
general, it's safer to defer any signal-related processing until after the
signal handler has run. The functionality in this module automatically
handles this, and allows you to set a handler function (with optional user
data) for any signal.
</p>
</div>
<div class="refsect1" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling.functions_details"></a><h2>Functions</h2>
<div class="refsect2" lang="en">
<a name="XfcePosixSignalHandler"></a><h3>XfcePosixSignalHandler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*XfcePosixSignalHandler<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> signal</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
A function signature to use for POSIX signal handler functions.
</p>
<div class="refsect3" lang="en">
<a name="idm2085798928"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>signal</p></td>
<td class="parameter_description"><p>The signal that was caught.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>user_data</code></em>
parameter passed when the handler was registered.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="xfce-posix-signal-handler-init"></a><h3>xfce_posix_signal_handler_init ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xfce_posix_signal_handler_init (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Initializes the POSIX signal handler system. Must be called
before setting any POSIX signal handlers.</p>
<div class="refsect3" lang="en">
<a name="idm1813773584"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location of a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to store any possible errors.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp1231797360"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure, in which case
<em class="parameter"><code>error</code></em>
will be set.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="xfce-posix-signal-handler-restore-handler"></a><h3>xfce_posix_signal_handler_restore_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_posix_signal_handler_restore_handler
(<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> signal</code></em>);</pre>
<p>Restores the default handler for <em class="parameter"><code>signal</code></em>
.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="xfce-posix-signal-handler-set-handler"></a><h3>xfce_posix_signal_handler_set_handler ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xfce_posix_signal_handler_set_handler (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> signal</code></em>,
<em class="parameter"><code><a href="libxfce4util-POSIX-Signal-Handling.html#XfcePosixSignalHandler" title="XfcePosixSignalHandler ()"><span class="type">XfcePosixSignalHandler</span></a> handler</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sets <em class="parameter"><code>handler</code></em>
to be called whenever <em class="parameter"><code>signal</code></em>
is caught by the
application. The <em class="parameter"><code>user_data</code></em>
parameter will be passed as an argument
to <em class="parameter"><code>handler</code></em>
.</p>
<div class="refsect3" lang="en">
<a name="idm171459856"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handler</p></td>
<td class="parameter_description"><p>A callback function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Arbitrary data that will be passed to <em class="parameter"><code>handler</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location of a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to store any possible errors.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idm2046975888"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise, in which case
<em class="parameter"><code>error</code></em>
will be set.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="xfce-posix-signal-handler-shutdown"></a><h3>xfce_posix_signal_handler_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_posix_signal_handler_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Frees all memory associated with the POSIX signal handling system
and restores all default signal handlers.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="libxfce4util-POSIX-Signal-Handling.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|