/usr/share/gtk-doc/html/libinfinity-0.6/InfIo.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfIo: 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="InfXmppManager.html" title="InfXmppManager">
<link rel="next" href="InfStandaloneIo.html" title="InfStandaloneIo">
<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="#InfIo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfIo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#InfIo.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#InfIo.implementations" class="shortcut">Known Implementations</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="InfXmppManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfStandaloneIo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfIo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfIo.top_of_page"></a>InfIo</span></h2>
<p>InfIo — Event loop abstraction</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfIo.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="InfIo.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">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfIo.html#InfIoWatchFunc" title="InfIoWatchFunc ()">*InfIoWatchFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfIo.html#InfIoTimeoutFunc" title="InfIoTimeoutFunc ()">*InfIoTimeoutFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfIo.html#InfIoDispatchFunc" title="InfIoDispatchFunc ()">*InfIoDispatchFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="returnvalue">InfIoWatch</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfIo.html#inf-io-add-watch" title="inf_io_add_watch ()">inf_io_add_watch</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="InfIo.html#inf-io-update-watch" title="inf_io_update_watch ()">inf_io_update_watch</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="InfIo.html#inf-io-remove-watch" title="inf_io_remove_watch ()">inf_io_remove_watch</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfIo.html#InfIoTimeout" title="InfIoTimeout"><span class="returnvalue">InfIoTimeout</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfIo.html#inf-io-add-timeout" title="inf_io_add_timeout ()">inf_io_add_timeout</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="InfIo.html#inf-io-remove-timeout" title="inf_io_remove_timeout ()">inf_io_remove_timeout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfIo.html#InfIoDispatch" title="InfIoDispatch"><span class="returnvalue">InfIoDispatch</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfIo.html#inf-io-add-dispatch" title="inf_io_add_dispatch ()">inf_io_add_dispatch</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="InfIo.html#inf-io-remove-dispatch" title="inf_io_remove_dispatch ()">inf_io_remove_dispatch</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfIo.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="InfIo.html#InfIo-struct" title="InfIo">InfIo</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfIo.html#InfIoIface" title="struct InfIoIface">InfIoIface</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="InfIo.html#InfNativeSocket" title="InfNativeSocket">InfNativeSocket</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfIo.html#InfIoEvent" title="enum InfIoEvent">InfIoEvent</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfIo.html#InfIoWatch" title="InfIoWatch">InfIoWatch</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfIo.html#InfIoTimeout" title="InfIoTimeout">InfIoTimeout</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfIo.html#InfIoDispatch" title="InfIoDispatch">InfIoDispatch</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfIo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
<span class="lineart">╰──</span> InfIoEvent
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> InfIo
</pre>
</div>
<div class="refsect1">
<a name="InfIo.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfIo requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfIo.implementations"></a><h2>Known Implementations</h2>
<p>
InfIo is implemented by
<a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo">InfStandaloneIo</a>.</p>
</div>
<div class="refsect1">
<a name="InfIo.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-io.h>
</pre>
</div>
<div class="refsect1">
<a name="InfIo.description"></a><h2>Description</h2>
<p>The <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> interface is used to schedule timeouts and to watch sockets for
events to occur. An actual implementation usually integrates this into the
application main loop, such as <span class="type">GMainLoop</span>. There is also a standalone
implementation, <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>, that can directly be used as the
application's main loop.</p>
<p>Every object in Libinfinity that needs to schedule timeouts or watches
sockets uses a InfIo to do so. This allows to use libinfinity with
different main event loops, not only Glib's one.</p>
<p><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> is guaranteed to be thread-safe. All functions can be called from
any thread at any time. However, all callback functions are always called
from the same thread (normally the one running the main loop).</p>
</div>
<div class="refsect1">
<a name="InfIo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfIoWatchFunc"></a><h3>InfIoWatchFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfIoWatchFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="InfIo.html#InfNativeSocket" title="InfNativeSocket"><span class="type">InfNativeSocket</span></a> *socket</code></em>,
<em class="parameter"><code><a class="link" href="InfIo.html#InfIoEvent" title="enum InfIoEvent"><span class="type">InfIoEvent</span></a> event</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Callback function that is called when an event occurs on a watched socket.</p>
<div class="refsect3">
<a name="InfIoWatchFunc.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>socket</p></td>
<td class="parameter_description"><p>The socket on which an event occured.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>A bitmask of the events that occured.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-defined data specified in <a class="link" href="InfIo.html#inf-io-add-watch" title="inf_io_add_watch ()"><code class="function">inf_io_add_watch()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfIoTimeoutFunc"></a><h3>InfIoTimeoutFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfIoTimeoutFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Callback function that is called when a timeout has elapsed.</p>
<div class="refsect3">
<a name="InfIoTimeoutFunc.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>user_data</p></td>
<td class="parameter_description"><p>User-defined data specified in <a class="link" href="InfIo.html#inf-io-add-timeout" title="inf_io_add_timeout ()"><code class="function">inf_io_add_timeout()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfIoDispatchFunc"></a><h3>InfIoDispatchFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfIoDispatchFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Callback function that is called when a dispatch is executed by the thread
that runs <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p>
<div class="refsect3">
<a name="InfIoDispatchFunc.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>user_data</p></td>
<td class="parameter_description"><p>User-defined data specified in <a class="link" href="InfIo.html#inf-io-add-dispatch" title="inf_io_add_dispatch ()"><code class="function">inf_io_add_dispatch()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-add-watch"></a><h3>inf_io_add_watch ()</h3>
<pre class="programlisting"><a class="link" href="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="returnvalue">InfIoWatch</span></a> *
inf_io_add_watch (<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="InfIo.html#InfNativeSocket" title="InfNativeSocket"><span class="type">InfNativeSocket</span></a> *socket</code></em>,
<em class="parameter"><code><a class="link" href="InfIo.html#InfIoEvent" title="enum InfIoEvent"><span class="type">InfIoEvent</span></a> events</code></em>,
<em class="parameter"><code><a class="link" href="InfIo.html#InfIoWatchFunc" title="InfIoWatchFunc ()"><span class="type">InfIoWatchFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>Monitors the given socket for activity and calls <em class="parameter"><code>func</code></em>
if one of the
events specified in <em class="parameter"><code>events</code></em>
occurs.</p>
<div class="refsect3">
<a name="inf-io-add-watch.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>socket</p></td>
<td class="parameter_description"><p>The socket to watch.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>events</p></td>
<td class="parameter_description"><p>Events to watch for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>Function to be called when one of the events occurs.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Extra data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> that is called when <em class="parameter"><code>user_data</code></em>
is no longer
needed, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-io-add-watch.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="type">InfIoWatch</span></a> that can be used to update or remove the watch.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-update-watch"></a><h3>inf_io_update_watch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_io_update_watch (<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="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="type">InfIoWatch</span></a> *watch</code></em>,
<em class="parameter"><code><a class="link" href="InfIo.html#InfIoEvent" title="enum InfIoEvent"><span class="type">InfIoEvent</span></a> events</code></em>);</pre>
<p>Changes the events that the socket bound to <em class="parameter"><code>watch</code></em>
is being watched for.
The callback of <em class="parameter"><code>watch</code></em>
will only be called if one of the newly watched for
events occurs.</p>
<div class="refsect3">
<a name="inf-io-update-watch.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>watch</p></td>
<td class="parameter_description"><p>The watch to update, as returned by <a class="link" href="InfIo.html#inf-io-add-watch" title="inf_io_add_watch ()"><code class="function">inf_io_add_watch()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>events</p></td>
<td class="parameter_description"><p>The new events to watch for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-remove-watch"></a><h3>inf_io_remove_watch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_io_remove_watch (<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="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="type">InfIoWatch</span></a> *watch</code></em>);</pre>
<p>Removes <em class="parameter"><code>watch</code></em>
from <em class="parameter"><code>io</code></em>
and releases all resources allocated for the watch.
Events are no longer looked for on the socket.</p>
<div class="refsect3">
<a name="inf-io-remove-watch.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>watch</p></td>
<td class="parameter_description"><p>The watch to remove, as returned by <a class="link" href="InfIo.html#inf-io-add-watch" title="inf_io_add_watch ()"><code class="function">inf_io_add_watch()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-add-timeout"></a><h3>inf_io_add_timeout ()</h3>
<pre class="programlisting"><a class="link" href="InfIo.html#InfIoTimeout" title="InfIoTimeout"><span class="returnvalue">InfIoTimeout</span></a> *
inf_io_add_timeout (<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><span class="type">guint</span> msecs</code></em>,
<em class="parameter"><code><a class="link" href="InfIo.html#InfIoTimeoutFunc" title="InfIoTimeoutFunc ()"><span class="type">InfIoTimeoutFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>Calls <em class="parameter"><code>func</code></em>
after at least <em class="parameter"><code>msecs</code></em>
milliseconds have elapsed. The timeout
is removed after it has elapsed.</p>
<div class="refsect3">
<a name="inf-io-add-timeout.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>msecs</p></td>
<td class="parameter_description"><p>Number of milliseconds after which the timeout should be elapsed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>Function to be called when the timeout elapsed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Extra data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> that is called when <em class="parameter"><code>user_data</code></em>
is no longer
needed, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-io-add-timeout.returns"></a><h4>Returns</h4>
<p> A timeout handle that can be used to remove the timeout.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-remove-timeout"></a><h3>inf_io_remove_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_io_remove_timeout (<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="InfIo.html#InfIoTimeout" title="InfIoTimeout"><span class="type">InfIoTimeout</span></a> *timeout</code></em>);</pre>
<p>Removes the given timeout.</p>
<div class="refsect3">
<a name="inf-io-remove-timeout.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout</p></td>
<td class="parameter_description"><p>A timeout handle obtained from <a class="link" href="InfIo.html#inf-io-add-timeout" title="inf_io_add_timeout ()"><code class="function">inf_io_add_timeout()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-add-dispatch"></a><h3>inf_io_add_dispatch ()</h3>
<pre class="programlisting"><a class="link" href="InfIo.html#InfIoDispatch" title="InfIoDispatch"><span class="returnvalue">InfIoDispatch</span></a> *
inf_io_add_dispatch (<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="InfIo.html#InfIoDispatchFunc" title="InfIoDispatchFunc ()"><span class="type">InfIoDispatchFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>Schedules <em class="parameter"><code>func</code></em>
to be called by the thread <em class="parameter"><code>io</code></em>
runs in. This function can
be used from a different thread to communicate to <em class="parameter"><code>io</code></em>
's thread.</p>
<div class="refsect3">
<a name="inf-io-add-dispatch.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>Function to be called when the function is dispatched.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Extra data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> that is called when <em class="parameter"><code>user_data</code></em>
is no longer
needed, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-io-add-dispatch.returns"></a><h4>Returns</h4>
<p> A dispatch handle that can be used to stop the dispatched function
from being called as long as it has not yet been called.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-io-remove-dispatch"></a><h3>inf_io_remove_dispatch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_io_remove_dispatch (<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="InfIo.html#InfIoDispatch" title="InfIoDispatch"><span class="type">InfIoDispatch</span></a> *dispatch</code></em>);</pre>
<p>Removes the given dispatch from <em class="parameter"><code>io</code></em>
so that it is not called.</p>
<div class="refsect3">
<a name="inf-io-remove-dispatch.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dispatch</p></td>
<td class="parameter_description"><p>A dispatch handle obtained from <a class="link" href="InfIo.html#inf-io-add-dispatch" title="inf_io_add_dispatch ()"><code class="function">inf_io_add_dispatch()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfIo.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfIo-struct"></a><h3>InfIo</h3>
<pre class="programlisting">typedef struct _InfIo InfIo;</pre>
<p><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</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="InfIoIface"></a><h3>struct InfIoIface</h3>
<pre class="programlisting">struct InfIoIface {
InfIoWatch* (*add_watch)(InfIo* io,
InfNativeSocket* socket,
InfIoEvent events,
InfIoWatchFunc func,
gpointer user_data,
GDestroyNotify notify);
void (*update_watch)(InfIo* io,
InfIoWatch* watch,
InfIoEvent events);
void (*remove_watch)(InfIo* io,
InfIoWatch* watch);
InfIoTimeout* (*add_timeout)(InfIo* io,
guint msecs,
InfIoTimeoutFunc func,
gpointer user_data,
GDestroyNotify notify);
void (*remove_timeout)(InfIo* io,
InfIoTimeout* timeout);
InfIoDispatch* (*add_dispatch)(InfIo* io,
InfIoDispatchFunc func,
gpointer user_data,
GDestroyNotify notify);
void (*remove_dispatch)(InfIo* io,
InfIoDispatch* dispatch);
};
</pre>
<p>The virtual methods of <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>. These allow to set up socket watches,
timeouts and function dispatchers. All of these functions need to be
thread-safe.</p>
<div class="refsect3">
<a name="InfIoIface.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="InfIoIface.add-watch"></a>add_watch</code></em> ()</p></td>
<td class="struct_member_description"><p>Watches a socket for events to occur in which case <em class="parameter"><code>func</code></em>
is
called.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.update-watch"></a>update_watch</code></em> ()</p></td>
<td class="struct_member_description"><p>Updates a watch on a socket so that a different set of
events is watched for.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.remove-watch"></a>remove_watch</code></em> ()</p></td>
<td class="struct_member_description"><p>Removes a watch on a socket.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.add-timeout"></a>add_timeout</code></em> ()</p></td>
<td class="struct_member_description"><p>Schedules <em class="parameter"><code>func</code></em>
to be called at least <em class="parameter"><code>msecs</code></em>
milliseconds
in the future.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.remove-timeout"></a>remove_timeout</code></em> ()</p></td>
<td class="struct_member_description"><p>Removes a scheduled timeout again. The timeout is
removed automatically when it has elapsed, so there is no need to call
this function in that case.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.add-dispatch"></a>add_dispatch</code></em> ()</p></td>
<td class="struct_member_description"><p>Schedules <em class="parameter"><code>func</code></em>
to be called by the thread the <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>
runs in.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfIoIface.remove-dispatch"></a>remove_dispatch</code></em> ()</p></td>
<td class="struct_member_description"><p>Removes a scheduled dispatch. This can be called as long
as the scheduled function has not yet been called.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfNativeSocket"></a><h3>InfNativeSocket</h3>
<pre class="programlisting">typedef SOCKET InfNativeSocket;
</pre>
<p>Native socket type on the target platform. This typedef is a simple <span class="type">int</span>
on Unix and a <span class="type">SOCKET</span> on Windows.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfIoEvent"></a><h3>enum InfIoEvent</h3>
<p>This enumeration specifies events that can be watched.</p>
<div class="refsect3">
<a name="InfIoEvent.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-IO-INCOMING:CAPS"></a>INF_IO_INCOMING</p></td>
<td class="enum_member_description">
<p>Data can be read from the socket without blocking, or
the connection has been closed (which is the case when <code class="function">recv()</code> returns 0).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-IO-OUTGOING:CAPS"></a>INF_IO_OUTGOING</p></td>
<td class="enum_member_description">
<p>Data can be sent without blocking.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-IO-ERROR:CAPS"></a>INF_IO_ERROR</p></td>
<td class="enum_member_description">
<p>An error with the socket occured, or the connection has
been closed. Use <code class="function">getsockopt()</code> to read the <code class="literal">SO_ERROR</code> option to find out what
the problem is.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfIoWatch"></a><h3>InfIoWatch</h3>
<pre class="programlisting">typedef struct _InfIoWatch InfIoWatch;</pre>
<p><a class="link" href="InfIo.html#InfIoWatch" title="InfIoWatch"><span class="type">InfIoWatch</span></a> represents a watch on a <a class="link" href="InfIo.html#InfNativeSocket" title="InfNativeSocket"><span class="type">InfNativeSocket</span></a> for events to occur.
It is an opaque data type. You should only access it via the public
API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfIoTimeout"></a><h3>InfIoTimeout</h3>
<pre class="programlisting">typedef struct _InfIoTimeout InfIoTimeout;</pre>
<p><a class="link" href="InfIo.html#InfIoTimeout" title="InfIoTimeout"><span class="type">InfIoTimeout</span></a> represents a timer which will call a specified function in
the future. It is an opaque data type. You should only access it via the
public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfIoDispatch"></a><h3>InfIoDispatch</h3>
<pre class="programlisting">typedef struct _InfIoDispatch InfIoDispatch;</pre>
<p><a class="link" href="InfIo.html#InfIoDispatch" title="InfIoDispatch"><span class="type">InfIoDispatch</span></a> represents a function to be called by the thread executing
the <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object. It is an opaque data type. You should only access it
via the public API functions.</p>
</div>
</div>
<div class="refsect1">
<a name="InfIo.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|