| <!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/receiver_options.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> |
| <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.21.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('receiver__options_8hpp_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">receiver_options.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="receiver__options_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_OPTIONS_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_RECEIVER_OPTIONS_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 "./internal/pn_unique_ptr.hpp"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="delivery__mode_8hpp.html">./delivery_mode.hpp</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classproton_1_1receiver__options.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classproton_1_1receiver__options.html">receiver_options</a> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">receiver_options</a>();</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 <a class="code" href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">receiver_options</a>(<span class="keyword">const</span> receiver_options&);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  PN_CPP_EXTERN ~receiver_options();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a815be8018205013b8ff011d4b62b7324">operator=</a>(<span class="keyword">const</span> receiver_options&);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver__options.html#a7bbed67f2faac1cd6a5c490dac90bda3">update</a>(<span class="keyword">const</span> receiver_options& other);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a84f38ac0f31f74011c9dc342e44a53df">handler</a>(<span class="keyword">class</span> <a class="code" href="classproton_1_1messaging__handler.html">messaging_handler</a>&);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a582bced77754ed8a85f9597e2e457079">delivery_mode</a>(<a class="code" href="structproton_1_1delivery__mode.html">delivery_mode</a>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a9b9ad83418de47f87c6c7062eaefb5b6">auto_accept</a>(<span class="keywordtype">bool</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#af313abfa8d5b19e4b61c779907eb9980">auto_settle</a>(<span class="keywordtype">bool</span>);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a7e2689fd52f88f551d11face38a4157b">source</a>(<a class="code" href="classproton_1_1source__options.html">source_options</a>&);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a7823f6c72dc78481be578de1658b99eb">target</a>(<a class="code" href="classproton_1_1target__options.html">target_options</a>&);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a714a6a7dd1ea90c6046fe0460d2ce4f0">credit_window</a>(<span class="keywordtype">int</span> count);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  PN_CPP_EXTERN receiver_options& <a class="code" href="classproton_1_1receiver__options.html#a038ed50e63983958b13e42d49d270b88">name</a>(<span class="keyword">const</span> std::string& <a class="code" href="classproton_1_1receiver__options.html#a038ed50e63983958b13e42d49d270b88">name</a>);</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> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> apply(<a class="code" href="classproton_1_1receiver.html">receiver</a> &) <span class="keyword">const</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> std::string* get_name() <span class="keyword">const</span>; <span class="comment">// Pointer to name if set, else 0</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">class </span>impl;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  internal::pn_unique_ptr<impl> impl_;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1receiver.html">receiver</a>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1session.html">session</a>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> } <span class="comment">// proton</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif // PROTON_RECEIVER_OPTIONS_HPP</span></div><div class="ttc" id="classproton_1_1receiver__options_html_a7823f6c72dc78481be578de1658b99eb"><div class="ttname"><a href="classproton_1_1receiver__options.html#a7823f6c72dc78481be578de1658b99eb">proton::receiver_options::target</a></div><div class="ttdeci">receiver_options & target(target_options &)</div><div class="ttdoc">Options for the target node of the receiver. </div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_af313abfa8d5b19e4b61c779907eb9980"><div class="ttname"><a href="classproton_1_1receiver__options.html#af313abfa8d5b19e4b61c779907eb9980">proton::receiver_options::auto_settle</a></div><div class="ttdeci">receiver_options & auto_settle(bool)</div></div> |
| <div class="ttc" id="fwd_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="classproton_1_1receiver__options_html_a714a6a7dd1ea90c6046fe0460d2ce4f0"><div class="ttname"><a href="classproton_1_1receiver__options.html#a714a6a7dd1ea90c6046fe0460d2ce4f0">proton::receiver_options::credit_window</a></div><div class="ttdeci">receiver_options & credit_window(int count)</div><div class="ttdoc">Automatically replenish credit for flow control up to count messages. </div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a815be8018205013b8ff011d4b62b7324"><div class="ttname"><a href="classproton_1_1receiver__options.html#a815be8018205013b8ff011d4b62b7324">proton::receiver_options::operator=</a></div><div class="ttdeci">receiver_options & operator=(const receiver_options &)</div><div class="ttdoc">Copy options. </div></div> |
| <div class="ttc" id="classproton_1_1session_html"><div class="ttname"><a href="classproton_1_1session.html">proton::session</a></div><div class="ttdoc">A container of senders and receivers. </div><div class="ttdef"><b>Definition:</b> session.hpp:41</div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a7bbed67f2faac1cd6a5c490dac90bda3"><div class="ttname"><a href="classproton_1_1receiver__options.html#a7bbed67f2faac1cd6a5c490dac90bda3">proton::receiver_options::update</a></div><div class="ttdeci">void update(const receiver_options &other)</div><div class="ttdoc">Merge with another option set. </div></div> |
| <div class="ttc" id="structproton_1_1delivery__mode_html"><div class="ttname"><a href="structproton_1_1delivery__mode.html">proton::delivery_mode</a></div><div class="ttdoc">The message delivery policy to establish when opening a link. </div><div class="ttdef"><b>Definition:</b> delivery_mode.hpp:33</div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a9b9ad83418de47f87c6c7062eaefb5b6"><div class="ttname"><a href="classproton_1_1receiver__options.html#a9b9ad83418de47f87c6c7062eaefb5b6">proton::receiver_options::auto_accept</a></div><div class="ttdeci">receiver_options & auto_accept(bool)</div><div class="ttdoc">Enable or disable automatic acceptance of messages that aren&#39;t otherwise released, rejected, or modified. </div></div> |
| <div class="ttc" id="classproton_1_1source__options_html"><div class="ttname"><a href="classproton_1_1source__options.html">proton::source_options</a></div><div class="ttdoc">Options for creating a source node for a sender or receiver. </div><div class="ttdef"><b>Definition:</b> source_options.hpp:44</div></div> |
| <div class="ttc" id="classproton_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="classproton_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:40</div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a84f38ac0f31f74011c9dc342e44a53df"><div class="ttname"><a href="classproton_1_1receiver__options.html#a84f38ac0f31f74011c9dc342e44a53df">proton::receiver_options::handler</a></div><div class="ttdeci">receiver_options & handler(class messaging_handler &)</div><div class="ttdoc">Set a messaging_handler for receiver events only. </div></div> |
| <div class="ttc" id="classproton_1_1messaging__handler_html"><div class="ttname"><a href="classproton_1_1messaging__handler.html">proton::messaging_handler</a></div><div class="ttdoc">A handler for Proton messaging events. </div><div class="ttdef"><b>Definition:</b> messaging_handler.hpp:62</div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a582bced77754ed8a85f9597e2e457079"><div class="ttname"><a href="classproton_1_1receiver__options.html#a582bced77754ed8a85f9597e2e457079">proton::receiver_options::delivery_mode</a></div><div class="ttdeci">receiver_options & delivery_mode(delivery_mode)</div><div class="ttdoc">Set the delivery mode on the receiver. </div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a038ed50e63983958b13e42d49d270b88"><div class="ttname"><a href="classproton_1_1receiver__options.html#a038ed50e63983958b13e42d49d270b88">proton::receiver_options::name</a></div><div class="ttdeci">receiver_options & name(const std::string &name)</div><div class="ttdoc">Set the link name. If not set a unique name is generated. </div></div> |
| <div class="ttc" id="classproton_1_1receiver__options_html_a9e10a473b92db75e78a3ad8498f32c36"><div class="ttname"><a href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">proton::receiver_options::receiver_options</a></div><div class="ttdeci">receiver_options()</div><div class="ttdoc">Create an empty set of options. </div></div> |
| <div class="ttc" id="namespaceproton_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="classproton_1_1receiver__options_html_a7e2689fd52f88f551d11face38a4157b"><div class="ttname"><a href="classproton_1_1receiver__options.html#a7e2689fd52f88f551d11face38a4157b">proton::receiver_options::source</a></div><div class="ttdeci">receiver_options & source(source_options &)</div><div class="ttdoc">Options for the source node of the receiver. </div></div> |
| <div class="ttc" id="classproton_1_1target__options_html"><div class="ttname"><a href="classproton_1_1target__options.html">proton::target_options</a></div><div class="ttdoc">Options for creating a target node for a sender or receiver. </div><div class="ttdef"><b>Definition:</b> target_options.hpp:44</div></div> |
| <div class="ttc" id="delivery__mode_8hpp_html"><div class="ttname"><a href="delivery__mode_8hpp.html">delivery_mode.hpp</a></div><div class="ttdoc">The message delivery policy to establish when opening a link. </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"><a class="el" href="receiver__options_8hpp.html">receiver_options.hpp</a></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> |