/usr/share/gtk-doc/html/libinfinity-0.5/InfTcpConnection.html is in libinfinity-0.5-doc 0.5.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfIpAddress.html" title="InfIpAddress">
<link rel="next" href="InfXmlConnection.html" title="InfXmlConnection">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfIpAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfXmlConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfTcpConnection.synopsis" class="shortcut">Top</a>
|
<a href="#InfTcpConnection.description" class="shortcut">Description</a>
|
<a href="#InfTcpConnection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfTcpConnection.properties" class="shortcut">Properties</a>
|
<a href="#InfTcpConnection.signals" class="shortcut">Signals</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</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InfTcpConnection.synopsis"></a><h2>Synopsis</h2>
<a name="InfTcpConnectionStatus"></a><pre class="synopsis">enum <a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus-enum" title="enum InfTcpConnectionStatus">InfTcpConnectionStatus</a>;
<a class="link" href="InfTcpConnection.html#InfTcpConnection-struct" title="InfTcpConnection">InfTcpConnection</a>;
struct <a class="link" href="InfTcpConnection.html#InfTcpConnectionClass" title="struct InfTcpConnectionClass">InfTcpConnectionClass</a>;
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> * <a class="link" href="InfTcpConnection.html#inf-tcp-connection-new" title="inf_tcp_connection_new ()">inf_tcp_connection_new</a> (<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="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>);
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="returnvalue">InfTcpConnection</span></a> * <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> (<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="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>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTcpConnection.html#inf-tcp-connection-open" title="inf_tcp_connection_open ()">inf_tcp_connection_open</a> (<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>);
<span class="returnvalue">void</span> <a class="link" href="InfTcpConnection.html#inf-tcp-connection-close" title="inf_tcp_connection_close ()">inf_tcp_connection_close</a> (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTcpConnection.html#inf-tcp-connection-send" title="inf_tcp_connection_send ()">inf_tcp_connection_send</a> (<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>);
<a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="returnvalue">InfIpAddress</span></a> * <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>
(<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);
<span class="returnvalue">guint</span> <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> (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *connection</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GEnum
+----InfTcpConnectionStatus
</pre>
<pre class="synopsis">
GObject
+----InfTcpConnection
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--device-index" title='The "device-index" property'>device-index</a>" <span class="type">guint</span> : Read / Write
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--device-name" title='The "device-name" property'>device-name</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--io" title='The "io" property'>io</a>" <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>* : Read / Write / Construct Only
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--local-address" title='The "local-address" property'>local-address</a>" <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a>* : Read
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--local-port" title='The "local-port" property'>local-port</a>" <span class="type">guint</span> : Read
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-address" title='The "remote-address" property'>remote-address</a>" <a class="link" href="InfIpAddress.html" title="InfIpAddress"><span class="type">InfIpAddress</span></a>* : Read / Write
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--remote-port" title='The "remote-port" property'>remote-port</a>" <span class="type">guint</span> : Read / Write
"<a class="link" href="InfTcpConnection.html#InfTcpConnection--status" title='The "status" property'>status</a>" <a class="link" href="InfTcpConnection.html#InfTcpConnectionStatus"><span class="type">InfTcpConnectionStatus</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="InfTcpConnection.html#InfTcpConnection-error" title='The "error" signal'>error</a>" : <code class="literal">Run Last</code>
"<a class="link" href="InfTcpConnection.html#InfTcpConnection-received" title='The "received" signal'>received</a>" : <code class="literal">Run Last</code>
"<a class="link" href="InfTcpConnection.html#InfTcpConnection-sent" title='The "sent" signal'>sent</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="InfTcpConnection.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="InfTcpConnection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfTcpConnectionStatus-enum"></a><h3>enum InfTcpConnectionStatus</h3>
<pre class="programlisting">typedef enum {
INF_TCP_CONNECTION_CONNECTING,
INF_TCP_CONNECTION_CONNECTED,
INF_TCP_CONNECTION_CLOSED
} InfTcpConnectionStatus;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="INF-TCP-CONNECTION-CONNECTING:CAPS"></a><span class="term"><code class="literal">INF_TCP_CONNECTION_CONNECTING</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="INF-TCP-CONNECTION-CONNECTED:CAPS"></a><span class="term"><code class="literal">INF_TCP_CONNECTION_CONNECTED</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="INF-TCP-CONNECTION-CLOSED:CAPS"></a><span class="term"><code class="literal">INF_TCP_CONNECTION_CLOSED</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnection-struct"></a><h3>InfTcpConnection</h3>
<pre class="programlisting">typedef struct _InfTcpConnection InfTcpConnection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTcpConnectionClass"></a><h3>struct InfTcpConnectionClass</h3>
<pre class="programlisting">struct InfTcpConnectionClass {
GObjectClass parent_class;
/* 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>
</p>
</div>
<hr>
<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><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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>io</code></em> :</span></p></td>
<td>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to watch for activity.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remote_addr</code></em> :</span></p></td>
<td>The address to eventually connect to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remote_port</code></em> :</span></p></td>
<td>The port to eventually connect to.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>. Free with <code class="function">g_object_unref()</code>.</td>
</tr>
</tbody>
</table></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><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 inf_tcp_connection_new, 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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>io</code></em> :</span></p></td>
<td>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to watch for activity.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remote_addr</code></em> :</span></p></td>
<td>The address to connect to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remote_port</code></em> :</span></p></td>
<td>The port to connect to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="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>.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">FALSE</code> if an error occured and <code class="literal">TRUE</code> otherwise.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</td>
</tr></tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>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>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The data to send.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>Number of bytes to send.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The port of the remote site.</td>
</tr>
</tbody>
</table></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> : Read / Write</pre>
<p>The index of the device to use for the connection.</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>* : Read / Write</pre>
<p>The name of the device to use for the connection, such as `eth0'.</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>* : Read / Write / Construct Only</pre>
<p>I/O handler.</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>* : Read</pre>
<p>The local address of the connection.</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> : Read</pre>
<p>The local port of the connection.</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>* : Read / Write</pre>
<p>Address to connect to.</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> : Read / Write</pre>
<p>Port to connect to.</p>
<p>Allowed values: <= 65535</p>
<p>Default value: 0</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"><span class="type">InfTcpConnectionStatus</span></a> : Read</pre>
<p>Status of the TCP connection.</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) : <code class="literal">Run Last</code></pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The erroneous <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <span class="type">GError</span> object with details on the error</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<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) : <code class="literal">Run Last</code></pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> through which the data has been received</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>A <span class="type">gpointer</span> refering to the data that has been received</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>A <span class="type">guint</span> holding the number of bytes that has been received</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<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) : <code class="literal">Run Last</code></pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> through which the data has been sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>A <span class="type">gpointer</span> refering to the data that has been sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>A <span class="type">guint</span> holding the number of bytes that has been sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|