/usr/share/gtk-doc/html/libinfinity-0.6/InfXmlConnection.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 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfXmlConnection: 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="InfTcpConnection.html" title="InfTcpConnection">
<link rel="next" href="InfXmppConnection.html" title="InfXmppConnection">
<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="#InfXmlConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfXmlConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#InfXmlConnection.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#InfXmlConnection.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfXmlConnection.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfXmlConnection.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="InfTcpConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfXmppConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfXmlConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfXmlConnection.top_of_page"></a>InfXmlConnection</span></h2>
<p>InfXmlConnection — Exchange of XML messages</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfXmlConnection.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="InfXmlConnection.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">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfXmlConnection.html#inf-xml-connection-open" title="inf_xml_connection_open ()">inf_xml_connection_open</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="InfXmlConnection.html#inf-xml-connection-close" title="inf_xml_connection_close ()">inf_xml_connection_close</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="InfXmlConnection.html#inf-xml-connection-send" title="inf_xml_connection_send ()">inf_xml_connection_send</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="InfXmlConnection.html#inf-xml-connection-sent" title="inf_xml_connection_sent ()">inf_xml_connection_sent</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="InfXmlConnection.html#inf-xml-connection-received" title="inf_xml_connection_received ()">inf_xml_connection_received</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="InfXmlConnection.html#inf-xml-connection-error" title="inf_xml_connection_error ()">inf_xml_connection_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.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"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--local-certificate" title="The “local-certificate” property">local-certificate</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--local-id" title="The “local-id” property">local-id</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--network" title="The “network” property">network</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCertificateChain.html" title="InfCertificateChain"><span class="type">InfCertificateChain</span></a> *</td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--remote-certificate" title="The “remote-certificate” property">remote-certificate</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--remote-id" title="The “remote-id” property">remote-id</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfXmlConnection.html#InfXmlConnectionStatus" title="enum InfXmlConnectionStatus"><span class="type">InfXmlConnectionStatus</span></a></td>
<td class="property_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection--status" title="The “status” property">status</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.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="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal">error</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="InfXmlConnection.html#InfXmlConnection-received" title="The “received” signal">received</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="InfXmlConnection.html#InfXmlConnection-sent" title="The “sent” signal">sent</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.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"> </td>
<td class="function_name"><a class="link" href="InfXmlConnection.html#InfXmlConnection-struct" title="InfXmlConnection">InfXmlConnection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfXmlConnection.html#InfXmlConnectionIface" title="struct InfXmlConnectionIface">InfXmlConnectionIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfXmlConnection.html#InfXmlConnectionStatus" title="enum InfXmlConnectionStatus">InfXmlConnectionStatus</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">╰──</span> InfXmlConnectionStatus
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> InfXmlConnection
</pre>
</div>
<div class="refsect1">
<a name="InfXmlConnection.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfXmlConnection requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfXmlConnection.implementations"></a><h2>Known Implementations</h2>
<p>
InfXmlConnection is implemented by
<a class="link" href="InfSimulatedConnection.html" title="InfSimulatedConnection">InfSimulatedConnection</a> and <a class="link" href="InfXmppConnection.html" title="InfXmppConnection">InfXmppConnection</a>.</p>
</div>
<div class="refsect1">
<a name="InfXmlConnection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-xml-connection.h>
</pre>
</div>
<div class="refsect1">
<a name="InfXmlConnection.description"></a><h2>Description</h2>
<p><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> provides a generic interface for sending an receiving
messages in the form of XML nodes. The rest of the libinfinity library
works with <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>s to transfer data between nodes.
Therefore, simply implementing this interface allows to use the core
functionality of the library with any kind of network or transport.</p>
<p>Apart from the virtual functions, implementations also need to provide the
<a class="link" href="InfXmlConnection.html#InfXmlConnection--remote-id" title="The “remote-id” property"><span class="type">“remote-id”</span></a> and <a class="link" href="InfXmlConnection.html#InfXmlConnection--local-id" title="The “local-id” property"><span class="type">“local-id”</span></a> properties.
These properties represent string identifiers that are unique to the
particular hosts in the network, such as IP addresses for IP connections.
If the connection is supposed to be used with other communication methods
(see <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>) than the "central" one, these
IDs must be unique and every host must see the same ID for the other hosts
in the network. This is no longer fulfilled by simple IP addresses, but for
example for JIDs when sending XML messages over a jabber server.</p>
</div>
<div class="refsect1">
<a name="InfXmlConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-xml-connection-open"></a><h3>inf_xml_connection_open ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_xml_connection_open (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Attempts to open the given XML connection. If the process fails, <em class="parameter"><code>error</code></em>
will be set. The connection needs to be in status
<a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSED:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSED</code></a> for this function to be called. Even if this
function succeeds, the connection process can fail later. In that case
the status of <em class="parameter"><code>connection</code></em>
will be reset to <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSED:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSED</code></a>
and the <a class="link" href="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal"><span class="type">“error”</span></a> signal will be emitted.</p>
<div class="refsect3">
<a name="inf-xml-connection-open.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>connection</p></td>
<td class="parameter_description"><p>A <span class="type">infXmlConnection</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-xml-connection-open.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on succes, or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xml-connection-close"></a><h3>inf_xml_connection_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xml_connection_close (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Closes the given connection.</p>
<div class="refsect3">
<a name="inf-xml-connection-close.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xml-connection-send"></a><h3>inf_xml_connection_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xml_connection_send (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Sends the given XML message to the remote host.</p>
<div class="refsect3">
<a name="inf-xml-connection-send.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>A XML message to send. The function takes ownership of the XML node.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xml-connection-sent"></a><h3>inf_xml_connection_sent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xml_connection_sent (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code>const <span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Emits the "sent" signal on <em class="parameter"><code>connection</code></em>
. This will most likely only be
useful to implementors.</p>
<div class="refsect3">
<a name="inf-xml-connection-sent.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The XML message that has been sent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xml-connection-received"></a><h3>inf_xml_connection_received ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xml_connection_received (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code>const <span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Emits the "received" signal on <em class="parameter"><code>connection</code></em>
. This will most likely only
be useful to implementors.</p>
<div class="refsect3">
<a name="inf-xml-connection-received.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The XML message that has been received.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xml-connection-error"></a><h3>inf_xml_connection_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xml_connection_error (<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<p>Emits the "error" signal on <em class="parameter"><code>connection</code></em>
. This will most likely only
be useful to implementors.</p>
<p>Note that the error may or may not be fatal for the connection. If it
is fatal, then a status notify to <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSING:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSING</code></a> or
<a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSED:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSED</code></a> will follow. If you are implementing a custom
class implementing <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>, make sure to always emit the "error"
signal before doing the status notify because many users of the connection
will release their reference when the connection is no longer connected.</p>
<div class="refsect3">
<a name="inf-xml-connection-error.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>The error that occured.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfXmlConnection-struct"></a><h3>InfXmlConnection</h3>
<pre class="programlisting">typedef struct _InfXmlConnection InfXmlConnection;</pre>
<p><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</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="InfXmlConnectionIface"></a><h3>struct InfXmlConnectionIface</h3>
<pre class="programlisting">struct InfXmlConnectionIface {
/* Virtual table */
gboolean (*open)(InfXmlConnection* connection,
GError** error);
void (*close)(InfXmlConnection* connection);
void (*send)(InfXmlConnection* connection,
xmlNodePtr xml);
/* Signals */
void (*sent)(InfXmlConnection* connection,
const xmlNodePtr xml);
void (*received)(InfXmlConnection* connection,
const xmlNodePtr xml);
void (*error)(InfXmlConnection* connection,
const GError* error);
};
</pre>
<p>Virtual functions and default signal handlers for the <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>
interface.</p>
<div class="refsect3">
<a name="InfXmlConnectionIface.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="InfXmlConnectionIface.open"></a>open</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to start the connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfXmlConnectionIface.close"></a>close</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to stop the connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfXmlConnectionIface.send"></a>send</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to transmit data over the connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfXmlConnectionIface.sent"></a>sent</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the <a class="link" href="InfXmlConnection.html#InfXmlConnection-sent" title="The “sent” signal"><span class="type">“sent”</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="InfXmlConnectionIface.received"></a>received</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the <a class="link" href="InfXmlConnection.html#InfXmlConnection-received" title="The “received” signal"><span class="type">“received”</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="InfXmlConnectionIface.error"></a>error</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the <a class="link" href="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal"><span class="type">“error”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnectionStatus"></a><h3>enum InfXmlConnectionStatus</h3>
<p>The possible connection status of an <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p>
<div class="refsect3">
<a name="InfXmlConnectionStatus.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-XML-CONNECTION-CLOSED:CAPS"></a>INF_XML_CONNECTION_CLOSED</p></td>
<td class="enum_member_description">
<p>The connection is currently not established.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XML-CONNECTION-CLOSING:CAPS"></a>INF_XML_CONNECTION_CLOSING</p></td>
<td class="enum_member_description">
<p>The connection is in the process of being
closed, no more data can be sent.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XML-CONNECTION-OPEN:CAPS"></a>INF_XML_CONNECTION_OPEN</p></td>
<td class="enum_member_description">
<p>The connection is up and data can be transmitted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XML-CONNECTION-OPENING:CAPS"></a>INF_XML_CONNECTION_OPENING</p></td>
<td class="enum_member_description">
<p>The connection is being established.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfXmlConnection--local-certificate"></a><h3>The <code class="literal">“local-certificate”</code> property</h3>
<pre class="programlisting"> “local-certificate” <span class="type">gpointer</span></pre>
<p>The X.509 certificate (gnutls_x509_crt_t) of the local site.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnection--local-id"></a><h3>The <code class="literal">“local-id”</code> property</h3>
<pre class="programlisting"> “local-id” <span class="type">gchar</span> *</pre>
<p>A unique identification on the network for the local site.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnection--network"></a><h3>The <code class="literal">“network”</code> property</h3>
<pre class="programlisting"> “network” <span class="type">gchar</span> *</pre>
<p>An identifier for the type of network this connection is on.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnection--remote-certificate"></a><h3>The <code class="literal">“remote-certificate”</code> property</h3>
<pre class="programlisting"> “remote-certificate” <a class="link" href="InfCertificateChain.html" title="InfCertificateChain"><span class="type">InfCertificateChain</span></a> *</pre>
<p>The X.509 certificate of the remote site.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnection--remote-id"></a><h3>The <code class="literal">“remote-id”</code> property</h3>
<pre class="programlisting"> “remote-id” <span class="type">gchar</span> *</pre>
<p>A unique identification on the network for the remote site.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmlConnection--status"></a><h3>The <code class="literal">“status”</code> property</h3>
<pre class="programlisting"> “status” <a class="link" href="InfXmlConnection.html#InfXmlConnectionStatus" title="enum InfXmlConnectionStatus"><span class="type">InfXmlConnectionStatus</span></a></pre>
<p>The status of the connection.</p>
<p>Flags: Read</p>
<p>Default value: INF_XML_CONNECTION_CLOSED</p>
</div>
</div>
<div class="refsect1">
<a name="InfXmlConnection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfXmlConnection-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="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">gpointer</span> error,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when an error occurs for this connection.
For example, if the connection cannot be established and the status
changes from <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-OPENING:CAPS"><code class="literal">INF_XML_CONNECTION_OPENING</code></a> to <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSED:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSED</code></a>,
then this signal is usually emitted with more details on the error.</p>
<p>Note however that the error may or may not be fatal for the
connection. If it is fatal, then a status notify to
<a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSING:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSING</code></a> or <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-CLOSED:CAPS"><code class="literal">INF_XML_CONNECTION_CLOSED</code></a> will follow.</p>
<div class="refsect3">
<a name="InfXmlConnection-error.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>connection</p></td>
<td class="parameter_description"><p>The erroneous <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A pointer to a <span class="type">GError</span> object with details on the error</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="InfXmlConnection-received"></a><h3>The <code class="literal">“received”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">gpointer</span> node,
<span class="type">gpointer</span> user_data)</pre>
<p>Signal which is emitted when an XML node has been received by this
connection.</p>
<div class="refsect3">
<a name="InfXmlConnection-received.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>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> through which <em class="parameter"><code>node</code></em>
has been received</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>An <span class="type">xmlNodePtr</span> refering to the XML node that has been received</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="InfXmlConnection-sent"></a><h3>The <code class="literal">“sent”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">gpointer</span> node,
<span class="type">gpointer</span> user_data)</pre>
<p>Signal which is emitted when an XML node has been successfully
transmitted with this connection.</p>
<div class="refsect3">
<a name="InfXmlConnection-sent.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>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> through which <em class="parameter"><code>node</code></em>
has been sent </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>An <span class="type">xmlNodePtr</span> refering to the XML node that has been sent</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 class="refsect1">
<a name="InfXmlConnection.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|