/usr/share/gtk-doc/html/libinfinity-0.6/InfdXmppServer.html is in libinfinity-0.6-doc 0.6.7-1build1.
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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfdXmppServer: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch05.html" title="Libinfinity server side API">
<link rel="prev" href="InfdXmlServer.html" title="InfdXmlServer">
<link rel="next" href="InfdServerPool.html" title="InfdServerPool">
<meta name="generator" content="GTK-Doc V1.24 (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="#InfdXmppServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfdXmppServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfdXmppServer.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfdXmppServer.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfdXmppServer.signals" class="shortcut">Signals</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfdXmlServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfdServerPool.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfdXmppServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfdXmppServer.top_of_page"></a>InfdXmppServer</span></h2>
<p>InfdXmppServer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfdXmppServer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="returnvalue">InfdXmppServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfdXmppServer.html#infd-xmpp-server-new" title="infd_xmpp_server_new ()">infd_xmpp_server_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfdXmppServer.html#infd-xmpp-server-set-security-policy" title="infd_xmpp_server_set_security_policy ()">infd_xmpp_server_set_security_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>
</td>
<td class="function_name">
<a class="link" href="InfdXmppServer.html#infd-xmpp-server-get-security-policy" title="infd_xmpp_server_get_security_policy ()">infd_xmpp_server_get_security_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--credentials" title="The “credentials” property">credentials</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--local-hostname" title="The “local-hostname” property">local-hostname</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-context" title="The “sasl-context” property">sasl-context</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-mechanisms" title="The “sasl-mechanisms” property">sasl-mechanisms</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--security-policy" title="The “security-policy” property">security-policy</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a> *</td>
<td class="property_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer--tcp-server" title="The “tcp-server” property">tcp-server</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer-error" title="The “error” signal">error</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfdXmppServer.html#InfdXmppServer-struct" title="struct InfdXmppServer">InfdXmppServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfdXmppServer.html#InfdXmppServerClass" title="struct InfdXmppServerClass">InfdXmppServerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfdXmppServer
</pre>
</div>
<div class="refsect1">
<a name="InfdXmppServer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfdXmppServer implements
<a class="link" href="InfdXmlServer.html" title="InfdXmlServer">InfdXmlServer</a>.</p>
</div>
<div class="refsect1">
<a name="InfdXmppServer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="InfdXmppServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infd-xmpp-server-new"></a><h3>infd_xmpp_server_new ()</h3>
<pre class="programlisting"><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="returnvalue">InfdXmppServer</span></a> *
infd_xmpp_server_new (<em class="parameter"><code><a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a> *tcp</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>,
<em class="parameter"><code><a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>,
<em class="parameter"><code><a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *sasl_context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *sasl_mechanisms</code></em>);</pre>
<p>Creates a new <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> with <em class="parameter"><code>tcp</code></em>
as underlaying TCP server object.
No attempt is being made to open <em class="parameter"><code>tcp</code></em>
, if it is not already open. When a
new connection comes in, the XMPP server creates a XMPP connection that
may be used to communicate with the client. Note however that the
resulting connection will be in status OPENING until authentication has
completed.</p>
<p>If <em class="parameter"><code>policy</code></em>
is <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-SECURITY-ONLY-UNSECURED:CAPS"><code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</code></a>, then <em class="parameter"><code>creds</code></em>
may
be <code class="literal">NULL</code>. If <em class="parameter"><code>creds</code></em>
is non-<code class="literal">NULL</code> nevertheless, then it is possible to change
the security policy later using <a class="link" href="InfdXmppServer.html#infd-xmpp-server-set-security-policy" title="infd_xmpp_server_set_security_policy ()"><code class="function">infd_xmpp_server_set_security_policy()</code></a>.
<em class="parameter"><code>creds</code></em>
can also be changed later while the server is running. So just set
valid credentials before changing <em class="parameter"><code>policy</code></em>
to allow TLS.</p>
<p>If <em class="parameter"><code>sasl_context</code></em>
is <code class="literal">NULL</code>, the server uses a built-in context that only
supports ANONYMOUS authentication. If <em class="parameter"><code>sasl_context</code></em>
is not <code class="literal">NULL</code>, then
<em class="parameter"><code>sasl_mechanisms</code></em>
specifies the mechanisms offered to clients. If
<em class="parameter"><code>sasl_mechanisms</code></em>
is <code class="literal">NULL</code>, then all available mechanims will be offered.
If <em class="parameter"><code>sasl_context</code></em>
is <code class="literal">NULL</code>, then this parameter is ignored.</p>
<div class="refsect3">
<a name="id-1.6.14.10.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tcp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>The initial security policy.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>creds</p></td>
<td class="parameter_description"><p>Certificate credentials used to secure any communication.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_context</p></td>
<td class="parameter_description"><p>A SASL context used for authentication.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_mechanisms</p></td>
<td class="parameter_description"><p>A whitespace-sparated list of SASL mechanisms.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.14.10.2.8"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-xmpp-server-set-security-policy"></a><h3>infd_xmpp_server_set_security_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infd_xmpp_server_set_security_policy (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>);</pre>
<p>Sets the security policy for newly accepted <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.
Does not already established connections.</p>
<div class="refsect3">
<a name="id-1.6.14.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>The new security policy.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-xmpp-server-get-security-policy"></a><h3>infd_xmpp_server_get_security_policy ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>
infd_xmpp_server_get_security_policy (<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>);</pre>
<p>Returns the current security policy for newly accepted
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.</p>
<div class="refsect3">
<a name="id-1.6.14.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.14.10.4.6"></a><h4>Returns</h4>
<p> The current security policy.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfdXmppServer-struct"></a><h3>struct InfdXmppServer</h3>
<pre class="programlisting">struct InfdXmppServer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServerClass"></a><h3>struct InfdXmppServerClass</h3>
<pre class="programlisting">struct InfdXmppServerClass {
GObjectClass parent_class;
/* Signals */
void (*error)(InfdXmppServer* server,
GError* error);
};
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfdXmppServer--credentials"></a><h3>The <code class="literal">“credentials”</code> property</h3>
<pre class="programlisting"> “credentials” <a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</pre>
<p>The certificate credentials for GnuTLS.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServer--local-hostname"></a><h3>The <code class="literal">“local-hostname”</code> property</h3>
<pre class="programlisting"> “local-hostname” <span class="type">gchar</span> *</pre>
<p>Hostname of the server.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServer--sasl-context"></a><h3>The <code class="literal">“sasl-context”</code> property</h3>
<pre class="programlisting"> “sasl-context” <a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</pre>
<p>The SASL context used for authentaction.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServer--sasl-mechanisms"></a><h3>The <code class="literal">“sasl-mechanisms”</code> property</h3>
<pre class="programlisting"> “sasl-mechanisms” <span class="type">gchar</span> *</pre>
<p>The SASL mechanisms offered to the client for authentication.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServer--security-policy"></a><h3>The <code class="literal">“security-policy”</code> property</h3>
<pre class="programlisting"> “security-policy” <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></pre>
<p>Whether to offer or require TLS.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdXmppServer--tcp-server"></a><h3>The <code class="literal">“tcp-server”</code> property</h3>
<pre class="programlisting"> “tcp-server” <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a> *</pre>
<p>Underlaying TCP server.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfdXmppServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfdXmppServer-error"></a><h3>The <code class="literal">“error”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *infdxmppserver,
<span class="type">gpointer</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.14.13.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>infdxmppserver</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|