| <!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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C API: proton/selectable.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C API |
|  <span id="projectnumber">0.25.0</span> |
| </div> |
| </td> |
| <td> <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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('selectable_8h_source.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </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="headertitle"> |
| <div class="title">selectable.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_SELECTABLE_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SELECTABLE_H 1</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <proton/object.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="event_8h.html">proton/event.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <proton/type_compat.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">typedef</span> pn_iterator_t pn_selectables_t;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#if defined(_WIN32) && ! defined(__CYGWIN__)</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#ifdef _WIN64</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> __int64 pn_socket_t;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pn_socket_t;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define PN_INVALID_SOCKET (pn_socket_t)(~0)</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> pn_socket_t;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define PN_INVALID_SOCKET (-1)</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>pn_selectable_t pn_selectable_t;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> PNX_EXTERN pn_selectables_t *pn_selectables(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> PNX_EXTERN pn_selectable_t *pn_selectables_next(pn_selectables_t *selectables);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectables_free(pn_selectables_t *selectables);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> PNX_EXTERN pn_selectable_t *pn_selectable(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_readable(pn_selectable_t *sel, <span class="keywordtype">void</span> (*readable)(pn_selectable_t *));</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_writable(pn_selectable_t *sel, <span class="keywordtype">void</span> (*writable)(pn_selectable_t *));</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_expired(pn_selectable_t *sel, <span class="keywordtype">void</span> (*expired)(pn_selectable_t *));</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_error(pn_selectable_t *sel, <span class="keywordtype">void</span> (*error)(pn_selectable_t *));</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_release(pn_selectable_t *sel, <span class="keywordtype">void</span> (*release)(pn_selectable_t *));</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_on_finalize(pn_selectable_t *sel, <span class="keywordtype">void</span> (*finalize)(pn_selectable_t *));</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> PNX_EXTERN pn_record_t *pn_selectable_attachments(pn_selectable_t *sel);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> PNX_EXTERN pn_socket_t pn_selectable_get_fd(pn_selectable_t *selectable);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_set_fd(pn_selectable_t *selectable, pn_socket_t fd);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> PNX_EXTERN <span class="keywordtype">bool</span> pn_selectable_is_reading(pn_selectable_t *selectable);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_set_reading(pn_selectable_t *sel, <span class="keywordtype">bool</span> reading);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> PNX_EXTERN <span class="keywordtype">bool</span> pn_selectable_is_writing(pn_selectable_t *selectable);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_set_writing(pn_selectable_t *sel, <span class="keywordtype">bool</span> writing);</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> PNX_EXTERN <a class="code" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> pn_selectable_get_deadline(pn_selectable_t *selectable);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_set_deadline(pn_selectable_t *sel, <a class="code" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> deadline);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_readable(pn_selectable_t *selectable);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_writable(pn_selectable_t *selectable);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_error(pn_selectable_t *selectable);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_expired(pn_selectable_t *selectable);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> PNX_EXTERN <span class="keywordtype">bool</span> pn_selectable_is_registered(pn_selectable_t *selectable);</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_set_registered(pn_selectable_t *selectable, <span class="keywordtype">bool</span> registered);</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> PNX_EXTERN <span class="keywordtype">bool</span> pn_selectable_is_terminal(pn_selectable_t *selectable);</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_terminate(pn_selectable_t *selectable);</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_release(pn_selectable_t *selectable);</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_free(pn_selectable_t *selectable);</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> PNX_EXTERN <span class="keywordtype">void</span> pn_selectable_collect(pn_selectable_t *selectable, <a class="code" href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a> *collector);</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> }</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> </div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="preprocessor">#endif </span><span class="comment">/* selectable.h */</span><span class="preprocessor"></span></div><div class="ttc" id="group__event_html_ga905cdecedb8020bc28e648e43348b5d1"><div class="ttname"><a href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a></div><div class="ttdeci">struct pn_collector_t pn_collector_t</div><div class="ttdoc">An event collector. </div><div class="ttdef"><b>Definition:</b> types.h:413</div></div> |
| <div class="ttc" id="event_8h_html"><div class="ttname"><a href="event_8h.html">event.h</a></div><div class="ttdoc">Protocol and transport events. </div></div> |
| <div class="ttc" id="group__amqp__types_html_gad337c365b498106064ec28e00e5fb6dd"><div class="ttname"><a href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a></div><div class="ttdeci">int64_t pn_timestamp_t</div><div class="ttdoc">A 64-bit timestamp in milliseconds since the Unix epoch. </div><div class="ttdef"><b>Definition:</b> types.h:166</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_25143d27009f52d175c1d192441a738a.html">proton</a></li><li class="navelem"><b>selectable.h</b></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
