| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C++ API: proton/receiver.hpp 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> |
| <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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </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.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| 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.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('receiver_8hpp_source.html',''); initResizable(); }); |
| /* @license-end */ |
| </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">receiver.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="receiver_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_RECEIVER_HPP</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_RECEIVER_HPP</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 "<a class="code" href="fwd_8hpp.html">./fwd.hpp</a>"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="link_8hpp.html">./link.hpp</a>"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <proton/type_compat.h></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">struct </span>pn_link_t;</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct </span>pn_session_t;</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html"> 40</a></span> <span class="keyword">class</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> PN_CPP_CLASS_EXTERN <a class="code" href="classproton_1_1receiver.html">receiver</a> : <span class="keyword">public</span> <a class="code" href="classproton_1_1link.html">link</a> {</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1receiver.html">receiver</a>(pn_link_t* r);</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html#a24b1f20b28b31ee266f387d1fe31b627"> 48</a></span>  <a class="code" href="classproton_1_1receiver.html#a24b1f20b28b31ee266f387d1fe31b627">receiver</a>() {}</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  PN_CPP_EXTERN ~<a class="code" href="classproton_1_1receiver.html">receiver</a>();</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html#a9e8555112049fc2b4945120b3c45f8ab"> 53</a></span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver.html#a9e8555112049fc2b4945120b3c45f8ab">open</a>();</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html#a5f0b815f331997411a6794f8628592ba"> 56</a></span>  PN_CPP_EXTERN <span class="keywordtype">void</span> open(<span class="keyword">const</span> <a class="code" href="classproton_1_1receiver__options.html">receiver_options</a> &opts);</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  PN_CPP_EXTERN <span class="keyword">class </span><a class="code" href="classproton_1_1source.html">source</a> <a class="code" href="classproton_1_1source.html">source</a>() const;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  PN_CPP_EXTERN <span class="keyword">class </span><a class="code" href="classproton_1_1target.html">target</a> <a class="code" href="classproton_1_1target.html">target</a>() const;</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html#a84d3a001340d11201e03c6ed7c763641"> 67</a></span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver.html#a84d3a001340d11201e03c6ed7c763641">add_credit</a>(uint32_t);</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classproton_1_1receiver.html#af7d01b5776b9d8a0f218aec331ddaeb9"> 77</a></span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver.html#af7d01b5776b9d8a0f218aec331ddaeb9">drain</a>();</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">friend</span> <span class="keyword">class </span>internal::factory<<a class="code" href="classproton_1_1receiver.html">receiver</a>>;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">friend</span> <span class="keyword">class </span>receiver_iterator;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">class </span>receiver_iterator : <span class="keyword">public</span> internal::iter_base<receiver, receiver_iterator> {</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">explicit</span> receiver_iterator(<a class="code" href="classproton_1_1receiver.html">receiver</a> r, pn_session_t* s = 0) :</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  internal::iter_base<<a class="code" href="classproton_1_1receiver.html">receiver</a>, receiver_iterator>(r), session_(s) {}</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">explicit</span> receiver_iterator() :</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  internal::iter_base<receiver, receiver_iterator>(0), session_(0) {}</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  PN_CPP_EXTERN receiver_iterator operator++();</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  pn_session_t* session_;</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">friend</span> <span class="keyword">class </span>connection;</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">friend</span> <span class="keyword">class </span>session;</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> };</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">typedef</span> internal::iter_range<receiver_iterator> receiver_range;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> } <span class="comment">// proton</span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif // PROTON_RECEIVER_HPP</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassproton_1_1source_html"><div class="ttname"><a href="classproton_1_1source.html">proton::source</a></div><div class="ttdoc">A point of origin for messages.</div><div class="ttdef"><b>Definition:</b> source.hpp:44</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver_html_a84d3a001340d11201e03c6ed7c763641"><div class="ttname"><a href="classproton_1_1receiver.html#a84d3a001340d11201e03c6ed7c763641">proton::receiver::add_credit</a></div><div class="ttdeci">void add_credit(uint32_t)</div><div class="ttdoc">Increment the credit available to the sender.</div></div> |
| <div class="ttc" id="afwd_8hpp_html"><div class="ttname"><a href="fwd_8hpp.html">fwd.hpp</a></div><div class="ttdoc">Forward declarations.</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver__options_html"><div class="ttname"><a href="classproton_1_1receiver__options.html">proton::receiver_options</a></div><div class="ttdoc">Options for creating a receiver.</div><div class="ttdef"><b>Definition:</b> receiver_options.hpp:56</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver_html_af7d01b5776b9d8a0f218aec331ddaeb9"><div class="ttname"><a href="classproton_1_1receiver.html#af7d01b5776b9d8a0f218aec331ddaeb9">proton::receiver::drain</a></div><div class="ttdeci">void drain()</div><div class="ttdoc">Unsettled API - Commence a drain cycle.</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver_html"><div class="ttname"><a href="classproton_1_1receiver.html">proton::receiver</a></div><div class="ttdoc">A channel for receiving messages.</div><div class="ttdef"><b>Definition:</b> receiver.hpp:41</div></div> |
| <div class="ttc" id="alink_8hpp_html"><div class="ttname"><a href="link_8hpp.html">link.hpp</a></div><div class="ttdoc">A named channel for sending or receiving messages.</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver_html_a24b1f20b28b31ee266f387d1fe31b627"><div class="ttname"><a href="classproton_1_1receiver.html#a24b1f20b28b31ee266f387d1fe31b627">proton::receiver::receiver</a></div><div class="ttdeci">receiver()</div><div class="ttdoc">Create an empty receiver.</div><div class="ttdef"><b>Definition:</b> receiver.hpp:48</div></div> |
| <div class="ttc" id="aclassproton_1_1target_html"><div class="ttname"><a href="classproton_1_1target.html">proton::target</a></div><div class="ttdoc">A destination for messages.</div><div class="ttdef"><b>Definition:</b> target.hpp:45</div></div> |
| <div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div> |
| <div class="ttc" id="aclassproton_1_1link_html"><div class="ttname"><a href="classproton_1_1link.html">proton::link</a></div><div class="ttdoc">A named channel for sending or receiving messages.</div><div class="ttdef"><b>Definition:</b> link.hpp:42</div></div> |
| <div class="ttc" id="aclassproton_1_1receiver_html_a9e8555112049fc2b4945120b3c45f8ab"><div class="ttname"><a href="classproton_1_1receiver.html#a9e8555112049fc2b4945120b3c45f8ab">proton::receiver::open</a></div><div class="ttdeci">void open()</div><div class="ttdoc">Open the receiver.</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="receiver_8hpp.html">receiver.hpp</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |