/usr/share/gtk-doc/html/libinfinity-0.5/InfdXmppServer.html is in libinfinity-0.5-doc 0.5.5-1.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 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.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="InfdXmlServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfdServerPool.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfdXmppServer.synopsis" class="shortcut">Top</a>
|
<a href="#InfdXmppServer.description" class="shortcut">Description</a>
|
<a href="#InfdXmppServer.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfdXmppServer.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#InfdXmppServer.properties" class="shortcut">Properties</a>
|
<a href="#InfdXmppServer.signals" class="shortcut">Signals</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InfdXmppServer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="InfdXmppServer.html#InfdXmppServer-struct" title="InfdXmppServer">InfdXmppServer</a>;
struct <a class="link" href="InfdXmppServer.html#InfdXmppServerClass" title="struct InfdXmppServerClass">InfdXmppServerClass</a>;
<a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="returnvalue">InfdXmppServer</span></a> * <a class="link" href="InfdXmppServer.html#infd-xmpp-server-new" title="infd_xmpp_server_new ()">infd_xmpp_server_new</a> (<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"><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>);
<span class="returnvalue">void</span> <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>
(<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"><span class="type">InfXmppConnectionSecurityPolicy</span></a> policy</code></em>);
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a> <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>
(<em class="parameter"><code><a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a> *server</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfdXmppServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----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.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--credentials" title='The "credentials" property'>credentials</a>" <a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a>* : Read / Write / Construct
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--local-hostname" title='The "local-hostname" property'>local-hostname</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-context" title='The "sasl-context" property'>sasl-context</a>" <a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a>* : Read / Write / Construct
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--sasl-mechanisms" title='The "sasl-mechanisms" property'>sasl-mechanisms</a>" <span class="type">gchar</span>* : Read / Write / Construct
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--security-policy" title='The "security-policy" property'>security-policy</a>" <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> : Read / Write / Construct
"<a class="link" href="InfdXmppServer.html#InfdXmppServer--tcp-server" title='The "tcp-server" property'>tcp-server</a>" <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="InfdXmppServer.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="InfdXmppServer.html#InfdXmppServer-error" title='The "error" signal'>error</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="InfdXmppServer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="InfdXmppServer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfdXmppServer-struct"></a><h3>InfdXmppServer</h3>
<pre class="programlisting">typedef struct _InfdXmppServer 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>
<hr>
<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"><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="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>tcp</code></em> :</span></p></td>
<td>A <a class="link" href="InfdTcpServer.html" title="InfdTcpServer"><span class="type">InfdTcpServer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td>The initial security policy.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>creds</code></em> :</span></p></td>
<td>Certificate credentials used to secure any communication.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_context</code></em> :</span></p></td>
<td>A SASL context used for authentication.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_mechanisms</code></em> :</span></p></td>
<td>A whitespace-sparated list of SASL mechanisms.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</td>
</tr>
</tbody>
</table></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"><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="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>server</code></em> :</span></p></td>
<td>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td>The new security policy.</td>
</tr>
</tbody>
</table></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"><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="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>server</code></em> :</span></p></td>
<td>A <a class="link" href="InfdXmppServer.html" title="InfdXmppServer"><span class="type">InfdXmppServer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current security policy.</td>
</tr>
</tbody>
</table></div>
</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>* : Read / Write / Construct</pre>
<p>The certificate credentials for GnuTLS.</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>* : Read / Write / Construct Only</pre>
<p>Hostname of the server.</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>* : Read / Write / Construct</pre>
<p>The SASL context used for authentaction.</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>* : Read / Write / Construct</pre>
<p>The SASL mechanisms offered to the client for authentication.</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"><span class="type">InfXmppConnectionSecurityPolicy</span></a> : Read / Write / Construct</pre>
<p>Whether to offer or require TLS.</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>* : Read / Write / Construct Only</pre>
<p>Underlaying TCP server.</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) : <code class="literal">Run Last</code></pre>
<p>
</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>infdxmppserver</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|