/usr/share/gtk-doc/html/loudmouth/loudmouth-lm-message-handler.html is in libloudmouth1-dev 1.4.3-10.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LmMessageHandler</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Loudmouth Reference Manual">
<link rel="up" href="ch01.html" title="Loudmouth">
<link rel="prev" href="loudmouth-lm-message.html" title="LmMessage">
<link rel="next" href="loudmouth-lm-message-node.html" title="LmMessageNode">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="loudmouth-lm-message.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Loudmouth Reference Manual</th>
<td><a accesskey="n" href="loudmouth-lm-message-node.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#loudmouth-lm-message-handler.synopsis" class="shortcut">Top</a>
|
<a href="#loudmouth-lm-message-handler.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="loudmouth-lm-message-handler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="loudmouth-lm-message-handler.top_of_page"></a>LmMessageHandler</span></h2>
<p>LmMessageHandler — A handler for incoming messages.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="loudmouth-lm-message-handler.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="loudmouth-lm-connection.html#LmHandlerResult" title="enum LmHandlerResult"><span class="returnvalue">LmHandlerResult</span></a> (<a class="link" href="loudmouth-lm-message-handler.html#LmHandleMessageFunction" title="LmHandleMessageFunction ()">*LmHandleMessageFunction</a>) (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-connection.html#LmConnection" title="LmConnection"><span class="type">LmConnection</span></a> *connection</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">LmMessageHandler</span> * <a class="link" href="loudmouth-lm-message-handler.html#lm-message-handler-new" title="lm_message_handler_new ()">lm_message_handler_new</a> (<em class="parameter"><code><a class="link" href="loudmouth-lm-message-handler.html#LmHandleMessageFunction" title="LmHandleMessageFunction ()"><span class="type">LmHandleMessageFunction</span></a> function</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
<span class="returnvalue">void</span> <a class="link" href="loudmouth-lm-message-handler.html#lm-message-handler-invalidate" title="lm_message_handler_invalidate ()">lm_message_handler_invalidate</a> (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="loudmouth-lm-message-handler.html#lm-message-handler-is-valid" title="lm_message_handler_is_valid ()">lm_message_handler_is_valid</a> (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);
<span class="returnvalue">LmMessageHandler</span> * <a class="link" href="loudmouth-lm-message-handler.html#lm-message-handler-ref" title="lm_message_handler_ref ()">lm_message_handler_ref</a> (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);
<span class="returnvalue">void</span> <a class="link" href="loudmouth-lm-message-handler.html#lm-message-handler-unref" title="lm_message_handler_unref ()">lm_message_handler_unref</a> (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="loudmouth-lm-message-handler.description"></a><h2>Description</h2>
<p>
A handler can be registered to listen to incoming messages with <a class="link" href="loudmouth-lm-connection.html#lm-connection-register-message-handler" title="lm_connection_register_message_handler ()"><code class="function">lm_connection_register_message_handler()</code></a>. When a message is recieved the handlers of the correct type will be called.
</p>
</div>
<div class="refsect1">
<a name="loudmouth-lm-message-handler.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LmHandleMessageFunction"></a><h3>LmHandleMessageFunction ()</h3>
<pre class="programlisting"><a class="link" href="loudmouth-lm-connection.html#LmHandlerResult" title="enum LmHandlerResult"><span class="returnvalue">LmHandlerResult</span></a> (*LmHandleMessageFunction) (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-connection.html#LmConnection" title="LmConnection"><span class="type">LmConnection</span></a> *connection</code></em>,
<em class="parameter"><code><a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a> *message</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
The actual callback function in an <span class="type">LmMessageHandler</span>. This function is called when an incoming message arrives that haven't been handled by an handler with higher priority.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td>an <span class="type">LmMessageHandler</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-connection.html#LmConnection" title="LmConnection"><span class="type">LmConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>an <a class="link" href="loudmouth-lm-message.html#LmMessage" title="LmMessage"><span class="type">LmMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when creating the handler</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="loudmouth-lm-connection.html#LM-HANDLER-RESULT-REMOVE-MESSAGE:CAPS"><span class="type">LM_HANDLER_RESULT_REMOVE_MESSAGE</span></a> to indicate that message has been handled, otherwise <a class="link" href="loudmouth-lm-connection.html#LM-HANDLER-RESULT-ALLOW-MORE-HANDLERS:CAPS"><span class="type">LM_HANDLER_RESULT_ALLOW_MORE_HANDLERS</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-handler-new"></a><h3>lm_message_handler_new ()</h3>
<pre class="programlisting"><span class="returnvalue">LmMessageHandler</span> * lm_message_handler_new (<em class="parameter"><code><a class="link" href="loudmouth-lm-message-handler.html#LmHandleMessageFunction" title="LmHandleMessageFunction ()"><span class="type">LmHandleMessageFunction</span></a> function</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>
Creates a new message handler. This can be set to handle incoming messages
and when a message of the type the handler is registered to handle is
received <em class="parameter"><code>function</code></em> will be called and <em class="parameter"><code>user_data</code></em> will be passed to it.
<em class="parameter"><code>notify</code></em> is called when the message handler is freed, that way any memory
allocated by <em class="parameter"><code>user_data</code></em> can be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>a callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data passed to function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td>function called when the message handler is freed</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created message handler</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-handler-invalidate"></a><h3>lm_message_handler_invalidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lm_message_handler_invalidate (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);</pre>
<p>
Invalidates the handler. Useful if you need to cancel a reply
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td>an <span class="type">LmMessageHandler</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-handler-is-valid"></a><h3>lm_message_handler_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> lm_message_handler_is_valid (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);</pre>
<p>
Fetches whether the handler is valid or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td>an <span class="type">LmMessageHandler</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if <em class="parameter"><code>handler</code></em> is valid, otherwise <span class="type">FALSE</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-handler-ref"></a><h3>lm_message_handler_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">LmMessageHandler</span> * lm_message_handler_ref (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);</pre>
<p>
Adds a reference to <em class="parameter"><code>handler</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td>an <span class="type">LmMessageHandler</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the message handler</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lm-message-handler-unref"></a><h3>lm_message_handler_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lm_message_handler_unref (<em class="parameter"><code><span class="type">LmMessageHandler</span> *handler</code></em>);</pre>
<p>
Removes a reference from <em class="parameter"><code>handler</code></em>. When no more references are present the
handler is freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td>an <span class="type">LmMessagHandler</span>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|