/usr/share/proton-0.7/docs/api-c/a00054.html is in libqpid-proton2-dev-doc 0.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>proton: Selectable</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">proton
 <span id="projectnumber">0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Selectable</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gabd89005d4809b972caae64996ac43203"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00028.html#a88df1c6ca297e934378a24a8afc1c306">pn_iterator_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a></td></tr>
<tr class="memdesc:gabd89005d4809b972caae64996ac43203"><td class="mdescLeft"> </td><td class="mdescRight">An iterator for selectables. <a href="#gabd89005d4809b972caae64996ac43203">More...</a><br /></td></tr>
<tr class="separator:gabd89005d4809b972caae64996ac43203"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab7034170bf6367b989281d8ddaa87b09"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a></td></tr>
<tr class="memdesc:gab7034170bf6367b989281d8ddaa87b09"><td class="mdescLeft"> </td><td class="mdescRight">A selectable object provides an interface that can be used to incorporate proton's I/O into third party event loops. <a href="#gab7034170bf6367b989281d8ddaa87b09">More...</a><br /></td></tr>
<tr class="separator:gab7034170bf6367b989281d8ddaa87b09"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7595ef1175f76f8372271ace9fac1f6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga7595ef1175f76f8372271ace9fac1f6c">pn_selectables</a> (void)</td></tr>
<tr class="memdesc:ga7595ef1175f76f8372271ace9fac1f6c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new selectables iterator. <a href="#ga7595ef1175f76f8372271ace9fac1f6c">More...</a><br /></td></tr>
<tr class="separator:ga7595ef1175f76f8372271ace9fac1f6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d73786d6a3e2b3ebb3dd66ff8f7dba2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga5d73786d6a3e2b3ebb3dd66ff8f7dba2">pn_selectables_next</a> (<a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a> *selectables)</td></tr>
<tr class="memdesc:ga5d73786d6a3e2b3ebb3dd66ff8f7dba2"><td class="mdescLeft"> </td><td class="mdescRight">Get the next selectable from an iterator. <a href="#ga5d73786d6a3e2b3ebb3dd66ff8f7dba2">More...</a><br /></td></tr>
<tr class="separator:ga5d73786d6a3e2b3ebb3dd66ff8f7dba2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3c94bcdbb1fa4e43ef63db415d16b53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gab3c94bcdbb1fa4e43ef63db415d16b53">pn_selectables_free</a> (<a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a> *selectables)</td></tr>
<tr class="memdesc:gab3c94bcdbb1fa4e43ef63db415d16b53"><td class="mdescLeft"> </td><td class="mdescRight">Free a selectables iterator. <a href="#gab3c94bcdbb1fa4e43ef63db415d16b53">More...</a><br /></td></tr>
<tr class="separator:gab3c94bcdbb1fa4e43ef63db415d16b53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91a49b0f3cdb7c169cb0e66b84324341"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00024.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga91a49b0f3cdb7c169cb0e66b84324341">pn_selectable_fd</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga91a49b0f3cdb7c169cb0e66b84324341"><td class="mdescLeft"> </td><td class="mdescRight">Get the file descriptor associated with a selectable. <a href="#ga91a49b0f3cdb7c169cb0e66b84324341">More...</a><br /></td></tr>
<tr class="separator:ga91a49b0f3cdb7c169cb0e66b84324341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bf423890facdd6f72a343771681d9c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga8bf423890facdd6f72a343771681d9c6">pn_selectable_capacity</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga8bf423890facdd6f72a343771681d9c6"><td class="mdescLeft"> </td><td class="mdescRight">Get the capacity of a selectable. <a href="#ga8bf423890facdd6f72a343771681d9c6">More...</a><br /></td></tr>
<tr class="separator:ga8bf423890facdd6f72a343771681d9c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d2cea07c306401de710cab393c32fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga2d2cea07c306401de710cab393c32fbc">pn_selectable_pending</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga2d2cea07c306401de710cab393c32fbc"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes pending for a selectable. <a href="#ga2d2cea07c306401de710cab393c32fbc">More...</a><br /></td></tr>
<tr class="separator:ga2d2cea07c306401de710cab393c32fbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2146a8434652f66a0cefb4c050aa1cd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga2146a8434652f66a0cefb4c050aa1cd4">pn_selectable_deadline</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga2146a8434652f66a0cefb4c050aa1cd4"><td class="mdescLeft"> </td><td class="mdescRight">Get the next deadline for a selectable. <a href="#ga2146a8434652f66a0cefb4c050aa1cd4">More...</a><br /></td></tr>
<tr class="separator:ga2146a8434652f66a0cefb4c050aa1cd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6995acf52d96089dae30519d3d5b398a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga6995acf52d96089dae30519d3d5b398a">pn_selectable_readable</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga6995acf52d96089dae30519d3d5b398a"><td class="mdescLeft"> </td><td class="mdescRight">Notify a selectable that the file descriptor is readable. <a href="#ga6995acf52d96089dae30519d3d5b398a">More...</a><br /></td></tr>
<tr class="separator:ga6995acf52d96089dae30519d3d5b398a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabe97a97bb29ba60d7bc5bc1fa2b4b1af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gabe97a97bb29ba60d7bc5bc1fa2b4b1af">pn_selectable_writable</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:gabe97a97bb29ba60d7bc5bc1fa2b4b1af"><td class="mdescLeft"> </td><td class="mdescRight">Notify a selectable that the file descriptor is writable. <a href="#gabe97a97bb29ba60d7bc5bc1fa2b4b1af">More...</a><br /></td></tr>
<tr class="separator:gabe97a97bb29ba60d7bc5bc1fa2b4b1af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga695af605ead4986abcdf652cf962d75a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga695af605ead4986abcdf652cf962d75a">pn_selectable_expired</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga695af605ead4986abcdf652cf962d75a"><td class="mdescLeft"> </td><td class="mdescRight">Notify a selectable that its deadline has expired. <a href="#ga695af605ead4986abcdf652cf962d75a">More...</a><br /></td></tr>
<tr class="separator:ga695af605ead4986abcdf652cf962d75a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf2d8b01aa4135e5c2180433889c1a8b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gaf2d8b01aa4135e5c2180433889c1a8b7">pn_selectable_is_registered</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:gaf2d8b01aa4135e5c2180433889c1a8b7"><td class="mdescLeft"> </td><td class="mdescRight">Check if a selectable is registered. <a href="#gaf2d8b01aa4135e5c2180433889c1a8b7">More...</a><br /></td></tr>
<tr class="separator:gaf2d8b01aa4135e5c2180433889c1a8b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga863a4c0fd0ea5cc83d5227647495d6c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga863a4c0fd0ea5cc83d5227647495d6c2">pn_selectable_set_registered</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable, bool registered)</td></tr>
<tr class="memdesc:ga863a4c0fd0ea5cc83d5227647495d6c2"><td class="mdescLeft"> </td><td class="mdescRight">Set the registered flag for a selectable. <a href="#ga863a4c0fd0ea5cc83d5227647495d6c2">More...</a><br /></td></tr>
<tr class="separator:ga863a4c0fd0ea5cc83d5227647495d6c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61382d23348378e41b4a474ca33f5bf7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ga61382d23348378e41b4a474ca33f5bf7">pn_selectable_is_terminal</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:ga61382d23348378e41b4a474ca33f5bf7"><td class="mdescLeft"> </td><td class="mdescRight">Check if a selectable is in the terminal state. <a href="#ga61382d23348378e41b4a474ca33f5bf7">More...</a><br /></td></tr>
<tr class="separator:ga61382d23348378e41b4a474ca33f5bf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaea1eb47248399c5e6fe6790cef85dab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#gaea1eb47248399c5e6fe6790cef85dab9">pn_selectable_free</a> (<a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> *selectable)</td></tr>
<tr class="memdesc:gaea1eb47248399c5e6fe6790cef85dab9"><td class="mdescLeft"> </td><td class="mdescRight">Free a selectable object. <a href="#gaea1eb47248399c5e6fe6790cef85dab9">More...</a><br /></td></tr>
<tr class="separator:gaea1eb47248399c5e6fe6790cef85dab9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gab7034170bf6367b989281d8ddaa87b09"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> <a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A selectable object provides an interface that can be used to incorporate proton's I/O into third party event loops. </p>
<p>Every selectable is associated with exactly one file descriptor. Selectables may be interested in three kinds of events, read events, write events, and timer events. A selectable will express its interest in these events through the <a class="el" href="a00054.html#ga8bf423890facdd6f72a343771681d9c6" title="Get the capacity of a selectable. ">pn_selectable_capacity()</a>, <a class="el" href="a00054.html#ga2d2cea07c306401de710cab393c32fbc" title="Get the number of bytes pending for a selectable. ">pn_selectable_pending()</a>, and <a class="el" href="a00054.html#ga2146a8434652f66a0cefb4c050aa1cd4" title="Get the next deadline for a selectable. ">pn_selectable_deadline()</a> calls.</p>
<p>When a read, write, or timer event occurs, the selectable must be notified by calling <a class="el" href="a00054.html#ga6995acf52d96089dae30519d3d5b398a" title="Notify a selectable that the file descriptor is readable. ">pn_selectable_readable()</a>, <a class="el" href="a00054.html#gabe97a97bb29ba60d7bc5bc1fa2b4b1af" title="Notify a selectable that the file descriptor is writable. ">pn_selectable_writable()</a>, and <a class="el" href="a00054.html#ga695af605ead4986abcdf652cf962d75a" title="Notify a selectable that its deadline has expired. ">pn_selectable_expired()</a> as appropriate.</p>
<p>Once a selectable reaches a terminal state (see <a class="el" href="a00054.html#ga61382d23348378e41b4a474ca33f5bf7" title="Check if a selectable is in the terminal state. ">pn_selectable_is_terminal()</a>), it will never be interested in events of any kind. When this occurs it should be removed from the external event loop and discarded using <a class="el" href="a00054.html#gaea1eb47248399c5e6fe6790cef85dab9" title="Free a selectable object. ">pn_selectable_free()</a>. </p>
</div>
</div>
<a class="anchor" id="gabd89005d4809b972caae64996ac43203"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00028.html#a88df1c6ca297e934378a24a8afc1c306">pn_iterator_t</a> <a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator for selectables. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8bf423890facdd6f72a343771681d9c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_selectable_capacity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the capacity of a selectable. </p>
<p>A selectable with a positive capacity is interested in being notified of read events. A negative capacity indicates that the selectable will never be interested in read events ever again.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the selectables capacity </dd></dl>
</div>
</div>
<a class="anchor" id="ga2146a8434652f66a0cefb4c050aa1cd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> pn_selectable_deadline </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next deadline for a selectable. </p>
<p>A selectable with a deadline is interested in being notified when that deadline expires. Zero indicates there is currently no deadline.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the next deadline or zero </dd></dl>
</div>
</div>
<a class="anchor" id="ga695af605ead4986abcdf652cf962d75a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectable_expired </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify a selectable that its deadline has expired. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga91a49b0f3cdb7c169cb0e66b84324341"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00024.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> pn_selectable_fd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the file descriptor associated with a selectable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the file descriptor associated with the selectable </dd></dl>
</div>
</div>
<a class="anchor" id="gaea1eb47248399c5e6fe6790cef85dab9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectable_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a selectable object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object (or NULL) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf2d8b01aa4135e5c2180433889c1a8b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_selectable_is_registered </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a selectable is registered. </p>
<p>This flag is set via <a class="el" href="a00054.html#ga863a4c0fd0ea5cc83d5227647495d6c2" title="Set the registered flag for a selectable. ">pn_selectable_set_registered()</a> and can be used for tracking whether a given selectable has been registerd with an external event loop.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the selectable is registered </dd></dl>
</div>
</div>
<a class="anchor" id="ga61382d23348378e41b4a474ca33f5bf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_selectable_is_terminal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a selectable is in the terminal state. </p>
<p>A selectable that is in the terminal state will never be interested in being notified of events of any kind ever again. Once a selectable reaches this state it should be removed from any external I/O loops and freed in order to reclaim any resources associated with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the selectable is in the terminal state, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga2d2cea07c306401de710cab393c32fbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_selectable_pending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of bytes pending for a selectable. </p>
<p>A selectable with pending bytes is interested in being notified of write events. If this value is negative then the selectable will never be interested in write events ever again.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes pending for the selectable </dd></dl>
</div>
</div>
<a class="anchor" id="ga6995acf52d96089dae30519d3d5b398a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectable_readable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify a selectable that the file descriptor is readable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga863a4c0fd0ea5cc83d5227647495d6c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectable_set_registered </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>registered</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the registered flag for a selectable. </p>
<p>See <a class="el" href="a00054.html#gaf2d8b01aa4135e5c2180433889c1a8b7" title="Check if a selectable is registered. ">pn_selectable_is_registered()</a> for details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">registered</td><td>the registered flag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabe97a97bb29ba60d7bc5bc1fa2b4b1af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectable_writable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a> * </td>
<td class="paramname"><em>selectable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify a selectable that the file descriptor is writable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectable</td><td>a selectable object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7595ef1175f76f8372271ace9fac1f6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a>* pn_selectables </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new selectables iterator. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a new selectables iterator </dd></dl>
</div>
</div>
<a class="anchor" id="gab3c94bcdbb1fa4e43ef63db415d16b53"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_selectables_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a> * </td>
<td class="paramname"><em>selectables</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a selectables iterator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectables</td><td>a selectables iterator (or NULL) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5d73786d6a3e2b3ebb3dd66ff8f7dba2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00054.html#gab7034170bf6367b989281d8ddaa87b09">pn_selectable_t</a>* pn_selectables_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00054.html#gabd89005d4809b972caae64996ac43203">pn_selectables_t</a> * </td>
<td class="paramname"><em>selectables</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next selectable from an iterator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">selectables</td><td>a selectable iterator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the next selectable from the iterator </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 17 2014 10:28:04 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|