/usr/share/gtk-doc/html/libinfinity-0.6/InfTcpConnection.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 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 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfTcpConnection: 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="InfNameResolver.html" title="InfNameResolver">
<link rel="next" href="InfXmlConnection.html" title="InfXmlConnection">
<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="#InfTcpConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfTcpConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfTcpConnection.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfTcpConnection.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="InfNameResolver.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfXmlConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfTcpConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfTcpConnection.top_of_page"></a>InfTcpConnection</span></h2>
<p>InfTcpConnection — Represents a TCP-based connection to a remote host</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfTcpConnection.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="InfTcpConnection.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="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-new" title="inf_tcp_connection_new ()">inf_tcp_connection_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-new-and-open" title="inf_tcp_connection_new_and_open ()">inf_tcp_connection_new_and_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-new-resolve" title="inf_tcp_connection_new_resolve ()">inf_tcp_connection_new_resolve</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="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()">inf_tcp_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="InfTcpConnection.html#inf-tcp-connection-close" title="inf_tcp_connection_close ()">inf_tcp_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="InfTcpConnection.html#inf-tcp-connection-send" title="inf_tcp_connection_send ()">inf_tcp_connection_send</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="returnvalue">InfIpAddress</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-get-remote-address" title="inf_tcp_connection_get_remote_address ()">inf_tcp_connection_get_remote_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-get-remote-port" title="inf_tcp_connection_get_remote_port ()">inf_tcp_connection_get_remote_port</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTcpConnection.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">guint</span></td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--device-index" title="The “device-index” property">device-index</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--device-name" title="The “device-name” property">device-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *</td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--local-address" title="The “local-address” property">local-address</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--local-port" title="The “local-port” property">local-port</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *</td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-address" title="The “remote-address” property">remote-address</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-port" title="The “remote-port” property">remote-port</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfNameResolver.html" title="InfNameResolver"><span class="type">InfNameResolver</span></a> *</td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--resolver" title="The “resolver” property">resolver</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus" title="enum InfTcpConnectionStatus"><span class="type">InfTcpConnectionStatus</span></a></td>
<td class="property_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection--status" title="The “status” property">status</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTcpConnection.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="InfTcpConnection.html#InfTcpConnection-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="InfTcpConnection.html#InfTcpConnection-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="InfTcpConnection.html#InfTcpConnection-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="InfTcpConnection.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">enum</td>
<td class="function_name"><a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus" title="enum InfTcpConnectionStatus">InfTcpConnectionStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfTcpConnection.html#InfTcpConnection-struct" title="struct InfTcpConnection">InfTcpConnection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfTcpConnection.html#InfTcpConnectionClass" title="struct InfTcpConnectionClass">InfTcpConnectionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTcpConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GEnum
<span class="lineart">╰──</span> InfTcpConnectionStatus
GObject
<span class="lineart">╰──</span> InfTcpConnection
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-tcp-connection.h>
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.description"></a><h2>Description</h2>
<p><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> represents a TCP connection to a remove host. It is a
wrapper around a native socket object and integrates into the main loop
provided by <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>. An arbitrary amount of data can be sent with the
object, extra data will be buffered and automatically transmitted once
kernel space becomes available.</p>
<p>The TCP connection properties should be set and then
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()"><code class="function">inf_tcp_connection_open()</code></a> be called to open a connection. If the
<a class="link" href="InfTcpConnection.html#InfTcpConnection--resolver" title="The “resolver” property"><span class="type">“resolver”</span></a> property is set, then
<a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-address" title="The “remote-address” property"><span class="type">“remote-address”</span></a> and <a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-port" title="The “remote-port” property"><span class="type">“remote-port”</span></a> are
ignored, and the hostname as configured in the resolver will be resolved.
When the hostname has been resolved and a connection has been made, the
<a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-address" title="The “remote-address” property"><span class="type">“remote-address”</span></a> and <a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-port" title="The “remote-port” property"><span class="type">“remote-port”</span></a>
properties are updated to reflect the address actually connected to.</p>
</div>
<div class="refsect1">
<a name="InfTcpConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-tcp-connection-new"></a><h3>inf_tcp_connection_new ()</h3>
<pre class="programlisting"><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
inf_tcp_connection_new (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code>const <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *remote_addr</code></em>,
<em class="parameter"><code><span class="type">guint</span> remote_port</code></em>);</pre>
<p>Creates a new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>. The arguments are stored as properties for
an eventual <a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()"><code class="function">inf_tcp_connection_open()</code></a> call, this function itself does not
establish a connection.</p>
<div class="refsect3">
<a name="id-1.3.18.11.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to watch for activity.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_addr</p></td>
<td class="parameter_description"><p>The address to eventually connect to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_port</p></td>
<td class="parameter_description"><p>The port to eventually connect to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>. Free with <code class="function">g_object_unref()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-new-and-open"></a><h3>inf_tcp_connection_new_and_open ()</h3>
<pre class="programlisting"><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
inf_tcp_connection_new_and_open (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code>const <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *remote_addr</code></em>,
<em class="parameter"><code><span class="type">guint</span> remote_port</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates a new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> and connects it to the given TCP endpoint.
Like <a class="link" href="InfTcpConnection.html#inf-tcp-connection-new" title="inf_tcp_connection_new ()"><code class="function">inf_tcp_connection_new()</code></a>, but calls <a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()"><code class="function">inf_tcp_connection_open()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.18.11.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to watch for activity.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_addr</p></td>
<td class="parameter_description"><p>The address to connect to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_port</p></td>
<td class="parameter_description"><p>The port to connect to.</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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.3.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>, or <code class="literal">NULL</code> on error. Free with
<code class="function">g_object_unref()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-new-resolve"></a><h3>inf_tcp_connection_new_resolve ()</h3>
<pre class="programlisting"><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> *
inf_tcp_connection_new_resolve (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code><a class="link" href="InfNameResolver.html" title="InfNameResolver"><span class="type">InfNameResolver</span></a> *resolver</code></em>);</pre>
<p>Creates a new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> and instead of setting the remote IP
address and port number directly, a hostname resolver is used to look up
the remote hostname before connecting. This has the advantage that all
available addresses for that hostname are tried before giving up.</p>
<p>The argument is stored as a property for an eventual
<a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()"><code class="function">inf_tcp_connection_open()</code></a> call, this function itself does not
establish a connection.</p>
<div class="refsect3">
<a name="id-1.3.18.11.4.6"></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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to watch for activity.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resolver</p></td>
<td class="parameter_description"><p>The hostname resolver object used to look up the remote
hostname.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.4.7"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>. Free with <code class="function">g_object_unref()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-open"></a><h3>inf_tcp_connection_open ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_tcp_connection_open (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Attempts to open <em class="parameter"><code>connection</code></em>
. Make sure to have set the "remote-address"
and "remote-port" property before calling this function. If an error
occurs, the function returns <code class="literal">FALSE</code> and <em class="parameter"><code>error</code></em>
is set. Note however that
the connection might not be fully open when the function returns
(check the "status" property if you need to know). If an asynchronous
error occurs while the connection is being opened, the "error" signal
is emitted.</p>
<div class="refsect3">
<a name="id-1.3.18.11.5.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.5.6"></a><h4>Returns</h4>
<p> <code class="literal">FALSE</code> if an error occured and <code class="literal">TRUE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-close"></a><h3>inf_tcp_connection_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_tcp_connection_close (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);</pre>
<p>Closes a TCP connection that is either open or currently connecting.</p>
<div class="refsect3">
<a name="id-1.3.18.11.6.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-send"></a><h3>inf_tcp_connection_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_tcp_connection_send (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">guint</span> len</code></em>);</pre>
<p>Sends data through the TCP connection. The data is not sent immediately,
but enqueued to a buffer and will be sent as soon as kernel space
becomes available. The "sent" signal will be emitted when data has
really been sent.</p>
<div class="refsect3">
<a name="id-1.3.18.11.7.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> with status <a class="link" href="InfTcpConnection.html#INF-TCP-CONNECTION-CONNECTED:CAPS"><code class="literal">INF_TCP_CONNECTION_CONNECTED</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The data to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>Number of bytes to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-get-remote-address"></a><h3>inf_tcp_connection_get_remote_address ()</h3>
<pre class="programlisting"><a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="returnvalue">InfIpAddress</span></a> *
inf_tcp_connection_get_remote_address (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);</pre>
<p>Returns the IP address of the remote site.</p>
<div class="refsect3">
<a name="id-1.3.18.11.8.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.8.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> owned by <em class="parameter"><code>connection</code></em>
. You do not need to
free it, but need to make your own copy if you want to keep it longer than
<em class="parameter"><code>connection</code></em>
's lifetime.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-tcp-connection-get-remote-port"></a><h3>inf_tcp_connection_get_remote_port ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_tcp_connection_get_remote_port (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);</pre>
<p>Returns the port of the remote site to which <em class="parameter"><code>connection</code></em>
is (or was)
connected or connecting.</p>
<div class="refsect3">
<a name="id-1.3.18.11.9.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>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.18.11.9.6"></a><h4>Returns</h4>
<p> The port of the remote site.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfTcpConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfTcpConnectionStatus"></a><h3>enum InfTcpConnectionStatus</h3>
<p><a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus" title="enum InfTcpConnectionStatus"><span class="type">InfTcpConnectionStatus</span></a> specifies the connection status of a
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.18.12.2.4"></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-TCP-CONNECTION-CONNECTING:CAPS"></a>INF_TCP_CONNECTION_CONNECTING</p></td>
<td class="enum_member_description">
<p>A new connection is currently being
established.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-TCP-CONNECTION-CONNECTED:CAPS"></a>INF_TCP_CONNECTION_CONNECTED</p></td>
<td class="enum_member_description">
<p>The connection is ready to send and
receive data.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-TCP-CONNECTION-CLOSED:CAPS"></a>INF_TCP_CONNECTION_CLOSED</p></td>
<td class="enum_member_description">
<p>The connection is closed. Before data can be
transmitted, it needs to be opened with <a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()"><code class="function">inf_tcp_connection_open()</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection-struct"></a><h3>struct InfTcpConnection</h3>
<pre class="programlisting">struct InfTcpConnection;</pre>
<p><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</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="InfTcpConnectionClass"></a><h3>struct InfTcpConnectionClass</h3>
<pre class="programlisting">struct InfTcpConnectionClass {
/* Signals */
void (*sent)(InfTcpConnection* connection,
gconstpointer data,
guint len);
void (*received)(InfTcpConnection* connection,
gconstpointer data,
guint len);
void (*error)(InfTcpConnection* connection,
GError* error);
};
</pre>
<p>This structure contains the default signal handlers of <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.18.12.4.5"></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="InfTcpConnectionClass.sent"></a>sent</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfTcpConnection.html#InfTcpConnection-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="InfTcpConnectionClass.received"></a>received</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfTcpConnection.html#InfTcpConnection-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="InfTcpConnectionClass.error"></a>error</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfTcpConnection.html#InfTcpConnection-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>
</div>
<div class="refsect1">
<a name="InfTcpConnection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfTcpConnection--device-index"></a><h3>The <code class="literal">“device-index”</code> property</h3>
<pre class="programlisting"> “device-index” <span class="type">guint</span></pre>
<p>The index of the device to use for the connection.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--device-name"></a><h3>The <code class="literal">“device-name”</code> property</h3>
<pre class="programlisting"> “device-name” <span class="type">gchar</span> *</pre>
<p>The name of the device to use for the connection, such as `eth0'.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--io"></a><h3>The <code class="literal">“io”</code> property</h3>
<pre class="programlisting"> “io” <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</pre>
<p>I/O handler.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--local-address"></a><h3>The <code class="literal">“local-address”</code> property</h3>
<pre class="programlisting"> “local-address” <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *</pre>
<p>The local address of the connection.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--local-port"></a><h3>The <code class="literal">“local-port”</code> property</h3>
<pre class="programlisting"> “local-port” <span class="type">guint</span></pre>
<p>The local port of the connection.</p>
<p>Flags: Read</p>
<p>Allowed values: <= 65535</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--remote-address"></a><h3>The <code class="literal">“remote-address”</code> property</h3>
<pre class="programlisting"> “remote-address” <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a> *</pre>
<p>Address to connect to.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--remote-port"></a><h3>The <code class="literal">“remote-port”</code> property</h3>
<pre class="programlisting"> “remote-port” <span class="type">guint</span></pre>
<p>Port to connect to.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 65535</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--resolver"></a><h3>The <code class="literal">“resolver”</code> property</h3>
<pre class="programlisting"> “resolver” <a class="link" href="InfNameResolver.html" title="InfNameResolver"><span class="type">InfNameResolver</span></a> *</pre>
<p>The hostname resolver.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection--status"></a><h3>The <code class="literal">“status”</code> property</h3>
<pre class="programlisting"> “status” <a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus" title="enum InfTcpConnectionStatus"><span class="type">InfTcpConnectionStatus</span></a></pre>
<p>Status of the TCP connection.</p>
<p>Flags: Read</p>
<p>Default value: INF_TCP_CONNECTION_CLOSED</p>
</div>
</div>
<div class="refsect1">
<a name="InfTcpConnection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfTcpConnection-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="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</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 occured with the connection. If the
error is fatal, the connection will change its status to
<a class="link" href="InfTcpConnection.html#INF-TCP-CONNECTION-CLOSED:CAPS"><code class="literal">INF_TCP_CONNECTION_CLOSED</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.18.14.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>connection</p></td>
<td class="parameter_description"><p>The erroneous <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</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="InfTcpConnection-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="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection,
<span class="type">gpointer</span> data,
<span class="type">guint</span> length,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever data has been received from the
connection.</p>
<div class="refsect3">
<a name="id-1.3.18.14.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>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> through which the data has been
received.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A <span class="type">gpointer</span> refering to the data that has been received.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>A <span class="type">guint</span> holding the number of bytes 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="InfTcpConnection-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="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection,
<span class="type">gpointer</span> data,
<span class="type">guint</span> length,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever data has been sent over the connection.</p>
<div class="refsect3">
<a name="id-1.3.18.14.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>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> through which the data has been sent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A <span class="type">gpointer</span> refering to the data that has been sent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>A <span class="type">guint</span> holding the number of bytes 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>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|