http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/cpp/api/container_8hpp_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/container_8hpp_source.html b/content/releases/qpid-proton-master/proton/cpp/api/container_8hpp_source.html index 927ae24..682119d 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/container_8hpp_source.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/container_8hpp_source.html @@ -93,24 +93,23 @@ $(document).ready(function(){initNavTree('container_8hpp_source.html','');}); <div class="title">container.hpp</div> </div> </div><!--header--> <div class="contents"> -<a href="container_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_CONTAINER_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_CONTAINER_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 l icense 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 "<a class="code" href="returned_8hpp.html">./returned .hpp</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="types__fwd_8hpp.html">./types_fwd.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 "./internal/config.hpp"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "./internal/pn_unique_ptr.hpp"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="container_8hpp.html#a96a10284ee2a21982761518068fff40f"> 36</a></span> <span class="preprocessor">#define PN_CPP_SUPPORTS_THREADS PN_CPP_HAS_STD_THREAD && PN_CPP_HAS_STD_MUTEX && PN_CPP_HAS_STD_ATOMIC</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classproton_1_1container.html"> 51</a></span> <span class="keyword">class </span>PN_CPP_CLASS_EXTERN <a class="code" href="classprot on_1_1container.html">container</a> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1container.html">container</a>(<a class="code" href="classproton_1_1messaging__handler.html">messaging_handler</a>& h, <span class="keyword">const</span> std::string& <span class="keywordtype">id</span>=<span class="stringliteral">""</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  PN_CPP_EXTERN container(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>=<span class="stringliteral">""</span>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line" ><a name="l00066"></a><span class="lineno"> 66</span>  PN_CPP_EXTERN >~container();</div><div class="line"><a name="l00067"></a><span >class="lineno"> 67</span> </div><div class="line"><a >name="l00082"></a><span class="lineno"> 82</span>  PN_CPP_EXTERN <a >class="code" >href="classproton_1_1returned.html">returned<connection></a> >connect(<span class="keyword">const</span> std::string& <a class="code" >href="classproton_1_1url.html">url</a>, <span class="keyword">const</span> <a >class="code" >href="classproton_1_1connection__options.html">connection_options</a> >&);</div><div class="line"><a name="l00083"></a><span class="lineno"> >83</span> </div><div class="line"><a name="l00087"></a><span >class="lineno"> 87</span>  PN_CPP_EXTERN <a class="code" >href="classproton_1_1returned.html">returned<connection></a> >connect(<span class="keyword">const</span> std::string& url);</div><div >class="line"><a name="l00088"></a><span class=" lineno"> 88</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& url, <a class="code" href="classproton_1_1listen__handler.html">listen_handler</a>& lh);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& url, <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>&);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  PN_CPP_EXTERN <a class="code" href="cla ssproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& url);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> run();</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> <span class="preprocessor">#if PN_CPP_SUPPORTS_THREADS</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> run(<span class="keywordtype">int</span> threads);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00 125"></a><span class="lineno"> 125</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> auto_stop(<span class="keywordtype">bool</span>);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> stop(<span class="keyword">const</span> <a class="code" href="classproton_1_1error__condition.html">error_condition</a>& err);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> stop();</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender> ;</a> open_sender(<span class="keyword">const</span> std::string &url);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender></a> open_sender(<span class="keyword">const</span> std::string &url,</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1sender__options.html">proton::sender_options</a> &o);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender></a> open_sender(<span class="keyword">const</span> std::string &url,</ div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &c);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender></a> open_sender(<span class="keyword">const</span> std::string &url,</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1sender__options.html">proton::sender_options</a> &o,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &c);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string&url);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string&url,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="key word">const</span> <a class="code" href="classproton_1_1receiver__options.html">proton::receiver_options</a> &o);</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string&url,</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &c);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string&url,</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1receiver__options.html">proton::receiver_options</a> &o,</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &c);</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  PN_CPP_EXTERN std::string id() <span class="keyword">const</span>;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  PN_CPP_EXTERN <spa n class="keywordtype">void</span> client_connection_options(<span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1connection__options.html">connection_options</a> client_connection_options() <span class="keyword">const</span>;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> server_connection_options(<span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a> &);</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div><div c lass="line"><a name="l00232"></a><span class="lineno"> 232</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1connection__options.html">connection_options</a> server_connection_options() <span class="keyword">const</span>;</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1sender__options.html">sender_options</a>(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="classproton_1_1sender__options.html">sender_options</a> &);</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  PN_CPP_EXTERN <span class="keyword">class </span>sender_options sender_options() const;</div><div class="line"><a name="l00241">< /a><span class="lineno"> 241</span> </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver__options.html">receiver_options</a>(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="classproton_1_1receiver__options.html">receiver_options</a> &);</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  PN_CPP_EXTERN <span class="keyword">class </span>receiver_options receiver_options() const;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> schedule(<a class="code" href="classproton_1_1duration.html">duration</a>, <a class="co de" href="classproton_1_1work.html">work</a>);</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keyword">class </span>impl;</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  internal::pn_unique_ptr<impl> impl_;</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1connection__options.html">connection_options</a>;</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1session__options.html">session_options</a>;</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keyword">friend</span> <span class="keyword">class </span>receiver_options;</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keyword">friend</span> <span class="keyword">class </span>sender_options;</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1work__queue.html">work_queue</a>;</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> };</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> } <span class="comment">// proton</span></div><div class="line"><a name="l00268"></a><span c lass="lineno"> 268</span> </div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="preprocessor">#endif // PROTON_CONTAINER_HPP</span></div><div class="ttc" id="returned_8hpp_html"><div class="ttname"><a href="returned_8hpp.html">returned.hpp</a></div><div class="ttdoc">Return type for container functions. </div></div> -<div class="ttc" id="classproton_1_1container_html"><div class="ttname"><a href="classproton_1_1container.html">proton::container</a></div><div class="ttdoc">A top-level container of connections, sessions, senders, and receivers. </div><div class="ttdef"><b>Definition:</b> container.hpp:51</div></div> -<div class="ttc" id="classproton_1_1work_html"><div class="ttname"><a href="classproton_1_1work.html">proton::work</a></div><div class="ttdoc">Unsettled API - Work to be queued on a work_queue. </div><div class="ttdef"><b>Definition:</b> work_queue.hpp:43</div></div> -<div class="ttc" id="classproton_1_1listener_html"><div class="ttname"><a href="classproton_1_1listener.html">proton::listener</a></div><div class="ttdoc">A listener for incoming connections. </div><div class="ttdef"><b>Definition:</b> listener.hpp:30</div></div> -<div class="ttc" id="classproton_1_1sender__options_html"><div class="ttname"><a href="classproton_1_1sender__options.html">proton::sender_options</a></div><div class="ttdoc">Options for creating a sender. </div><div class="ttdef"><b>Definition:</b> sender_options.hpp:53</div></div> -<div class="ttc" id="classproton_1_1duration_html"><div class="ttname"><a href="classproton_1_1duration.html">proton::duration</a></div><div class="ttdoc">A span of time in milliseconds. </div><div class="ttdef"><b>Definition:</b> duration.hpp:36</div></div> -<div class="ttc" id="fwd_8hpp_html"><div class="ttname"><a href="fwd_8hpp.html">fwd.hpp</a></div></div> -<div class="ttc" id="classproton_1_1connection__options_html"><div class="ttname"><a href="classproton_1_1connection__options.html">proton::connection_options</a></div><div class="ttdoc">Options for creating a connection. </div><div class="ttdef"><b>Definition:</b> connection_options.hpp:62</div></div> -<div class="ttc" id="classproton_1_1url_html"><div class="ttname"><a href="classproton_1_1url.html">proton::url</a></div><div class="ttdoc">A URL parser. </div><div class="ttdef"><b>Definition:</b> url.hpp:56</div></div> -<div class="ttc" id="classproton_1_1returned_html"><div class="ttname"><a href="classproton_1_1returned.html">proton::returned</a></div><div class="ttdoc">Return type for container functions. </div><div class="ttdef"><b>Definition:</b> fwd.hpp:66</div></div> -<div class="ttc" id="types__fwd_8hpp_html"><div class="ttname"><a href="types__fwd_8hpp.html">types_fwd.hpp</a></div><div class="ttdoc">Forward declarations for all C++ types used by Proton to represent AMQP types. </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:52</div></div> -<div class="ttc" id="classproton_1_1listen__handler_html"><div class="ttname"><a href="classproton_1_1listen__handler.html">proton::listen_handler</a></div><div class="ttdoc">Unsettled API - A handler for incoming connections. </div><div class="ttdef"><b>Definition:</b> listen_handler.hpp:34</div></div> -<div class="ttc" id="classproton_1_1work__queue_html"><div class="ttname"><a href="classproton_1_1work__queue.html">proton::work_queue</a></div><div class="ttdoc">Unsettled API - A work queue for serial execution. </div><div class="ttdef"><b>Definition:</b> work_queue.hpp:90</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:59</div></div> -<div class="ttc" id="classproton_1_1session__options_html"><div class="ttname"><a href="classproton_1_1session__options.html">proton::session_options</a></div><div class="ttdoc">Options for creating a session. </div><div class="ttdef"><b>Definition:</b> session_options.hpp:37</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:30</div></div> -<div class="ttc" id="classproton_1_1error__condition_html"><div class="ttname"><a href="classproton_1_1error__condition.html">proton::error_condition</a></div><div class="ttdoc">Describes an endpoint error state. </div><div class="ttdef"><b>Definition:</b> error_condition.hpp:37</div></div> +<a href="container_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_CONTAINER_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_CONTAINER_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 l icense 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 "<a class="code" href="returned_8hpp.html">./returned .hpp</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="types__fwd_8hpp.html">./types_fwd.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 "./internal/config.hpp"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "./internal/pn_unique_ptr.hpp"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define PN_CPP_SUPPORTS_THREADS PN_CPP_HAS_STD_THREAD && PN_CPP_HAS_STD_MUTEX && PN_CPP_HAS_STD_ATOMIC</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classproton_1_1container.html"> 55</a></span> <span class="keyword">class </span>PN_CPP_CLASS_EXTERN <a class="code" href="classp roton_1_1container.html">container</a> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1container.html">container</a>(<a class="code" href="classproton_1_1messaging__handler.html">messaging_handler</a>& handler, <span class="keyword">const</span> std::string& <span class="keywordtype">id</span>=<span class="stringliteral">""</span>);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  PN_CPP_EXTERN container(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>=<span class="stringliteral">""</span>);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div cla ss="line"><a name="l00076"></a><span class="lineno"> 76</span>  PN_CPP_EXTERN ~container();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<connection></a> connect(<span class="keyword">const</span> std::string& conn_url,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</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 <a class="code" href="classproton_1_1returned.html">returned<connection></a> connect(<span class=" keyword">const</span> std::string& conn_url);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& listen_url,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classproton_1_1listen__handler.html">listen_handler</a>& handler);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& listen_url,</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1listener.html">listener</a> listen(<span class="keyword">const</span> std::string& listen_url);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> run();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#if PN_CPP_SUPPORTS_THREADS</span></div><div class="line"><a name="l00132"></a><span class= "lineno"> 132</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> run(<span class="keywordtype">int</span> count);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> auto_stop(<span class="keywordtype">bool</span> enabled);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> stop(<span class="keyword">const</span> <a class="code" href="classproton_1_1error__condition.html">error_condition</a>& err);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line" ><a name="l00167"></a><span class="lineno"> 167</span>  PN_CPP_EXTERN ><span class="keywordtype">void</span> stop();</div><div class="line"><a >name="l00168"></a><span class="lineno"> 168</span> </div><div >class="line"><a name="l00172"></a><span class="lineno"> 172</span>  >PN_CPP_EXTERN <a class="code" >href="classproton_1_1returned.html">returned<sender></a> >open_sender(<span class="keyword">const</span> std::string& >addr_url);</div><div class="line"><a name="l00173"></a><span class="lineno"> >173</span> </div><div class="line"><a name="l00180"></a><span >class="lineno"> 180</span>  PN_CPP_EXTERN <a class="code" >href="classproton_1_1returned.html">returned<sender></a> >open_sender(<span class="keyword">const</span> std::string& >addr_url,</div><div class="line"><a name="l00181"></a><span class="lineno"> >181</span>  <span >class="keyword">const</span> <a class="code" href="classpro ton_1_1sender__options.html">proton::sender_options</a>& snd_opts);</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender></a> open_sender(<span class="keyword">const</span> std::string& addr_url,</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<sender></a> open_sender(<span class="keyword">const</span> std::str ing& addr_url,</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1sender__options.html">proton::sender_options</a>& snd_opts,</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string& addr_url);</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class=" line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string& addr_url,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1receiver__options.html">proton::receiver_options</a>& rcv_opts);</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string& addr_url,</div><div class="line"><a name="l00224"></a><span class ="lineno"> 224</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1returned.html">returned<receiver></a> open_receiver(<span class="keyword">const</span> std::string& addr_url,</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">const</span> <a class="code" href="classproton_1_1receiver__options.html">proton::receiver_options</a>& rcv_opts,</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keyword">const</s pan> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  PN_CPP_EXTERN std::string id() <span class="keyword">const</span>;</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> client_connection_options(<span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1connection__options.html">connection_optio ns</a> client_connection_options() <span class="keyword">const</span>;</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> server_connection_options(<span class="keyword">const</span> <a class="code" href="classproton_1_1connection__options.html">connection_options</a>& conn_opts);</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1connection__options.html">connection_options</a> server_connection_options() <span class="keyword">const</span>;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  PN_CPP_EXTERN <span class="keywor dtype">void</span> <a class="code" href="classproton_1_1sender__options.html">sender_options</a>(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="classproton_1_1sender__options.html">sender_options</a>& snd_opts);</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  PN_CPP_EXTERN <span class="keyword">class </span>sender_options sender_options() const;</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> <a class="code" href="classproton_1_1receiver__options.html">receiver_options</a>(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="classproton_1_1receiver__options.html">receiver_options</a>& rcv_opts);</div ><div class="line"><a name="l00268"></a><span class="lineno"> >268</span> </div><div class="line"><a name="l00270"></a><span >class="lineno"> 270</span>  PN_CPP_EXTERN <span >class="keyword">class </span>receiver_options receiver_options() >const;</div><div class="line"><a name="l00271"></a><span class="lineno"> >271</span> </div><div class="line"><a name="l00277"></a><span >class="lineno"> 277</span>  PN_CPP_EXTERN <span >class="keywordtype">void</span> schedule(<a class="code" >href="classproton_1_1duration.html">duration</a> dur, <a class="code" >href="classproton_1_1work.html">work</a> fn);</div><div class="line"><a >name="l00278"></a><span class="lineno"> 278</span> </div><div >class="line"><a name="l00279"></a><span class="lineno"> 279</span>  ><span class="keyword">private</span>:</div><div class="line"><a >name="l00280"></a><span class="lineno"> 280</span>  <span >class="keyword">class </span>impl;</div><div class="line"><a name="l00281" ></a><span class="lineno"> 281</span>  >internal::pn_unique_ptr<impl> impl_;</div><div class="line"><a >name="l00282"></a><span class="lineno"> 282</span> </div><div >class="line"><a name="l00284"></a><span class="lineno"> 284</span>  ><span class="keyword">friend</span> <span class="keyword">class </span><a >class="code" >href="classproton_1_1connection__options.html">connection_options</a>;</div><div > class="line"><a name="l00285"></a><span class="lineno"> 285</span>  ><span class="keyword">friend</span> <span class="keyword">class </span><a >class="code" >href="classproton_1_1session__options.html">session_options</a>;</div><div >class="line"><a name="l00286"></a><span class="lineno"> 286</span>  ><span class="keyword">friend</span> <span class="keyword">class ></span>receiver_options;</div><div class="line"><a name="l00287"></a><span >class="lineno"> 287</span>  <span class="keyword">friend</span> <span >class="keyword">class </span>sender_optio ns;</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1work__queue.html">work_queue</a>;</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> };</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> } <span class="comment">// proton</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor">#endif // PROTON_CONTAINER_HPP</span></div><div class="ttc" id="returned_8hpp_html"><div class="ttname"><a href="returned_8hpp.html">returned.hpp</a></div><div class="ttdoc">A return type for container methods. </div></div> +<div class="ttc" id="classproton_1_1container_html"><div class="ttname"><a href="classproton_1_1container.html">proton::container</a></div><div class="ttdoc">A top-level container of connections, sessions, and links. </div><div class="ttdef"><b>Definition:</b> container.hpp:55</div></div> +<div class="ttc" id="classproton_1_1work_html"><div class="ttname"><a href="classproton_1_1work.html">proton::work</a></div><div class="ttdoc">Unsettled API - A work item for a work queue. </div><div class="ttdef"><b>Definition:</b> work_queue.hpp:47</div></div> +<div class="ttc" id="classproton_1_1listener_html"><div class="ttname"><a href="classproton_1_1listener.html">proton::listener</a></div><div class="ttdoc">A listener for incoming connections. </div><div class="ttdef"><b>Definition:</b> listener.hpp:33</div></div> +<div class="ttc" id="classproton_1_1sender__options_html"><div class="ttname"><a href="classproton_1_1sender__options.html">proton::sender_options</a></div><div class="ttdoc">Options for creating a sender. </div><div class="ttdef"><b>Definition:</b> sender_options.hpp:56</div></div> +<div class="ttc" id="classproton_1_1duration_html"><div class="ttname"><a href="classproton_1_1duration.html">proton::duration</a></div><div class="ttdoc">A span of time in milliseconds. </div><div class="ttdef"><b>Definition:</b> duration.hpp:39</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_1connection__options_html"><div class="ttname"><a href="classproton_1_1connection__options.html">proton::connection_options</a></div><div class="ttdoc">Options for creating a connection. </div><div class="ttdef"><b>Definition:</b> connection_options.hpp:65</div></div> +<div class="ttc" id="classproton_1_1returned_html"><div class="ttname"><a href="classproton_1_1returned.html">proton::returned</a></div><div class="ttdoc">A return type for container methods. </div><div class="ttdef"><b>Definition:</b> fwd.hpp:69</div></div> +<div class="ttc" id="types__fwd_8hpp_html"><div class="ttname"><a href="types__fwd_8hpp.html">types_fwd.hpp</a></div><div class="ttdoc">Forward declarations for Proton types used to represent AMQP types. </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:55</div></div> +<div class="ttc" id="classproton_1_1listen__handler_html"><div class="ttname"><a href="classproton_1_1listen__handler.html">proton::listen_handler</a></div><div class="ttdoc">Unsettled API - A handler for incoming connections. </div><div class="ttdef"><b>Definition:</b> listen_handler.hpp:37</div></div> +<div class="ttc" id="classproton_1_1work__queue_html"><div class="ttname"><a href="classproton_1_1work__queue.html">proton::work_queue</a></div><div class="ttdoc">Unsettled API - A context for thread-safe execution of work. </div><div class="ttdef"><b>Definition:</b> work_queue.hpp:94</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:61</div></div> +<div class="ttc" id="classproton_1_1session__options_html"><div class="ttname"><a href="classproton_1_1session__options.html">proton::session_options</a></div><div class="ttdoc">Options for creating a session. </div><div class="ttdef"><b>Definition:</b> session_options.hpp:40</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_1error__condition_html"><div class="ttname"><a href="classproton_1_1error__condition.html">proton::error_condition</a></div><div class="ttdoc">Describes an endpoint error state. </div><div class="ttdef"><b>Definition:</b> error_condition.hpp:40</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/cpp/api/data_8hpp_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/data_8hpp_source.html b/content/releases/qpid-proton-master/proton/cpp/api/data_8hpp_source.html index 3fd4f27..429b568 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/data_8hpp_source.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/data_8hpp_source.html @@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree('data_8hpp_source.html','');}); </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_INTERNAL_DATA_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_INTERNAL_DATA_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 cl ass="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 "../internal/object.hpp"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "../types_fwd.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a nam e="l00028"></a><span class="lineno"> 28</span> <span class="keyword">struct </span>pn_data_t;</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="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>value;</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>internal {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>data : <span class="keyword">public</span> object<pn_data_t> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  data(pn_data_t* d) : internal::object<pn_data_t>(d) {}</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  data() : internal::object<pn_data_t>(0) {}</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  PN_CPP_EXTERN <span class="keyword">static</span> data create();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  PN_CPP_EXTERN <span class="keywordty pe">void</span> copy(<span class="keyword">const</span> data&);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> clear();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> rewind();</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="keywordtype">bool</span> empty() <span class="keyword">const</span>;</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= "keywordtype">int</span> append(data src);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  PN_CPP_EXTERN <span class="keywordtype">int</span> appendn(data src, <span class="keywordtype">int</span> limit);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  PN_CPP_EXTERN <span class="keywordtype">bool</span> next();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  PN_CPP_EXTERN <span class="keyword">const</span> <span class="keywordtype">void</span>* point() <span class="keyword">const</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  PN_CPP_EXTERN <span class="keywordtype">void</span> restore(<span class="keyword">const</span> <span class="keywordtype">void</span> * h);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> narrow();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> widen();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">friend</span> <span class="keyword">class </span>internal::factory<data>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">friend</span> <span class="keyword">struct </span>state_guard;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</ span>  <span class="keyword">friend</span> PN_CPP_EXTERN std::ostream& <a class="code" href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">operator<<</a>(std::ostream&, <span class="keyword">const</span> data&);</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> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">struct </span>state_guard {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  data& data_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* point_;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> cancel_;</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>  state_guard(data& d) : data_(d), point_(data_.point()), cancel_(false) {}</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ~state_guard() { <span class="keywordflow">if</span> (!cancel_) data_.restore(point_); }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> cancel() { cancel_ = <span class="keyword">true</span>; }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> } <span c lass="comment">// internal</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// proton</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif // PROTON_INTERNAL_DATA_HPP</span></div><div class="ttc" id="namespaceproton_html_ae6fabe30961a3d3280bb8445e743b21c"><div class="ttname"><a href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">proton::operator<<</a></div><div class="ttdeci">std::ostream & operator<<(std::ostream &, const binary &)</div><div class="ttdoc">Print a binary value. </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:30</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><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/7437c595/content/releases/qpid-proton-master/proton/cpp/api/decimal_8hpp.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/decimal_8hpp.html b/content/releases/qpid-proton-master/proton/cpp/api/decimal_8hpp.html index 5539836..2520a85 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/decimal_8hpp.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/decimal_8hpp.html @@ -91,13 +91,14 @@ $(document).ready(function(){initNavTree('decimal_8hpp.html','');}); <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | -<a href="#namespaces">Namespaces</a> </div> +<a href="#namespaces">Namespaces</a> | +<a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">decimal.hpp File Reference</div> </div> </div><!--header--> <div class="contents"> -<p>Placeholder for the AMQP decimal data type. +<p>AMQP decimal types. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="byte__array_8hpp_source.html">./byte_array.hpp</a>"</code><br /> <code>#include "./internal/export.hpp"</code><br /> @@ -109,13 +110,13 @@ $(document).ready(function(){initNavTree('decimal_8hpp.html','');}); <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1decimal32.html">decimal32</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">32-bit decimal floating point. <a href="classproton_1_1decimal32.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A 32-bit decimal floating-point value. <a href="classproton_1_1decimal32.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1decimal64.html">decimal64</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">64-bit decimal floating point. <a href="classproton_1_1decimal64.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A 64-bit decimal floating-point value. <a href="classproton_1_1decimal64.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1decimal128.html">decimal128</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">128-bit decimal floating point. <a href="classproton_1_1decimal128.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A 128-bit decimal floating-point value. <a href="classproton_1_1decimal128.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> @@ -126,20 +127,23 @@ Namespaces</h2></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><td colspan="2"><div class="groupHeader"></div></td></tr> <tr class="memitem:aec04001c66a08483b8e23f836da2d621"><td class="memItemLeft" align="right" valign="top"><a id="aec04001c66a08483b8e23f836da2d621"></a> std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#aec04001c66a08483b8e23f836da2d621">operator<<</a> (std::ostream &, const decimal32 &)</td></tr> -<tr class="memdesc:aec04001c66a08483b8e23f836da2d621"><td class="mdescLeft"> </td><td class="mdescRight">Print decimal values. <br /></td></tr> +<tr class="memdesc:aec04001c66a08483b8e23f836da2d621"><td class="mdescLeft"> </td><td class="mdescRight">Print a 32-bit decimal value. <br /></td></tr> <tr class="separator:aec04001c66a08483b8e23f836da2d621"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76d2a7b0034ac7efec1cf6a3cb4c8372"><td class="memItemLeft" align="right" valign="top"><a id="a76d2a7b0034ac7efec1cf6a3cb4c8372"></a> -std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const decimal64 &)</td></tr> +std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a76d2a7b0034ac7efec1cf6a3cb4c8372">operator<<</a> (std::ostream &, const decimal64 &)</td></tr> +<tr class="memdesc:a76d2a7b0034ac7efec1cf6a3cb4c8372"><td class="mdescLeft"> </td><td class="mdescRight">Print a 64-bit decimal value. <br /></td></tr> <tr class="separator:a76d2a7b0034ac7efec1cf6a3cb4c8372"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af5fffc10b2245e6a76e37053a3a9e3b7"><td class="memItemLeft" align="right" valign="top"><a id="af5fffc10b2245e6a76e37053a3a9e3b7"></a> -std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const decimal128 &)</td></tr> +std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#af5fffc10b2245e6a76e37053a3a9e3b7">operator<<</a> (std::ostream &, const decimal128 &)</td></tr> +<tr class="memdesc:af5fffc10b2245e6a76e37053a3a9e3b7"><td class="mdescLeft"> </td><td class="mdescRight">Print a 128-bit decimal value. <br /></td></tr> <tr class="separator:af5fffc10b2245e6a76e37053a3a9e3b7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Placeholder for the AMQP decimal data type. </p> +<div class="textblock"><p>AMQP decimal types. </p> +<p>AMQP uses the standard IEEE 754-2008 encoding for decimal types.</p> +<p>This library does not provide support for decimal arithmetic, but it does provide access to the byte representation of decimal values. You can pass these values uninterpreted via AMQP, or you can use a library that supports IEEE 754-2008 and make a byte-wise copy between the real decimal values and <code>proton::decimal</code> values. </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
