http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.html index a57b6c8..3022b79 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.html @@ -104,12 +104,18 @@ $(document).ready(function(){initNavTree('classproton_1_1container.html','');}); <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr class="memitem:a822ca363beceb76ffdc5ce370a4f9356"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a822ca363beceb76ffdc5ce370a4f9356">container</a> (<a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &handler, const std::string &<a class="el" href="classproton_1_1container.html#a4c5cdd8165762b000c6518db56830677">id</a>="")</td></tr> -<tr class="memdesc:a822ca363beceb76ffdc5ce370a4f9356"><td class="mdescLeft"> </td><td class="mdescRight">Create a container with a handler for messaging events. <a href="#a822ca363beceb76ffdc5ce370a4f9356">More...</a><br /></td></tr> -<tr class="separator:a822ca363beceb76ffdc5ce370a4f9356"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa73c3a48d397b513182a2d90ba5ab686"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#aa73c3a48d397b513182a2d90ba5ab686">container</a> (const std::string &<a class="el" href="classproton_1_1container.html#a4c5cdd8165762b000c6518db56830677">id</a>="")</td></tr> -<tr class="memdesc:aa73c3a48d397b513182a2d90ba5ab686"><td class="mdescLeft"> </td><td class="mdescRight">Create a container. <a href="#aa73c3a48d397b513182a2d90ba5ab686">More...</a><br /></td></tr> -<tr class="separator:aa73c3a48d397b513182a2d90ba5ab686"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9a322df81c8d397bb4c3fa6c1a67a496"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a9a322df81c8d397bb4c3fa6c1a67a496">container</a> (<a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &handler, const std::string &<a class="el" href="classproton_1_1container.html#a4c5cdd8165762b000c6518db56830677">id</a>)</td></tr> +<tr class="memdesc:a9a322df81c8d397bb4c3fa6c1a67a496"><td class="mdescLeft"> </td><td class="mdescRight">Create a container with a global handler for messaging events. <a href="#a9a322df81c8d397bb4c3fa6c1a67a496">More...</a><br /></td></tr> +<tr class="separator:a9a322df81c8d397bb4c3fa6c1a67a496"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3d7f4be6b8ace086ed7470f66a742059"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a3d7f4be6b8ace086ed7470f66a742059">container</a> (<a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &handler)</td></tr> +<tr class="memdesc:a3d7f4be6b8ace086ed7470f66a742059"><td class="mdescLeft"> </td><td class="mdescRight">Create a container with a global handler for messaging events. <a href="#a3d7f4be6b8ace086ed7470f66a742059">More...</a><br /></td></tr> +<tr class="separator:a3d7f4be6b8ace086ed7470f66a742059"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a88125a4442a7b28fab97a89587627c0f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a88125a4442a7b28fab97a89587627c0f">container</a> (const std::string &<a class="el" href="classproton_1_1container.html#a4c5cdd8165762b000c6518db56830677">id</a>)</td></tr> +<tr class="memdesc:a88125a4442a7b28fab97a89587627c0f"><td class="mdescLeft"> </td><td class="mdescRight">Create a container. <a href="#a88125a4442a7b28fab97a89587627c0f">More...</a><br /></td></tr> +<tr class="separator:a88125a4442a7b28fab97a89587627c0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeacc0140de439ebab9a5466c45d38191"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#aeacc0140de439ebab9a5466c45d38191">container</a> ()</td></tr> +<tr class="memdesc:aeacc0140de439ebab9a5466c45d38191"><td class="mdescLeft"> </td><td class="mdescRight">Create a container. <a href="#aeacc0140de439ebab9a5466c45d38191">More...</a><br /></td></tr> +<tr class="separator:aeacc0140de439ebab9a5466c45d38191"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7c64e64cedfa36303be53f0f581d1d24"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a7c64e64cedfa36303be53f0f581d1d24">~container</a> ()</td></tr> <tr class="memdesc:a7c64e64cedfa36303be53f0f581d1d24"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a container. <a href="#a7c64e64cedfa36303be53f0f581d1d24">More...</a><br /></td></tr> <tr class="separator:a7c64e64cedfa36303be53f0f581d1d24"><td class="memSeparator" colspan="2"> </td></tr> @@ -132,7 +138,7 @@ Public Member Functions</h2></td></tr> <tr class="memdesc:a13a43e6d814de94978c515cb084873b1"><td class="mdescLeft"> </td><td class="mdescRight">Run the container in the current thread. <a href="#a13a43e6d814de94978c515cb084873b1">More...</a><br /></td></tr> <tr class="separator:a13a43e6d814de94978c515cb084873b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac48e94529e54c7e7342fde28b26d9f48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#ac48e94529e54c7e7342fde28b26d9f48">run</a> (int count)</td></tr> -<tr class="memdesc:ac48e94529e54c7e7342fde28b26d9f48"><td class="mdescLeft"> </td><td class="mdescRight">Run the container with a pool of <code>count</code> threads. <a href="#ac48e94529e54c7e7342fde28b26d9f48">More...</a><br /></td></tr> +<tr class="memdesc:ac48e94529e54c7e7342fde28b26d9f48"><td class="mdescLeft"> </td><td class="mdescRight">Run the container with a pool of <code>count</code> threads, including the current thread. <a href="#ac48e94529e54c7e7342fde28b26d9f48">More...</a><br /></td></tr> <tr class="separator:ac48e94529e54c7e7342fde28b26d9f48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d5932054f172c66000aec9f4ed498df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a1d5932054f172c66000aec9f4ed498df">auto_stop</a> (bool enabled)</td></tr> <tr class="memdesc:a1d5932054f172c66000aec9f4ed498df"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable automatic container stop. <a href="#a1d5932054f172c66000aec9f4ed498df">More...</a><br /></td></tr> @@ -195,18 +201,22 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <tr class="memitem:a099ddaa3cfcd6a8ae14401bbbfb4b660"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a099ddaa3cfcd6a8ae14401bbbfb4b660">receiver_options</a> () const</td></tr> <tr class="memdesc:a099ddaa3cfcd6a8ae14401bbbfb4b660"><td class="mdescLeft"> </td><td class="mdescRight">Receiver options applied to receivers created by this container. <a href="#a099ddaa3cfcd6a8ae14401bbbfb4b660">More...</a><br /></td></tr> <tr class="separator:a099ddaa3cfcd6a8ae14401bbbfb4b660"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa99ede2051ccdf5fe8257d893559ea26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#aa99ede2051ccdf5fe8257d893559ea26">schedule</a> (<a class="el" href="classproton_1_1duration.html">duration</a> dur, <a class="el" href="classproton_1_1work.html">work</a> fn)</td></tr> +<tr class="memitem:aa99ede2051ccdf5fe8257d893559ea26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#aa99ede2051ccdf5fe8257d893559ea26">schedule</a> (<a class="el" href="classproton_1_1duration.html">duration</a> dur, work fn)</td></tr> <tr class="memdesc:aa99ede2051ccdf5fe8257d893559ea26"><td class="mdescLeft"> </td><td class="mdescRight">Schedule <code>fn</code> for execution after a duration. <a href="#aa99ede2051ccdf5fe8257d893559ea26">More...</a><br /></td></tr> <tr class="separator:aa99ede2051ccdf5fe8257d893559ea26"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3e20a15733ef55ac0c43fbe1e60813d4"><td class="memItemLeft" align="right" valign="top"><a id="a3e20a15733ef55ac0c43fbe1e60813d4"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1container.html#a3e20a15733ef55ac0c43fbe1e60813d4">schedule</a> (<a class="el" href="classproton_1_1duration.html">duration</a> dur, void_function0 &fn)</td></tr> +<tr class="memdesc:a3e20a15733ef55ac0c43fbe1e60813d4"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <code><a class="el" href="classproton_1_1container.html#aa99ede2051ccdf5fe8257d893559ea26" title="Schedule fn for execution after a duration. ">container::schedule(duration, work)</a></code>. <br /></td></tr> +<tr class="separator:a3e20a15733ef55ac0c43fbe1e60813d4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A top-level container of connections, sessions, and links. </p> <p>A container gives a unique identity to each communicating peer. It is often a process-level object.</p> <p>It also serves as an entry point to the API, allowing connections, senders, and receivers to be established. It can be supplied with an event handler in order to intercept important messaging events, such as newly received messages or newly issued credit for sending messages. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a10">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a6">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a3">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#_a3">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a3">helloworld.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#_a3">helloworld_direct.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a9">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a3">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#_a6">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#_a5">scheduled_send_03.cpp</a>, <a class="el" href="server_8cpp-example.html#_a4">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a2">server_di rect.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a8">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#_a3">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#_a3">simple_send.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a9">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a6">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a4">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#_a4">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a2">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a9">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a3">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#_a6">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#_a5">scheduled_send_03.cpp</a>, <a class="el" href="server_8cpp-example.html#_a3">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a4">server_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a8">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#_a3">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#_a3">simple_send.cpp</a>.</dd> </dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a id="a822ca363beceb76ffdc5ce370a4f9356"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a822ca363beceb76ffdc5ce370a4f9356">◆ </a></span>container() <span class="overload">[1/2]</span></h2> +<a id="a9a322df81c8d397bb4c3fa6c1a67a496"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9a322df81c8d397bb4c3fa6c1a67a496">◆ </a></span>container() <span class="overload">[1/4]</span></h2> <div class="memitem"> <div class="memproto"> @@ -221,7 +231,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> - <td class="paramname"><em>id</em> = <code>""</code> </td> + <td class="paramname"><em>id</em> </td> </tr> <tr> <td></td> @@ -231,13 +241,47 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </table> </div><div class="memdoc"> -<p>Create a container with a handler for messaging events. </p> -<p>The optional <code>id</code> parameter sets the container's unique identity. </p> +<p>Create a container with a global handler for messaging events. </p> +<p><b>Thread safety</b> - in a multi-threaded container this handler will be called concurrently. You can use locks to make that safe, or use a separate handler for each connection. See <a class="el" href="mt_page.html">Multithreading</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handler</td><td>global handler, called for events on all connections managed by the container.</td></tr> + <tr><td class="paramname">id</td><td>sets the container's unique identity. </td></tr> + </table> + </dd> +</dl> </div> </div> -<a id="aa73c3a48d397b513182a2d90ba5ab686"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa73c3a48d397b513182a2d90ba5ab686">◆ </a></span>container() <span class="overload">[2/2]</span></h2> +<a id="a3d7f4be6b8ace086ed7470f66a742059"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3d7f4be6b8ace086ed7470f66a742059">◆ </a></span>container() <span class="overload">[2/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classproton_1_1container.html">container</a> </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> & </td> + <td class="paramname"><em>handler</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a container with a global handler for messaging events. </p> +<p><b>Thread safety</b> - in a multi-threaded container this handler will be called concurrently. You can use locks to make that safe, or use a separate handler for each connection. See <a class="el" href="mt_page.html">Multithreading</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handler</td><td>global handler, called for events on all connections managed by the container. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a88125a4442a7b28fab97a89587627c0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a88125a4442a7b28fab97a89587627c0f">◆ </a></span>container() <span class="overload">[3/4]</span></h2> <div class="memitem"> <div class="memproto"> @@ -246,14 +290,39 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <td class="memname"><a class="el" href="classproton_1_1container.html">container</a> </td> <td>(</td> <td class="paramtype">const std::string & </td> - <td class="paramname"><em>id</em> = <code>""</code></td><td>)</td> + <td class="paramname"><em>id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a container. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">id</td><td>sets the container's unique identity. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aeacc0140de439ebab9a5466c45d38191"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aeacc0140de439ebab9a5466c45d38191">◆ </a></span>container() <span class="overload">[4/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classproton_1_1container.html">container</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a container. </p> -<p>The optional <code>id</code> parameter sets the container's unique identity. </p> +<p>This will create a default random identity </p> </div> </div> @@ -273,7 +342,8 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Destroy a container. </p> -<p><b>Thread safety</b> - It is unsafe to delete a container from within any of the threads running a <code><a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">messaging_handler</a></code>. Deleting the container from within a handler will cause a deadlock or crash. The only safe place to delete a container is after all of the threads running a container have finished and all of the <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a></code> functions have returned. </p> +<p>A container must not be destroyed while a call to <a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a> is in progress, in particular it must not be destroyed from a <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> callback.</p> +<p><b>Thread safety</b> - in a multi-threaded application, <a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a> must return in all threads that call it before destroying the container. </p> </div> </div> @@ -310,9 +380,9 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <li><a class="el" href="classproton_1_1container.html#a913a88786abbbf08dd3e53e2a3e4accb" title="Connection options applied to outgoing connections. ">client_connection_options()</a></li> <li>Options passed to <a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer. ">connect()</a></li> </ol> -<p>Values in later options override earlier ones. The handler in the composed options is used to call <code><a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code> when the open response is received from the remote peer.</p> +<p>Values in later options override earlier ones. The handler in the composed options is used to call <code><a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code> when the open response is received from the remote peer.</p> <p><b>Thread safety</b> - Container method return values are <em>thread-unsafe</em>. A single-threaded application can safely assign the <code>returned<T></code> value to a plain <code>T</code>. A multithreaded application <em>must</em> ignore the returned value because it may already be invalid by the time the function returns. Multithreaded applications can safely access the value inside <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> functions. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="helloworld_8cpp-example.html#a4">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#a10">multithreaded_client.cpp</a>, <a class="el" href="server_8cpp-example.html#a5">server.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#a10">service_bus.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="helloworld_8cpp-example.html#a3">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#a10">multithreaded_client.cpp</a>, <a class="el" href="server_8cpp-example.html#a4">server.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#a10">service_bus.cpp</a>.</dd> </dl> </div> </div> @@ -364,8 +434,10 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Listen for new connections on <code>listen_url</code>. </p> -<p><b>Thread safety</b> - Calls to <code><a class="el" href="classproton_1_1listen__handler.html" title="Unsettled API - A handler for incoming connections. ">listen_handler</a></code> methods are serialized for this listener, but handlers attached to separate listeners can be safely called concurrently. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#a26">broker.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#a4">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a4">direct_send.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#a4">helloworld_direct.cpp</a>, and <a class="el" href="server_direct_8cpp-example.html#a3">server_direct.cpp</a>.</dd> +<p>If the listener opens successfully, <a class="el" href="classproton_1_1listen__handler.html#a74a2a66bb05107bd04fbb15731b0578b" title="Called when the listener is opened successfully. ">listen_handler::on_open()</a> is called. If it fails to open, <a class="el" href="classproton_1_1listen__handler.html#a0969610957fd465626cfad89db38ef53" title="Called if there is a listening error, with an error message. ">listen_handler::on_error()</a> then listen_handler::close() are called.</p> +<p><a class="el" href="classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc" title="Called for each accepted connection. ">listen_handler::on_accept()</a> is called for each incoming connection to determine the <a class="el" href="classproton_1_1connection__options.html">connection_options</a> to use, including the <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a>.</p> +<p><b>Thread safety</b> - Calls to <code><a class="el" href="classproton_1_1listen__handler.html" title="Unsettled API - A handler for incoming connections. ">listen_handler</a></code> methods are serialized for this listener, but handlers attached to separate listeners may be called concurrently. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_recv_8cpp-example.html#a5">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a5">direct_send.cpp</a>, and <a class="el" href="server_direct_8cpp-example.html#a5">server_direct.cpp</a>.</dd> </dl> </div> </div> @@ -396,7 +468,8 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Listen for new connections on <code>listen_url</code>. </p> -<p>Use a fixed set of options for all accepted connections. See <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen(const std::string&, listen_handler&)</a>. </p> +<p>Use a fixed set of options for all accepted connections. See <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen(const std::string&, listen_handler&)</a>.</p> +<p><b>Thread safety</b> - for multi-threaded applications we recommend using a <a class="el" href="classproton_1_1listen__handler.html">listen_handler</a> to create a new <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> for each connection. See <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen(const std::string&, listen_handler&)</a> and <a class="el" href="mt_page.html">Multithreading</a> </p> </div> </div> @@ -417,7 +490,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Listen for new connections on <code>listen_url</code>. </p> -<p>New connections will use the handler from <code><a class="el" href="classproton_1_1container.html#a7daf70330e5259fbb6ae3f01cfbc125a" title="Connection options applied to incoming connections. ">server_connection_options()</a></code>. </p> +<p>New connections will use the handler from <code><a class="el" href="classproton_1_1container.html#a7daf70330e5259fbb6ae3f01cfbc125a" title="Connection options applied to incoming connections. ">server_connection_options()</a></code>. See listen(const std::string&, const <a class="el" href="classproton_1_1connection__options.html" title="Options for creating a connection. ">connection_options</a>&); </p> </div> </div> @@ -438,8 +511,8 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <p>Run the container in the current thread. </p> <p>The call returns when the container stops. See <code><a class="el" href="classproton_1_1container.html#a1d5932054f172c66000aec9f4ed498df" title="Enable or disable automatic container stop. ">auto_stop()</a></code> and <code><a class="el" href="classproton_1_1container.html#a8c528baf37154d347366083f0f816846" title="Stop the container with an empty error condition. ">stop()</a></code>.</p> -<p><b>C++ versions</b> - With C++11 or later, you can call <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a></code> in multiple threads to create a thread pool. See also <code><a class="el" href="classproton_1_1container.html#ac48e94529e54c7e7342fde28b26d9f48" title="Run the container with a pool of count threads. ">run(int count)</a></code>. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#a27">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#a21">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#a15">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a19">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#a20">helloworld.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#a19">helloworld_direct.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#a21">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#a22">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#a19">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#a17">scheduled_send_03.cpp</a>, <a class="el" href="server_8cpp-example.html#a17">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#a19">server_dir ect.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a29">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#a17">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a20">simple_send.cpp</a>.</dd> +<p><b>C++ versions</b> - With C++11 or later, you can call <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a></code> in multiple threads to create a thread pool. See also <code><a class="el" href="classproton_1_1container.html#ac48e94529e54c7e7342fde28b26d9f48" title="Run the container with a pool of count threads, including the current thread. ">run(int count)</a></code>. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="client_8cpp-example.html#a21">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#a15">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a17">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#a18">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#a21">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#a22">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#a19">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#a17">scheduled_send_03.cpp</a>, <a class="el" href="server_8cpp-example.html#a14">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#a19">server_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a32">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#a17">simple_rec v.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a20">simple_send.cpp</a>.</dd> </dl> </div> </div> @@ -459,7 +532,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </table> </div><div class="memdoc"> -<p>Run the container with a pool of <code>count</code> threads. </p> +<p>Run the container with a pool of <code>count</code> threads, including the current thread. </p> <p><b>C++ versions</b> - Available with C++11 or later.</p> <p>The call returns when the container stops. See <code><a class="el" href="classproton_1_1container.html#a1d5932054f172c66000aec9f4ed498df" title="Enable or disable automatic container stop. ">auto_stop()</a></code> and <code><a class="el" href="classproton_1_1container.html#a8c528baf37154d347366083f0f816846" title="Stop the container with an empty error condition. ">stop()</a></code>. </p> @@ -508,11 +581,12 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <ul> <li>Abort all open connections and listeners.</li> <li>Process final handler events and queued work.</li> -<li>If <code>!err.empty()</code>, fire <code><a class="el" href="classproton_1_1messaging__handler.html#af89551ce0e44ae3465d4b078f1c87653" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error</a></code>.</li> +<li>If <code>!err.empty()</code>, fire <code><a class="el" href="classproton_1_1messaging__handler.html#ab719e98555bab69986acf4ab1fe43665" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error</a></code>.</li> </ul> <p>When the process is complete, <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a></code> returns in all threads.</p> -<p><b>Thread safety</b> - It is safe to call this method across threads. </p> - +<p><b>Thread safety</b> - It is safe to call this method in any thread. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#a26">broker.cpp</a>.</dd> +</dl> </div> </div> <a id="a8c528baf37154d347366083f0f816846"></a> @@ -535,10 +609,10 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <ul> <li>Abort all open connections and listeners.</li> <li>Process final handler events and queued work.</li> -<li>If <code>!err.empty()</code>, fire <code><a class="el" href="classproton_1_1messaging__handler.html#af89551ce0e44ae3465d4b078f1c87653" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error</a></code>.</li> +<li>If <code>!err.empty()</code>, fire <code><a class="el" href="classproton_1_1messaging__handler.html#ab719e98555bab69986acf4ab1fe43665" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error</a></code>.</li> </ul> <p>When the process is complete, <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Run the container in the current thread. ">run()</a></code> returns in all threads.</p> -<p><b>Thread safety</b> - It is safe to call this method across threads. </p> +<p><b>Thread safety</b> - It is safe to call this method in any thread. </p> </div> </div> @@ -560,7 +634,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <p>Open a connection and sender for <code>addr_url</code>. </p> <p><b>Thread safety</b> - Container method return values are <em>thread-unsafe</em>. A single-threaded application can safely assign the <code>returned<T></code> value to a plain <code>T</code>. A multithreaded application <em>must</em> ignore the returned value because it may already be invalid by the time the function returns. Multithreaded applications can safely access the value inside <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> functions. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="client_8cpp-example.html#a7">client.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#a5">helloworld_direct.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#a4">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#a7">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#a6">scheduled_send_03.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a23">service_bus.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a7">simple_send.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="client_8cpp-example.html#a7">client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#a4">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#a7">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#a6">scheduled_send_03.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a26">service_bus.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a7">simple_send.cpp</a>.</dd> </dl> </div> </div> @@ -807,7 +881,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Connection options applied to outgoing connections. </p> -<p>These are applied first and then overriden by any options provided in <code><a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer. ">connect()</a></code> or <code><a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> +<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer. ">connect()</a></code> or <code><a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> </div> </div> @@ -827,7 +901,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Connection options applied to outgoing connections. </p> -<p>These are applied first and then overriden by any options provided in <code><a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer. ">connect()</a></code> or <code><a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> +<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1" title="Connect to conn_url and send an open request to the remote peer. ">connect()</a></code> or <code><a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> </div> </div> @@ -848,7 +922,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Connection options applied to incoming connections. </p> -<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen()</a></code>, <code><a class="el" href="classproton_1_1listen__handler.html#a0936d46edbbecedf7eed44a19677b39b" title="Called for each accepted connection. ">listen_handler::on_accept()</a></code>, or <code><a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> +<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen()</a></code>, <code><a class="el" href="classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc" title="Called for each accepted connection. ">listen_handler::on_accept()</a></code>, or <code><a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> </div> </div> @@ -868,7 +942,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Connection options applied to incoming connections. </p> -<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen()</a></code>, <code><a class="el" href="classproton_1_1listen__handler.html#a0936d46edbbecedf7eed44a19677b39b" title="Called for each accepted connection. ">listen_handler::on_accept()</a></code>, or <code><a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> +<p>These are applied first and then overridden by any options provided in <code><a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">listen()</a></code>, <code><a class="el" href="classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc" title="Called for each accepted connection. ">listen_handler::on_accept()</a></code>, or <code><a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a></code>. </p> </div> </div> @@ -889,7 +963,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Sender options applied to senders created by this container. </p> -<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a0b5d066e5463d3365f662c8a7dc52661" title="The remote peer opened the link. ">messaging_handler::on_sender_open()</a></code> and can be overridden. </p> +<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#ac655d56c64574c9eb7b10e80d32764f4" title="The remote peer opened the link. ">messaging_handler::on_sender_open()</a></code> and can be overridden. </p> </div> </div> @@ -909,7 +983,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Sender options applied to senders created by this container. </p> -<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a0b5d066e5463d3365f662c8a7dc52661" title="The remote peer opened the link. ">messaging_handler::on_sender_open()</a></code> and can be overridden. </p> +<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#ac655d56c64574c9eb7b10e80d32764f4" title="The remote peer opened the link. ">messaging_handler::on_sender_open()</a></code> and can be overridden. </p> </div> </div> @@ -930,7 +1004,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Receiver options applied to receivers created by this container. </p> -<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a768b0a50669aa1d512d12e9d68af14cd" title="The remote peer opened the link. ">messaging_handler::on_receiver_open()</a></code> and can be overridden. </p> +<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a77f7e38659ee43ccb764e417ad6dd401" title="The remote peer opened the link. ">messaging_handler::on_receiver_open()</a></code> and can be overridden. </p> </div> </div> @@ -950,7 +1024,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </div><div class="memdoc"> <p>Receiver options applied to receivers created by this container. </p> -<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a768b0a50669aa1d512d12e9d68af14cd" title="The remote peer opened the link. ">messaging_handler::on_receiver_open()</a></code> and can be overridden. </p> +<p>They are applied before <code><a class="el" href="classproton_1_1messaging__handler.html#a77f7e38659ee43ccb764e417ad6dd401" title="The remote peer opened the link. ">messaging_handler::on_receiver_open()</a></code> and can be overridden. </p> </div> </div> @@ -969,7 +1043,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="classproton_1_1work.html">work</a> </td> + <td class="paramtype">work </td> <td class="paramname"><em>fn</em> </td> </tr> <tr> @@ -983,7 +1057,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre <p>Schedule <code>fn</code> for execution after a duration. </p> <p>The piece of work can be created from a function object.</p> <p><b>C++ versions</b> - With C++11 and later, use a <code>std::function<void()></code> type for the <code>fn</code> parameter. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="scheduled_send_8cpp-example.html#a11">scheduled_send.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#a16">service_bus.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="scheduled_send_8cpp-example.html#a11">scheduled_send.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#a17">service_bus.cpp</a>.</dd> </dl> </div> </div>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.js b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.js index 3cde08a..974abec 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.js +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1container.js @@ -1,7 +1,9 @@ var classproton_1_1container = [ - [ "container", "classproton_1_1container.html#a822ca363beceb76ffdc5ce370a4f9356", null ], - [ "container", "classproton_1_1container.html#aa73c3a48d397b513182a2d90ba5ab686", null ], + [ "container", "classproton_1_1container.html#a9a322df81c8d397bb4c3fa6c1a67a496", null ], + [ "container", "classproton_1_1container.html#a3d7f4be6b8ace086ed7470f66a742059", null ], + [ "container", "classproton_1_1container.html#a88125a4442a7b28fab97a89587627c0f", null ], + [ "container", "classproton_1_1container.html#aeacc0140de439ebab9a5466c45d38191", null ], [ "~container", "classproton_1_1container.html#a7c64e64cedfa36303be53f0f581d1d24", null ], [ "connect", "classproton_1_1container.html#adbd9ed231804512a47cca3c81f00cdf1", null ], [ "connect", "classproton_1_1container.html#a422bf1e05b6a01039f0ef603b2f165a4", null ], @@ -30,5 +32,6 @@ var classproton_1_1container = [ "sender_options", "classproton_1_1container.html#ae7bfc8d811be7f6be17be6cf15e35b4a", null ], [ "receiver_options", "classproton_1_1container.html#a2e01779c75286d270f579a28dae14d37", null ], [ "receiver_options", "classproton_1_1container.html#a099ddaa3cfcd6a8ae14401bbbfb4b660", null ], - [ "schedule", "classproton_1_1container.html#aa99ede2051ccdf5fe8257d893559ea26", null ] + [ "schedule", "classproton_1_1container.html#aa99ede2051ccdf5fe8257d893559ea26", null ], + [ "schedule", "classproton_1_1container.html#a3e20a15733ef55ac0c43fbe1e60813d4", null ] ]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1delivery.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1delivery.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1delivery.html index 306fced..419b4a3 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1delivery.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1delivery.html @@ -181,7 +181,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="clas <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A received message. </p> <p>A delivery attempt can fail. As a result, a particular message may correspond to multiple deliveries. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a16">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a18">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a6">direct_recv.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a16">helloworld.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#_a12">helloworld_direct.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a18">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a21">multithreaded_client_flow_control.cpp</a>, <a class="el" href="server_8cpp-example.html#_a9">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a12">server_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a18">service_bus.cpp</a>, and <a class="el" href="simple_recv_8cpp-example.html#_a9">simple_recv.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a14">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a18">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a6">direct_recv.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a14">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a18">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a21">multithreaded_client_flow_control.cpp</a>, <a class="el" href="server_8cpp-example.html#_a7">server.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a12">server_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a21">service_bus.cpp</a>, and <a class="el" href="simple_recv_8cpp-example.html#_a9">simple_recv.cpp</a>.</dd> </dl></div><h2 class="groupheader">Member Enumeration Documentation</h2> <a id="adc6e5733fc3c22f0a7b2914188c49c90"></a> <h2 class="memtitle"><span class="permalink"><a href="#adc6e5733fc3c22f0a7b2914188c49c90">◆ </a></span>state</h2> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration-members.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration-members.html index 51df64a..ac8e3ef 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration-members.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration-members.html @@ -99,11 +99,12 @@ $(document).ready(function(){initNavTree('classproton_1_1duration.html','');}); <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#aa4fb0163afbe72b04236e39e2b6d2dbf">duration</a>(numeric_type ms=0)</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#acebdd3ee364870f89665ca128e97a4d7">FOREVER</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#ab804de8e95dd6203d6e72e797440055e">IMMEDIATE</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>() const</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0">MINUTE</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> typedef</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#a13ff6465e0979fe301b75ea574ce2304">operator=</a>(numeric_type ms)</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562">SECOND</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#ad936986f8cf9cb95b0dbc93ade000b76">MILLISECOND</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>() const</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0">MINUTE</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> typedef</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1duration.html#a13ff6465e0979fe301b75ea574ce2304">operator=</a>(numeric_type ms)</td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562">SECOND</a></td><td class="entry"><a class="el" href="classproton_1_1duration.html">duration</a></td><td class="entry"><span class="mlabel">static</span></td></tr> </table></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration.html index 193c0df..52c0002 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1duration.html @@ -148,6 +148,10 @@ static const <a class="el" href="classproton_1_1duration.html">duration</a>  static const <a class="el" href="classproton_1_1duration.html">duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562">SECOND</a></td></tr> <tr class="memdesc:aced1c394edccf069b2748d46965fb562"><td class="mdescLeft"> </td><td class="mdescRight">One second. <br /></td></tr> <tr class="separator:aced1c394edccf069b2748d46965fb562"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad936986f8cf9cb95b0dbc93ade000b76"><td class="memItemLeft" align="right" valign="top"><a id="ad936986f8cf9cb95b0dbc93ade000b76"></a> +static const <a class="el" href="classproton_1_1duration.html">duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1duration.html#ad936986f8cf9cb95b0dbc93ade000b76">MILLISECOND</a></td></tr> +<tr class="memdesc:ad936986f8cf9cb95b0dbc93ade000b76"><td class="mdescLeft"> </td><td class="mdescRight">One millisecond. <br /></td></tr> +<tr class="separator:ad936986f8cf9cb95b0dbc93ade000b76"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a437a5e5f6a7d0c8780f3594b2272cba0"><td class="memItemLeft" align="right" valign="top"><a id="a437a5e5f6a7d0c8780f3594b2272cba0"></a> static const <a class="el" href="classproton_1_1duration.html">duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0">MINUTE</a></td></tr> <tr class="memdesc:a437a5e5f6a7d0c8780f3594b2272cba0"><td class="mdescLeft"> </td><td class="mdescRight">One minute. <br /></td></tr> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1error__condition.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1error__condition.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1error__condition.html index e2fb2e7..29d08ee 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1error__condition.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1error__condition.html @@ -148,7 +148,7 @@ std::string </td><td class="memItemRight" valign="bottom"><a class="el" hre </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Describes an endpoint error state. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a23">broker.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a20">multithreaded_client.cpp</a>, and <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a16">multithreaded_client_flow_control.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a27">broker.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a20">multithreaded_client.cpp</a>, and <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a16">multithreaded_client_flow_control.cpp</a>.</dd> </dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a4f32954b9494f55fa28e99c3402f254b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4f32954b9494f55fa28e99c3402f254b">◆ </a></span>error_condition() <span class="overload">[1/2]</span></h2> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1io_1_1connection__driver.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1io_1_1connection__driver.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1io_1_1connection__driver.html index 28c3b47..728bb1c 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1io_1_1connection__driver.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1io_1_1connection__driver.html @@ -243,7 +243,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="clas <p>Call <a class="el" href="classproton_1_1io_1_1connection__driver.html#a86d2b78bee258ce7bb56806d11a122d3" title="Configure a connection by applying exactly the options in opts (including proton::messaging_handler) ...">configure()</a> with server options. </p> <p>Options applied: <a class="el" href="classproton_1_1container.html#a4c5cdd8165762b000c6518db56830677" title="A unique identifier for the container. ">container::id()</a>, <a class="el" href="classproton_1_1container.html#a7daf70330e5259fbb6ae3f01cfbc125a" title="Connection options applied to incoming connections. ">container::server_connection_options()</a>, opts.</p> -<p>Note this does not call <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a>. If there is a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">messaging_handler</a> in the composed options it will receive <a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a> and can respond with <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a> or <a class="el" href="classproton_1_1connection.html#a5ae591df94fc66ccb85cbb6565368bca" title="Close the endpoint. ">connection::close()</a> </p> +<p>Note this does not call <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a>. If there is a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">messaging_handler</a> in the composed options it will receive <a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a> and can respond with <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a> or <a class="el" href="classproton_1_1connection.html#a5ae591df94fc66ccb85cbb6565368bca" title="Close the endpoint. ">connection::close()</a> </p> </div> </div> @@ -407,7 +407,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="clas </div><div class="memdoc"> <p>Inform the engine that the transport been disconnected unexpectedly, without completing the AMQP connection close sequence. </p> -<p>This calls <a class="el" href="classproton_1_1io_1_1connection__driver.html#aaa622a6fed072f5b4935881efb42ba5c" title="Indicate that the read side of the transport is closed and no more data will be read. ">read_close()</a>, <a class="el" href="classproton_1_1io_1_1connection__driver.html#ad730a1d850ea31f35102b765d0eede4a" title="Indicate that the write side of the transport has closed and no more data can be written. ">write_close()</a>, sets the <a class="el" href="classproton_1_1io_1_1connection__driver.html#ae6bd8677ca01c17bc04d6064bbc2c394" title="Get the transport associated with this connection_driver. ">transport()</a>.error() and queues an <code>on_transport_error</code> event. You must call <a class="el" href="classproton_1_1io_1_1connection__driver.html#a4c79ad1c9029d967b9e1b4daf91b7537" title="Dispatch all available events and call the corresponding messaging_handler methods. ">dispatch()</a> one more time to dispatch the <a class="el" href="classproton_1_1messaging__h andler.html#af89551ce0e44ae3465d4b078f1c87653" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error()</a> call and other final events.</p> +<p>This calls <a class="el" href="classproton_1_1io_1_1connection__driver.html#aaa622a6fed072f5b4935881efb42ba5c" title="Indicate that the read side of the transport is closed and no more data will be read. ">read_close()</a>, <a class="el" href="classproton_1_1io_1_1connection__driver.html#ad730a1d850ea31f35102b765d0eede4a" title="Indicate that the write side of the transport has closed and no more data can be written. ">write_close()</a>, sets the <a class="el" href="classproton_1_1io_1_1connection__driver.html#ae6bd8677ca01c17bc04d6064bbc2c394" title="Get the transport associated with this connection_driver. ">transport()</a>.error() and queues an <code>on_transport_error</code> event. You must call <a class="el" href="classproton_1_1io_1_1connection__driver.html#a4c79ad1c9029d967b9e1b4daf91b7537" title="Dispatch all available events and call the corresponding messaging_handler methods. ">dispatch()</a> one more time to dispatch the <a class="el" href="classproton_1_1messaging__h andler.html#ab719e98555bab69986acf4ab1fe43665" title="The underlying network transport has closed with an error condition. ">messaging_handler::on_transport_error()</a> call and other final events.</p> <p>Note this does not close the <a class="el" href="classproton_1_1io_1_1connection__driver.html#a8239782294f4dacf38c46a2640e55bf0" title="Get the AMQP connection associated with this connection_driver. ">connection()</a> so that a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a> can distinguish between a connection close error sent by the remote peer and a transport failure. </p> </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1link.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1link.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1link.html index 7f0a924..113f517 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1link.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1link.html @@ -203,7 +203,7 @@ class <a class="el" href="classproton_1_1session.html">session</a> </td><td <dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl> <p>Implements <a class="el" href="classproton_1_1endpoint.html#af6ee7eacbde6b379b68d954e44f6e549">endpoint</a>.</p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_recv_8cpp-example.html#a11">direct_recv.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#a14">helloworld.cpp</a>, <a class="el" href="helloworld_direct_8cpp-example.html#a10">helloworld_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a20">service_bus.cpp</a>, and <a class="el" href="simple_recv_8cpp-example.html#a14">simple_recv.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_recv_8cpp-example.html#a11">direct_recv.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#a12">helloworld.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a23">service_bus.cpp</a>, and <a class="el" href="simple_recv_8cpp-example.html#a14">simple_recv.cpp</a>.</dd> </dl> </div> </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler-members.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler-members.html index 9703a0b..bb6db74 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler-members.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler-members.html @@ -96,10 +96,11 @@ $(document).ready(function(){initNavTree('classproton_1_1listen__handler.html',' <p>This is the complete list of members for <a class="el" href="classproton_1_1listen__handler.html">listen_handler</a>, including all inherited members.</p> <table class="directory"> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#a0936d46edbbecedf7eed44a19677b39b">on_accept</a>(listener &)=0</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#af30c2c3ffe8921962a164abb1b2a398e">on_close</a>(listener &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#a0969610957fd465626cfad89db38ef53">on_error</a>(listener &, const std::string &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>~listen_handler</b>() (defined in <a class="el" href="classproton_1_1listen__handler.html">listen_handler</a>)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc">on_accept</a>(listener &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#af30c2c3ffe8921962a164abb1b2a398e">on_close</a>(listener &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#a0969610957fd465626cfad89db38ef53">on_error</a>(listener &, const std::string &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1listen__handler.html#a74a2a66bb05107bd04fbb15731b0578b">on_open</a>(listener &)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~listen_handler</b>() (defined in <a class="el" href="classproton_1_1listen__handler.html">listen_handler</a>)</td><td class="entry"><a class="el" href="classproton_1_1listen__handler.html">listen_handler</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.html index ce37de4..3a7140d 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.html @@ -93,7 +93,7 @@ $(document).ready(function(){initNavTree('classproton_1_1listen__handler.html',' <a href="#pub-methods">Public Member Functions</a> | <a href="classproton_1_1listen__handler-members.html">List of all members</a> </div> <div class="headertitle"> -<div class="title">listen_handler<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +<div class="title">listen_handler</div> </div> </div><!--header--> <div class="contents"> @@ -104,9 +104,13 @@ $(document).ready(function(){initNavTree('classproton_1_1listen__handler.html',' <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr class="memitem:a0936d46edbbecedf7eed44a19677b39b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classproton_1_1connection__options.html">connection_options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listen__handler.html#a0936d46edbbecedf7eed44a19677b39b">on_accept</a> (<a class="el" href="classproton_1_1listener.html">listener</a> &)=0</td></tr> -<tr class="memdesc:a0936d46edbbecedf7eed44a19677b39b"><td class="mdescLeft"> </td><td class="mdescRight">Called for each accepted connection. <a href="#a0936d46edbbecedf7eed44a19677b39b">More...</a><br /></td></tr> -<tr class="separator:a0936d46edbbecedf7eed44a19677b39b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74a2a66bb05107bd04fbb15731b0578b"><td class="memItemLeft" align="right" valign="top"><a id="a74a2a66bb05107bd04fbb15731b0578b"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listen__handler.html#a74a2a66bb05107bd04fbb15731b0578b">on_open</a> (<a class="el" href="classproton_1_1listener.html">listener</a> &)</td></tr> +<tr class="memdesc:a74a2a66bb05107bd04fbb15731b0578b"><td class="mdescLeft"> </td><td class="mdescRight">Called when the listener is opened successfully. <br /></td></tr> +<tr class="separator:a74a2a66bb05107bd04fbb15731b0578b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3f8b8dc9641dc3a3ed19e2a60ec8eccc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classproton_1_1connection__options.html">connection_options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc">on_accept</a> (<a class="el" href="classproton_1_1listener.html">listener</a> &)</td></tr> +<tr class="memdesc:a3f8b8dc9641dc3a3ed19e2a60ec8eccc"><td class="mdescLeft"> </td><td class="mdescRight">Called for each accepted connection. <a href="#a3f8b8dc9641dc3a3ed19e2a60ec8eccc">More...</a><br /></td></tr> +<tr class="separator:a3f8b8dc9641dc3a3ed19e2a60ec8eccc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0969610957fd465626cfad89db38ef53"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listen__handler.html#a0969610957fd465626cfad89db38ef53">on_error</a> (<a class="el" href="classproton_1_1listener.html">listener</a> &, const std::string &)</td></tr> <tr class="memdesc:a0969610957fd465626cfad89db38ef53"><td class="mdescLeft"> </td><td class="mdescRight">Called if there is a listening error, with an error message. <a href="#a0969610957fd465626cfad89db38ef53">More...</a><br /></td></tr> <tr class="separator:a0969610957fd465626cfad89db38ef53"><td class="memSeparator" colspan="2"> </td></tr> @@ -118,10 +122,10 @@ virtual void </td><td class="memItemRight" valign="bottom"><a class="el" hr <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><b>Unsettled API</b> - A handler for incoming connections. </p> <p>Implement this interface and pass to <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url. ">proton::container::listen()</a> to be notified of new connections. </p> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a28">broker.cpp</a>.</dd> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a34">broker.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a1">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#_a1">direct_send.cpp</a>, and <a class="el" href="server_direct_8cpp-example.html#_a1">server_direct.cpp</a>.</dd> </dl></div><h2 class="groupheader">Member Function Documentation</h2> -<a id="a0936d46edbbecedf7eed44a19677b39b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a0936d46edbbecedf7eed44a19677b39b">◆ </a></span>on_accept()</h2> +<a id="a3f8b8dc9641dc3a3ed19e2a60ec8eccc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3f8b8dc9641dc3a3ed19e2a60ec8eccc">◆ </a></span>on_accept()</h2> <div class="memitem"> <div class="memproto"> @@ -139,13 +143,13 @@ virtual void </td><td class="memItemRight" valign="bottom"><a class="el" hr </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Called for each accepted connection. </p> -<p>Returns <a class="el" href="classproton_1_1connection__options.html" title="Options for creating a connection. ">connection_options</a> to apply, including a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a> for the connection. <a class="el" href="classproton_1_1messaging__handler.html#a16ba022e899957b2e25b9561b1f53968" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a> will be called with the <a class="el" href="classproton_1_1connection.html" title="A connection to a remote AMQP peer. ">proton::connection</a>, it can call <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a> to accept or <a class="el" href="classproton_1_1connection.html#a5ae591df94fc66ccb85cbb6565368bca" title="Close the endpoint. ">connection::close()</a> to reject the connection. </p> +<p>Returns <a class="el" href="classproton_1_1connection__options.html" title="Options for creating a connection. ">connection_options</a> to apply, including a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a> for the connection. <a class="el" href="classproton_1_1messaging__handler.html#a41277abe0e33a3df2764b08dcc12d768" title="The remote peer opened the connection. ">messaging_handler::on_connection_open()</a> will be called with the <a class="el" href="classproton_1_1connection.html" title="A connection to a remote AMQP peer. ">proton::connection</a>, it can call <a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab" title="Open the connection. ">connection::open()</a> to accept or <a class="el" href="classproton_1_1connection.html#a5ae591df94fc66ccb85cbb6565368bca" title="Close the endpoint. ">connection::close()</a> to reject the connection. </p> </div> </div> @@ -178,7 +182,7 @@ virtual void </td><td class="memItemRight" valign="bottom"><a class="el" hr </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.js b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.js index 276f396..f42ae05 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.js +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listen__handler.js @@ -1,7 +1,8 @@ var classproton_1_1listen__handler = [ [ "~listen_handler", "classproton_1_1listen__handler.html#a75bbe826066a9de53aec34a3e858f24b", null ], - [ "on_accept", "classproton_1_1listen__handler.html#a0936d46edbbecedf7eed44a19677b39b", null ], + [ "on_open", "classproton_1_1listen__handler.html#a74a2a66bb05107bd04fbb15731b0578b", null ], + [ "on_accept", "classproton_1_1listen__handler.html#a3f8b8dc9641dc3a3ed19e2a60ec8eccc", null ], [ "on_error", "classproton_1_1listen__handler.html#a0969610957fd465626cfad89db38ef53", null ], [ "on_close", "classproton_1_1listen__handler.html#af30c2c3ffe8921962a164abb1b2a398e", null ] ]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listener-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listener-members.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listener-members.html index b366115..c457cba 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listener-members.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1listener-members.html @@ -97,8 +97,13 @@ $(document).ready(function(){initNavTree('classproton_1_1listener.html','');}); <p>This is the complete list of members for <a class="el" href="classproton_1_1listener.html">listener</a>, including all inherited members.</p> <table class="directory"> <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>container</b> (defined in <a class="el" href="classproton_1_1listener.html">listener</a>)</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"><span class="mlabel">friend</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1listener.html#a59dc4506a73a3d4ae084b5fc1d014814">listener</a>()</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1listener.html#a2f632b80247e868b8264b8a025b84baf">container</a>() const</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listener.html#a59dc4506a73a3d4ae084b5fc1d014814">listener</a>()</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1listener.html#a3edec85cbcde06b471e8e2fb4726dbf5">listener</a>(const listener &)</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listener.html#a426fa804e3bb58ef90b29b066c3f5199">operator=</a>(const listener &)</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1listener.html#a0a3b88007d7cb5fa8d890376c5a8b102">port</a>()</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classproton_1_1listener.html#a8c528baf37154d347366083f0f816846">stop</a>()</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~listener</b>() (defined in <a class="el" href="classproton_1_1listener.html">listener</a>)</td><td class="entry"><a class="el" href="classproton_1_1listener.html">listener</a></td><td class="entry"></td></tr> </table></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
