/usr/share/gtk-doc/html/libinfinity-0.6/InfXmppManager.html is in libinfinity-0.6-doc 0.6.7-2.
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 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfXmppManager: 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="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi">
<link rel="next" href="InfIo.html" title="InfIo">
<meta name="generator" content="GTK-Doc V1.25 (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="#InfXmppManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfXmppManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfXmppManager.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfDiscoveryAvahi.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfIo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfXmppManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfXmppManager.top_of_page"></a>InfXmppManager</span></h2>
<p>InfXmppManager — Reuse existing connections</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfXmppManager.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfXmppManager.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="InfXmppManager.html" title="InfXmppManager"><span class="returnvalue">InfXmppManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-new" title="inf_xmpp_manager_new ()">inf_xmpp_manager_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()">inf_xmpp_manager_lookup_connection_by_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-hostname" title="inf_xmpp_manager_lookup_connection_by_hostname ()">inf_xmpp_manager_lookup_connection_by_hostname</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-contains-connection" title="inf_xmpp_manager_contains_connection ()">inf_xmpp_manager_contains_connection</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="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()">inf_xmpp_manager_add_connection</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="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()">inf_xmpp_manager_remove_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppManager.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="InfXmppManager.html#InfXmppManager-connection-added" title="The “connection-added” signal">connection-added</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfXmppManager.html#InfXmppManager-connection-removed" title="The “connection-removed” signal">connection-removed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppManager.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="InfXmppManager.html#InfXmppManager-struct" title="struct InfXmppManager">InfXmppManager</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfXmppManager.html#InfXmppManagerClass" title="struct InfXmppManagerClass">InfXmppManagerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfXmppManager
</pre>
</div>
<div class="refsect1">
<a name="InfXmppManager.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-xmpp-manager.h>
</pre>
</div>
<div class="refsect1">
<a name="InfXmppManager.description"></a><h2>Description</h2>
<p><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> stores <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> objects and allows to look them
up by the IP address and port number of their underlaying
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>s. This can be used to reuse existing network
connections instead of creating new ones.</p>
<p>Each object which needs to make connections should be passed a
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>. Then, when making a connection to a certain address/port
pair, it should first look in the XMPP manager whether there is already
an existing connection to the destination host, via
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()"><code class="function">inf_xmpp_manager_lookup_connection_by_address()</code></a>. If there is, it should
use it (maybe reopen it if it is closed). Otherwise, it should create a
new connection and add it to the XMPP manager via
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()"><code class="function">inf_xmpp_manager_add_connection()</code></a> for others to use.</p>
<p>The XMPP manager can also handle connections whose address is still to be
looked up. Such connections are looked up by the hostname given to the
name resolver. Once the hostname has been looked up, and if another
connection with the same addressand port number exists already, the new
connection is removed in favor of the already existing one.</p>
</div>
<div class="refsect1">
<a name="InfXmppManager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-xmpp-manager-new"></a><h3>inf_xmpp_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="returnvalue">InfXmppManager</span></a> *
inf_xmpp_manager_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new xmpp manager.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-manager-lookup-connection-by-address"></a><h3>inf_xmpp_manager_lookup_connection_by_address ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
inf_xmpp_manager_lookup_connection_by_address
(<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *address</code></em>,
<em class="parameter"><code><span class="type">guint</span> port</code></em>);</pre>
<p>Looks for a <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> contained in <em class="parameter"><code>manager</code></em>
whose underlaying
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> has the given address and port set. Returns <code class="literal">NULL</code> if
there is no such connection.</p>
<p>This function may also return a closed connection. You can then attempt to
reopen it, or remove it from the manager using
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()"><code class="function">inf_xmpp_manager_remove_connection()</code></a> when that fails.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-lookup-connection-by-address.parameters"></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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>address</p></td>
<td class="parameter_description"><p>The remote <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> of the connection to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The remote port number of the connection to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-xmpp-manager-lookup-connection-by-address.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> with the given address and port, or <code class="literal">NULL</code> on
error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-manager-lookup-connection-by-hostname"></a><h3>inf_xmpp_manager_lookup_connection_by_hostname ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
inf_xmpp_manager_lookup_connection_by_hostname
(<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *service</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *srv</code></em>);</pre>
<p>Looks for a <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> contained in <em class="parameter"><code>manager</code></em>
whose underlaying
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> has a <a class="link" href="InfNameResolver.html" title="InfNameResolver"><span class="type">InfNameResolver</span></a> with the given properties.</p>
<p>This function may also return a closed connection. You can then attempt to
reopen it, or remove it from the manager using
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-remove-connection" title="inf_xmpp_manager_remove_connection ()"><code class="function">inf_xmpp_manager_remove_connection()</code></a> when that fails.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-lookup-connection-by-hostname.parameters"></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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hostname</p></td>
<td class="parameter_description"><p>The remote hostname to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>The service string of the connection to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>srv</p></td>
<td class="parameter_description"><p>The SRV record corresponding to the connection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-xmpp-manager-lookup-connection-by-hostname.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> with the given hostname, service and srv,
or <code class="literal">NULL</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-manager-contains-connection"></a><h3>inf_xmpp_manager_contains_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_xmpp_manager_contains_connection (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>connection</code></em>
is contained in <em class="parameter"><code>manager</code></em>
.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-contains-connection.parameters"></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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-xmpp-manager-contains-connection.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>connection</code></em>
is contained in <em class="parameter"><code>manager</code></em>
, <code class="literal">FALSE</code>
otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-manager-add-connection"></a><h3>inf_xmpp_manager_add_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_manager_add_connection (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>Adds the given connection to <em class="parameter"><code>manager</code></em>
so that it is found by
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-address" title="inf_xmpp_manager_lookup_connection_by_address ()"><code class="function">inf_xmpp_manager_lookup_connection_by_address()</code></a>,
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-lookup-connection-by-hostname" title="inf_xmpp_manager_lookup_connection_by_hostname ()"><code class="function">inf_xmpp_manager_lookup_connection_by_hostname()</code></a> and
<a class="link" href="InfXmppManager.html#inf-xmpp-manager-contains-connection" title="inf_xmpp_manager_contains_connection ()"><code class="function">inf_xmpp_manager_contains_connection()</code></a>.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-add-connection.parameters"></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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> not yet contained in <em class="parameter"><code>manager</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-manager-remove-connection"></a><h3>inf_xmpp_manager_remove_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_manager_remove_connection (<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection</code></em>);</pre>
<p>Removes the given connection from <em class="parameter"><code>manager</code></em>
.</p>
<div class="refsect3">
<a name="inf-xmpp-manager-remove-connection.parameters"></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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> contained in <em class="parameter"><code>manager</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfXmppManager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfXmppManager-struct"></a><h3>struct InfXmppManager</h3>
<pre class="programlisting">struct InfXmppManager;</pre>
<p><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> is an opaque data type. You should only access it via the
public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppManagerClass"></a><h3>struct InfXmppManagerClass</h3>
<pre class="programlisting">struct InfXmppManagerClass {
void(*connection_added)(InfXmppManager* manager,
InfXmppConnection* connection);
void(*connection_removed)(InfXmppManager* manager,
InfXmppConnection* connection,
InfXmppConnection* replaced_by);
};
</pre>
<p>This structure contains the default signal handlers for <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p>
<div class="refsect3">
<a name="InfXmppManagerClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfXmppManagerClass.connection-added"></a>connection_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfXmppManager.html#InfXmppManager-connection-added" title="The “connection-added” signal"><span class="type">“connection-added”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfXmppManagerClass.connection-removed"></a>connection_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfXmppManager.html#InfXmppManager-connection-removed" title="The “connection-removed” signal"><span class="type">“connection-removed”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfXmppManager.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfXmppManager-connection-added"></a><h3>The <code class="literal">“connection-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *xmpp_manager,
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *connection,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever a new connection has been added to the
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>, via <a class="link" href="InfXmppManager.html#inf-xmpp-manager-add-connection" title="inf_xmpp_manager_add_connection ()"><code class="function">inf_xmpp_manager_add_connection()</code></a>.</p>
<div class="refsect3">
<a name="InfXmppManager-connection-added.parameters"></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>xmpp_manager</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> that was added to <em class="parameter"><code>xmpp_manager</code></em>
.</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>
<hr>
<div class="refsect2">
<a name="InfXmppManager-connection-removed"></a><h3>The <code class="literal">“connection-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *infxmppmanager,
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *arg1,
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *arg2,
<span class="type">gpointer</span> user_data)</pre>
<p>
</p>
<div class="refsect3">
<a name="InfXmppManager-connection-removed.parameters"></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>infxmppmanager</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.25</div>
</body>
</html>
|