qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jr...@apache.org
Subject svn commit: r1739159 [24/45] - in /qpid/site/docs/releases/qpid-proton-master: ./ proton/c/api/ proton/c/api/search/ proton/cpp/api/ proton/cpp/api/search/ proton/cpp/examples/ proton/java/api/ proton/java/api/org/apache/qpid/proton/engine/ proton/java...
Date Thu, 14 Apr 2016 18:29:38 GMT
Modified: qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.html?rev=1739159&r1=1739158&r2=1739159&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.html (original)
+++ qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.html Thu Apr 14 18:29:35 2016
@@ -96,69 +96,59 @@ $(document).ready(function(){initNavTree
 <div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1acceptor.html" target="_self">acceptor</a></td><td class="desc">A context for accepting inbound connections </td></tr>
-<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1annotation__key.html" target="_self">annotation_key</a></td><td class="desc">A key for use with AMQP annotation maps </td></tr>
-<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>basic_string&lt; Char &gt;</b></td><td class="desc">STL class </td></tr>
-<tr id="row_2_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_2_0_" class="arrow" onclick="toggleFolder('2_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>string</b></td><td class="desc">STL class </td></tr>
-<tr id="row_2_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1symbol.html" target="_self">symbol</a></td><td class="desc">Symbol is a std::string that represents the AMQP symbol type </td></tr>
-<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; T &gt;</a></td><td class="desc">Base class for comparable types with operator&lt; and operator== </td></tr>
-<tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; byte_array&lt; N &gt; &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_4_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_0_" class="arrow" onclick="toggleFolder('4_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 16 &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_4_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal128.html" target="_self">decimal128</a></td><td class="desc">128-bit decimal floating point </td></tr>
-<tr id="row_4_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1uuid.html" target="_self">uuid</a></td><td class="desc">A 16-byte universally unique identifier </td></tr>
-<tr id="row_4_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_1_" class="arrow" onclick="toggleFolder('4_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 4 &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_4_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal32.html" target="_self">decimal32</a></td><td class="desc">32-bit decimal floating point </td></tr>
-<tr id="row_4_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_2_" class="arrow" onclick="toggleFolder('4_2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 8 &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_4_2_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal64.html" target="_self">decimal64</a></td><td class="desc">64-bit decimal floating point </td></tr>
-<tr id="row_4_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; N &gt;</a></td><td class="desc">Used to represent fixed-sized data types that don't have a natural C++ representation as an array of bytes </td></tr>
-<tr id="row_5_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; duration &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_5_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1duration.html" target="_self">duration</a></td><td class="desc">A span of time in milliseconds </td></tr>
-<tr id="row_6_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_6_" class="arrow" onclick="toggleFolder('6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; scalar &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_6_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1scalar.html" target="_self">scalar</a></td><td class="desc">A holder for an instance of any scalar AMQP type </td></tr>
-<tr id="row_7_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_7_" class="arrow" onclick="toggleFolder('7_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; timestamp &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_7_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1timestamp.html" target="_self">timestamp</a></td><td class="desc">A timestamp in milliseconds since the epoch 00:00:00 (UTC), 1 January 1970 </td></tr>
-<tr id="row_8_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_8_" class="arrow" onclick="toggleFolder('8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1comparable.html" target="_self">comparable&lt; value &gt;</a></td><td class="desc"></td></tr>
-<tr id="row_8_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1value.html" target="_self">value</a></td><td class="desc">A holder for any single AMQP value, simple or complex (can be list, array, map etc.) </td></tr>
-<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1condition.html" target="_self">condition</a></td><td class="desc">Describes an endpoint error state </td></tr>
-<tr id="row_10_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_10_" class="arrow" onclick="toggleFolder('10_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1connection__engine.html" target="_self">connection_engine</a></td><td class="desc">An interface for connection-oriented IO integration </td></tr>
-<tr id="row_10_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1socket__engine.html" target="_self">socket_engine</a></td><td class="desc">A <a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">connection_engine</a> for socket-based IO </td></tr>
-<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1connection__options.html" target="_self">connection_options</a></td><td class="desc">Options for creating a connection </td></tr>
-<tr id="row_12_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1container.html" target="_self">container</a></td><td class="desc">A top-level container of connections, sessions, and links </td></tr>
-<tr id="row_13_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_13_" class="arrow" onclick="toggleFolder('13_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1codec_1_1data.html" target="_self">data</a></td><td class="desc">Wrapper for a proton data object </td></tr>
-<tr id="row_13_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1codec_1_1encoder.html" target="_self">encoder</a></td><td class="desc">Stream-like encoder from AMQP bytes to C++ values </td></tr>
-<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1delivery.html" target="_self">delivery</a></td><td class="desc">A message transfer </td></tr>
-<tr id="row_15_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_15_" class="arrow" onclick="toggleFolder('15_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1endpoint.html" target="_self">endpoint</a></td><td class="desc">The base class for session, connection, and link </td></tr>
-<tr id="row_15_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1connection.html" target="_self">connection</a></td><td class="desc">A connection to a remote AMQP peer </td></tr>
-<tr id="row_15_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_15_1_" class="arrow" onclick="toggleFolder('15_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link.html" target="_self">link</a></td><td class="desc">A named channel for sending or receiving messages </td></tr>
-<tr id="row_15_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1receiver.html" target="_self">receiver</a></td><td class="desc">A link for receiving messages </td></tr>
-<tr id="row_15_1_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1sender.html" target="_self">sender</a></td><td class="desc">A link for sending messages </td></tr>
-<tr id="row_15_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1session.html" target="_self">session</a></td><td class="desc">A container of links </td></tr>
-<tr id="row_16_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1event.html" target="_self">event</a></td><td class="desc">A context for a proton event </td></tr>
-<tr id="row_17_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_17_" class="arrow" onclick="toggleFolder('17_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>exception</b></td><td class="desc">STL class </td></tr>
-<tr id="row_17_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_17_0_" class="arrow" onclick="toggleFolder('17_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>runtime_error</b></td><td class="desc">STL class </td></tr>
-<tr id="row_17_0_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_17_0_0_" class="arrow" onclick="toggleFolder('17_0_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1error.html" target="_self">error</a></td><td class="desc">The base proton error </td></tr>
-<tr id="row_17_0_0_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1connection__engine_1_1io__error.html" target="_self">connection_engine::io_error</a></td><td class="desc">Thrown by io_read and io_write functions to indicate an error </td></tr>
-<tr id="row_17_0_0_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1conversion__error.html" target="_self">conversion_error</a></td><td class="desc">Raised if there is an error converting between AMQP and C++ data </td></tr>
-<tr id="row_17_0_0_2_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1timeout__error.html" target="_self">timeout_error</a></td><td class="desc">Raised if a timeout expires </td></tr>
-<tr id="row_17_0_0_3_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1url__error.html" target="_self">url_error</a></td><td class="desc">Raised if URL parsing fails </td></tr>
-<tr id="row_18_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1codec_1_1finish.html" target="_self">finish</a></td><td class="desc">Finish inserting or extracting a complex type </td></tr>
-<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1io_1_1guard.html" target="_self">guard</a></td><td class="desc">Use to call <a class="el" href="namespaceproton_1_1io.html#a3601dea170e834a9c1307bc331552b86" title="Initialize the proton::io subsystem. ">io::initialize</a> and <a class="el" href="namespaceproton_1_1io.html#aef633964c19985551081435baaabc9eb" title="Finalize the proton::io subsystem. ">io::finalize</a> around a scope </td></tr>
-<tr id="row_20_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1handler.html" target="_self">handler</a></td><td class="desc">Callback functions for handling proton events </td></tr>
-<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link__iterator.html" target="_self">link_iterator</a></td><td class="desc">An iterator for links </td></tr>
-<tr id="row_22_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link__options.html" target="_self">link_options</a></td><td class="desc">Options for creating a link </td></tr>
-<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1listener.html" target="_self">listener</a></td><td class="desc">Listening socket </td></tr>
-<tr id="row_24_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1message.html" target="_self">message</a></td><td class="desc">An AMQP message </td></tr>
-<tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1message__id.html" target="_self">message_id</a></td><td class="desc">An AMQP message ID </td></tr>
-<tr id="row_26_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1codec_1_1narrow__guard.html" target="_self">narrow_guard</a></td><td class="desc">Narrow the data object, widen it in dtor </td></tr>
-<tr id="row_27_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1sasl.html" target="_self">sasl</a></td><td class="desc">SASL information </td></tr>
-<tr id="row_28_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1session__iterator.html" target="_self">session_iterator</a></td><td class="desc">An iterator for sessions </td></tr>
-<tr id="row_29_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl.html" target="_self">ssl</a></td><td class="desc">SSL information </td></tr>
-<tr id="row_30_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl__client__options.html" target="_self">ssl_client_options</a></td><td class="desc">SSL configuration for outbound connections </td></tr>
-<tr id="row_31_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl__server__options.html" target="_self">ssl_server_options</a></td><td class="desc">SSL configuration for inbound connections </td></tr>
-<tr id="row_32_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1codec_1_1state__guard.html" target="_self">state_guard</a></td><td class="desc">State_guard saves the state and restores it in dtor unless cancel() is called </td></tr>
-<tr id="row_33_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1terminus.html" target="_self">terminus</a></td><td class="desc">One end of a link, either a source or a target </td></tr>
-<tr id="row_34_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1url.html" target="_self">url</a></td><td class="desc">A proton URL </td></tr>
-<tr id="row_35_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_35_" class="arrow" onclick="toggleFolder('35_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>vector&lt; T &gt;</b></td><td class="desc">STL class </td></tr>
-<tr id="row_35_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1binary.html" target="_self">binary</a></td><td class="desc">Arbitrary binary data </td></tr>
+<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>basic_string&lt; Char &gt;</b></td><td class="desc">STL class </td></tr>
+<tr id="row_1_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>string</b></td><td class="desc">STL class </td></tr>
+<tr id="row_1_0_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1symbol.html" target="_self">symbol</a></td><td class="desc">Symbol is a std::string that represents the AMQP symbol type </td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; N &gt;</a></td><td class="desc">Used to represent fixed-sized data types that don't have a natural C++ representation as an array of bytes </td></tr>
+<tr id="row_3_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 16 &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal128.html" target="_self">decimal128</a></td><td class="desc">128-bit decimal floating point </td></tr>
+<tr id="row_3_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1uuid.html" target="_self">uuid</a></td><td class="desc">A 16-byte universally unique identifier </td></tr>
+<tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 4 &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_4_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal32.html" target="_self">decimal32</a></td><td class="desc">32-bit decimal floating point </td></tr>
+<tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array&lt; 8 &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1decimal64.html" target="_self">decimal64</a></td><td class="desc">64-bit decimal floating point </td></tr>
+<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1condition.html" target="_self">condition</a></td><td class="desc">Describes an endpoint error state </td></tr>
+<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1connection__options.html" target="_self">connection_options</a></td><td class="desc">Options for creating a connection </td></tr>
+<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1container.html" target="_self">container</a></td><td class="desc">A top-level container of connections, sessions, and links </td></tr>
+<tr id="row_9_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_9_" class="arrow" onclick="toggleFolder('9_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1codec_1_1data.html" target="_self">data</a></td><td class="desc">Wrapper for a proton data object </td></tr>
+<tr id="row_9_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1codec_1_1decoder.html" target="_self">decoder</a></td><td class="desc">Stream-like decoder from AMQP bytes to C++ values </td></tr>
+<tr id="row_9_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1codec_1_1encoder.html" target="_self">encoder</a></td><td class="desc">Stream-like encoder from AMQP bytes to C++ values </td></tr>
+<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1delivery.html" target="_self">delivery</a></td><td class="desc">A message transfer </td></tr>
+<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1duration.html" target="_self">duration</a></td><td class="desc">A span of time in milliseconds </td></tr>
+<tr id="row_12_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_12_" class="arrow" onclick="toggleFolder('12_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1endpoint.html" target="_self">endpoint</a></td><td class="desc">The base class for session, connection, and link </td></tr>
+<tr id="row_12_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1connection.html" target="_self">connection</a></td><td class="desc">A connection to a remote AMQP peer </td></tr>
+<tr id="row_12_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_12_1_" class="arrow" onclick="toggleFolder('12_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link.html" target="_self">link</a></td><td class="desc">A named channel for sending or receiving messages </td></tr>
+<tr id="row_12_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1receiver.html" target="_self">receiver</a></td><td class="desc">A link for receiving messages </td></tr>
+<tr id="row_12_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1sender.html" target="_self">sender</a></td><td class="desc">A link for sending messages </td></tr>
+<tr id="row_12_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1session.html" target="_self">session</a></td><td class="desc">A container of links </td></tr>
+<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1socket_1_1engine.html" target="_self">engine</a></td><td class="desc">A connection_engine with non-blocking socket IO </td></tr>
+<tr id="row_14_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_14_" class="arrow" onclick="toggleFolder('14_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>exception</b></td><td class="desc">STL class </td></tr>
+<tr id="row_14_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_14_0_" class="arrow" onclick="toggleFolder('14_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>runtime_error</b></td><td class="desc">STL class </td></tr>
+<tr id="row_14_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_14_0_0_" class="arrow" onclick="toggleFolder('14_0_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1error.html" target="_self">error</a></td><td class="desc">The base proton error </td></tr>
+<tr id="row_14_0_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1conversion__error.html" target="_self">conversion_error</a></td><td class="desc">Raised if there is an error converting between AMQP and C++ data </td></tr>
+<tr id="row_14_0_0_1_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1timeout__error.html" target="_self">timeout_error</a></td><td class="desc">Raised if a timeout expires </td></tr>
+<tr id="row_14_0_0_2_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1url__error.html" target="_self">url_error</a></td><td class="desc">Raised if URL parsing fails </td></tr>
+<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1io_1_1socket_1_1guard.html" target="_self">guard</a></td><td class="desc">Use to call io::initialize and io::finalize around a scope </td></tr>
+<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1handler.html" target="_self">handler</a></td><td class="desc">Callback functions for handling proton events </td></tr>
+<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link__iterator.html" target="_self">link_iterator</a></td><td class="desc">An iterator for links </td></tr>
+<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1link__options.html" target="_self">link_options</a></td><td class="desc">Options for creating a link </td></tr>
+<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1socket_1_1listener.html" target="_self">listener</a></td><td class="desc">Listening socket </td></tr>
+<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1message.html" target="_self">message</a></td><td class="desc">An AMQP message </td></tr>
+<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1sasl.html" target="_self">sasl</a></td><td class="desc">SASL information </td></tr>
+<tr id="row_22_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_22_" class="arrow" onclick="toggleFolder('22_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1scalar__base.html" target="_self">scalar_base</a></td><td class="desc">Base class for scalar types </td></tr>
+<tr id="row_22_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1annotation__key.html" target="_self">annotation_key</a></td><td class="desc">A key for use with AMQP annotation maps </td></tr>
+<tr id="row_22_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1message__id.html" target="_self">message_id</a></td><td class="desc">An AMQP message ID </td></tr>
+<tr id="row_22_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1scalar.html" target="_self">scalar</a></td><td class="desc">A holder for an instance of any scalar AMQP type, see <a class="el" href="types.html">AMQP and C++ types</a> </td></tr>
+<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1session__iterator.html" target="_self">session_iterator</a></td><td class="desc">An iterator for sessions </td></tr>
+<tr id="row_24_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl.html" target="_self">ssl</a></td><td class="desc">SSL information </td></tr>
+<tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl__client__options.html" target="_self">ssl_client_options</a></td><td class="desc">SSL configuration for outbound connections </td></tr>
+<tr id="row_26_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl__server__options.html" target="_self">ssl_server_options</a></td><td class="desc">SSL configuration for inbound connections </td></tr>
+<tr id="row_27_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1terminus.html" target="_self">terminus</a></td><td class="desc">One end of a link, either a source or a target </td></tr>
+<tr id="row_28_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1timestamp.html" target="_self">timestamp</a></td><td class="desc">64 bit timestamp in milliseconds since the epoch 00:00:00 (UTC), 1 January 1970 </td></tr>
+<tr id="row_29_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1url.html" target="_self">url</a></td><td class="desc">A proton URL </td></tr>
+<tr id="row_30_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1value.html" target="_self">value</a></td><td class="desc">A holder for any AMQP value, simple or complex, see <a class="el" href="types.html">AMQP and C++ types</a> </td></tr>
+<tr id="row_31_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_31_" class="arrow" onclick="toggleFolder('31_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><b>vector&lt; T &gt;</b></td><td class="desc">STL class </td></tr>
+<tr id="row_31_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1binary.html" target="_self">binary</a></td><td class="desc">Arbitrary binary data </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

Modified: qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.js
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.js?rev=1739159&r1=1739158&r2=1739159&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.js (original)
+++ qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/hierarchy.js Thu Apr 14 18:29:35 2016
@@ -1,48 +1,31 @@
 var hierarchy =
 [
     [ "acceptor", "classproton_1_1acceptor.html", null ],
-    [ "annotation_key", "classproton_1_1annotation__key.html", null ],
     [ "basic_string< Char >", null, [
       [ "string", null, [
         [ "symbol", "classproton_1_1symbol.html", null ]
       ] ]
     ] ],
-    [ "comparable< T >", "classproton_1_1comparable.html", null ],
-    [ "comparable< byte_array< N > >", "classproton_1_1comparable.html", [
-      [ "byte_array< 16 >", "classproton_1_1byte__array.html", [
-        [ "decimal128", "classproton_1_1decimal128.html", null ],
-        [ "uuid", "classproton_1_1uuid.html", null ]
-      ] ],
-      [ "byte_array< 4 >", "classproton_1_1byte__array.html", [
-        [ "decimal32", "classproton_1_1decimal32.html", null ]
-      ] ],
-      [ "byte_array< 8 >", "classproton_1_1byte__array.html", [
-        [ "decimal64", "classproton_1_1decimal64.html", null ]
-      ] ],
-      [ "byte_array< N >", "classproton_1_1byte__array.html", null ]
+    [ "byte_array< N >", "classproton_1_1byte__array.html", null ],
+    [ "byte_array< 16 >", "classproton_1_1byte__array.html", [
+      [ "decimal128", "classproton_1_1decimal128.html", null ],
+      [ "uuid", "classproton_1_1uuid.html", null ]
     ] ],
-    [ "comparable< duration >", "classproton_1_1comparable.html", [
-      [ "duration", "classproton_1_1duration.html", null ]
-    ] ],
-    [ "comparable< scalar >", "classproton_1_1comparable.html", [
-      [ "scalar", "classproton_1_1scalar.html", null ]
+    [ "byte_array< 4 >", "classproton_1_1byte__array.html", [
+      [ "decimal32", "classproton_1_1decimal32.html", null ]
     ] ],
-    [ "comparable< timestamp >", "classproton_1_1comparable.html", [
-      [ "timestamp", "classproton_1_1timestamp.html", null ]
-    ] ],
-    [ "comparable< value >", "classproton_1_1comparable.html", [
-      [ "value", "classproton_1_1value.html", null ]
+    [ "byte_array< 8 >", "classproton_1_1byte__array.html", [
+      [ "decimal64", "classproton_1_1decimal64.html", null ]
     ] ],
     [ "condition", "classproton_1_1condition.html", null ],
-    [ "connection_engine", "classproton_1_1connection__engine.html", [
-      [ "socket_engine", "classproton_1_1io_1_1socket__engine.html", null ]
-    ] ],
     [ "connection_options", "classproton_1_1connection__options.html", null ],
     [ "container", "classproton_1_1container.html", null ],
     [ "data", "classproton_1_1codec_1_1data.html", [
+      [ "decoder", "classproton_1_1codec_1_1decoder.html", null ],
       [ "encoder", "classproton_1_1codec_1_1encoder.html", null ]
     ] ],
     [ "delivery", "classproton_1_1delivery.html", null ],
+    [ "duration", "classproton_1_1duration.html", null ],
     [ "endpoint", "classproton_1_1endpoint.html", [
       [ "connection", "classproton_1_1connection.html", null ],
       [ "link", "classproton_1_1link.html", [
@@ -51,34 +34,36 @@ var hierarchy =
       ] ],
       [ "session", "classproton_1_1session.html", null ]
     ] ],
-    [ "event", "classproton_1_1event.html", null ],
+    [ "engine", "classproton_1_1io_1_1socket_1_1engine.html", null ],
     [ "exception", null, [
       [ "runtime_error", null, [
         [ "error", "structproton_1_1error.html", [
-          [ "connection_engine::io_error", "structproton_1_1connection__engine_1_1io__error.html", null ],
           [ "conversion_error", "structproton_1_1conversion__error.html", null ],
           [ "timeout_error", "structproton_1_1timeout__error.html", null ],
           [ "url_error", "structproton_1_1url__error.html", null ]
         ] ]
       ] ]
     ] ],
-    [ "finish", "structproton_1_1codec_1_1finish.html", null ],
-    [ "guard", "structproton_1_1io_1_1guard.html", null ],
+    [ "guard", "structproton_1_1io_1_1socket_1_1guard.html", null ],
     [ "handler", "classproton_1_1handler.html", null ],
     [ "link_iterator", "classproton_1_1link__iterator.html", null ],
     [ "link_options", "classproton_1_1link__options.html", null ],
-    [ "listener", "classproton_1_1io_1_1listener.html", null ],
+    [ "listener", "classproton_1_1io_1_1socket_1_1listener.html", null ],
     [ "message", "classproton_1_1message.html", null ],
-    [ "message_id", "classproton_1_1message__id.html", null ],
-    [ "narrow_guard", "structproton_1_1codec_1_1narrow__guard.html", null ],
     [ "sasl", "classproton_1_1sasl.html", null ],
+    [ "scalar_base", "classproton_1_1scalar__base.html", [
+      [ "annotation_key", "classproton_1_1annotation__key.html", null ],
+      [ "message_id", "classproton_1_1message__id.html", null ],
+      [ "scalar", "classproton_1_1scalar.html", null ]
+    ] ],
     [ "session_iterator", "classproton_1_1session__iterator.html", null ],
     [ "ssl", "classproton_1_1ssl.html", null ],
     [ "ssl_client_options", "classproton_1_1ssl__client__options.html", null ],
     [ "ssl_server_options", "classproton_1_1ssl__server__options.html", null ],
-    [ "state_guard", "structproton_1_1codec_1_1state__guard.html", null ],
     [ "terminus", "classproton_1_1terminus.html", null ],
+    [ "timestamp", "classproton_1_1timestamp.html", null ],
     [ "url", "classproton_1_1url.html", null ],
+    [ "value", "classproton_1_1value.html", null ],
     [ "vector< T >", null, [
       [ "binary", "classproton_1_1binary.html", null ]
     ] ]

Modified: qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/index.html?rev=1739159&r1=1739158&r2=1739159&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/index.html (original)
+++ qpid/site/docs/releases/qpid-proton-master/proton/cpp/api/index.html Thu Apr 14 18:29:35 2016
@@ -106,19 +106,19 @@ $(document).ready(function(){initNavTree
 <p>In the case of a broker, the source or target usually refers to a queue or topic. In general they can refer to any AMQP-capable node.</p>
 <p>In the <em>request-response</em> pattern, a request message carries a <em>reply-to</em> address for the response message. This can be any AMQP address, but it is often useful to create a temporary address for just the response message.</p>
 <p>The most common approach is for the client to create a <em>receiver</em> for the response with the <em>dynamic</em> flag set. This asks the server to generate a unique <em>source</em> address automatically and discard it when the link closes. The client uses this "dynamic" source address as the reply-to when it sends the request, and the response is delivered to the client's dynamic receiver.</p>
-<p>In the case of a broker, a dynamic address usually corresponds to a temporary queue, but any AMQP request-response server can use this technique. The <a class="el" href="server_direct_8cpp-example.html">server_direct.cpp</a> example illustrates how to implement a queueless request-response server.</p>
+<p>In the case of a broker, a dynamic address usually corresponds to a temporary queue, but any AMQP request-response server can use this technique. The server_direct.cpp example illustrates how to implement a queueless request-response server.</p>
 <h2>Anatomy of a Proton application</h2>
 <p>To send AMQP commands, call methods on classes like <code><a class="el" href="classproton_1_1connection.html" title="A connection to a remote AMQP peer. ">proton::connection</a></code>, <code><a class="el" href="classproton_1_1sender.html" title="A link for sending messages. ">proton::sender</a></code>, <code><a class="el" href="classproton_1_1receiver.html" title="A link for receiving messages. ">proton::receiver</a></code>, or <code><a class="el" href="classproton_1_1delivery.html" title="A message transfer. ">proton::delivery</a></code>. To handle incoming commands, implement the <code><a class="el" href="classproton_1_1handler.html" title="Callback functions for handling proton events. ">proton::handler</a></code> interface. The handler receives calls like <code>on_message</code> (a message is received), <code>on_link_open</code> (a link is opened), and <code>on_sendable</code> (a link is ready to send messages).</p>
-<p>Messages are represented by <code><a class="el" href="classproton_1_1message.html" title="An AMQP message. ">proton::message</a></code>. AMQP defines a type encoding that you can use for interoperability, but you can also use any encoding you wish and pass binary data as the <code><a class="el" href="classproton_1_1message.html#ae9af642f154a68ec0eb8e715ecaf95ae" title="Set the body, equivalent to body() = x. ">proton::message::body</a></code>. <code><a class="el" href="classproton_1_1value.html" title="A holder for any single AMQP value, simple or complex (can be list, array, map etc.) ">proton::value</a></code> and <code><a class="el" href="classproton_1_1scalar.html" title="A holder for an instance of any scalar AMQP type. ">proton::scalar</a></code> provide conversion between AMQP and C++ data types.</p>
-<p>There are two alternative ways to manage handlers and AMQP objects, the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> and the <code><a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">proton::connection_engine</a></code>. You can code your application so that it can be run with either. Say you find the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> easier to get started but later need more flexibility. You can switch to the <code><a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">proton::connection_engine</a></code> with little or no change to your handlers.</p>
+<p>Messages are represented by <code><a class="el" href="classproton_1_1message.html" title="An AMQP message. ">proton::message</a></code>. AMQP defines a type encoding that you can use for interoperability, but you can also use any encoding you wish and pass binary data as the <code><a class="el" href="classproton_1_1message.html#ae9af642f154a68ec0eb8e715ecaf95ae" title="Set the body, equivalent to body() = x. ">proton::message::body</a></code>. <code><a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex, see AMQP and C++ types. ">proton::value</a></code> and <code><a class="el" href="classproton_1_1scalar.html" title="A holder for an instance of any scalar AMQP type, see AMQP and C++ types. ">proton::scalar</a></code> provide conversion between AMQP and C++ data types.</p>
+<p>There are two alternative ways to manage handlers and AMQP objects, the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> and the <code>proton::connection_engine</code>. You can code your application so that it can be run with either. Say you find the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> easier to get started but later need more flexibility. You can switch to the <code>proton::connection_engine</code> with little or no change to your handlers.</p>
 <h3>proton::container</h3>
 <p><code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> is a <em>reactor</em> framework that manages multiple connections and dispatches events to handlers. You implement <code><a class="el" href="classproton_1_1handler.html" title="Callback functions for handling proton events. ">proton::handler</a></code> with your logic to react to events, and register it with the container. The container lets you open multiple connections and links, receive incoming connections and links, and send, receive, and acknowledge messages.</p>
 <p>The reactor handles IO for multiple connections using sockets and <code>poll</code>. It dispatches events to your handlers in a single thread, where you call <code><a class="el" href="classproton_1_1container.html#a13a43e6d814de94978c515cb084873b1" title="Start processing events. ">proton::container::run</a></code>. The container is not thread-safe: once it is running you can only operate on Proton objects from your handler methods.</p>
 <h3>proton::connection_engine</h3>
-<p><code><a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">proton::connection_engine</a></code> dispatches events for a <em>single connection</em>. The subclass <code><a class="el" href="classproton_1_1io_1_1socket__engine.html" title="A connection_engine for socket-based IO. ">proton::io::socket_engine</a></code> does socket-based IO. An application with a single connection is just like using <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> except you attach your handler to a <code><a class="el" href="classproton_1_1io_1_1socket__engine.html" title="A connection_engine for socket-based IO. ">proton::io::socket_engine</a></code> instead. You can compare examples, such as <a class="el" href="helloworld_8cpp-example.html">helloworld.cpp</a> and <a class="el" href="engine_2helloworld_8cpp-example.html">engine/he
 lloworld.cpp</a>.</p>
-<p>Now consider multiple connections. <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> is easy to use but restricted to a single thread. <code><a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">proton::connection_engine</a></code> is not thread-safe either, but <em>each engine is independent</em>. You can process different connections in different threads, or use a thread pool to process a dynamic set of connections.</p>
-<p>The engine does not provide built-in polling and listening like the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code>, but you can drive engines using any polling or threading strategy and any IO library (for example, epoll, kqueue, solaris completion ports, IOCP proactor, boost::asio, libevent, etc.) This can be important for optimizing performance or supporting diverse platforms. The example <a class="el" href="engine_2broker_8cpp-example.html">engine/broker.cpp</a> shows a broker using sockets and poll, but you can see how the code could be adapted.</p>
-<p><code><a class="el" href="classproton_1_1connection__engine.html" title="An interface for connection-oriented IO integration. ">proton::connection_engine</a></code> also does not dictate the IO mechanism, but it is an abstract class. <code>proton::socket_engine</code> provides ready-made socket-based IO, but you can write your own subclass with any IO code. Just override the <code>io_read</code>, <code>io_write</code> and <code>io_close</code> methods. For example, the proton test suite implements an in-memory connection using <code>std::deque</code> for test purposes.</p>
+<p><code>proton::connection_engine</code> dispatches events for a <em>single connection</em>. The subclass <code><a class="el" href="classproton_1_1io_1_1socket_1_1engine.html" title="A connection_engine with non-blocking socket IO. ">proton::io::socket::engine</a></code> does socket-based IO. An application with a single connection is just like using <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> except you attach your handler to a <code><a class="el" href="classproton_1_1io_1_1socket_1_1engine.html" title="A connection_engine with non-blocking socket IO. ">proton::io::socket::engine</a></code> instead. You can compare examples, such as helloworld.cpp and engine/helloworld.cpp.</p>
+<p>Now consider multiple connections. <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code> is easy to use but restricted to a single thread. <code>proton::connection_engine</code> is not thread-safe either, but <em>each engine is independent</em>. You can process different connections in different threads, or use a thread pool to process a dynamic set of connections.</p>
+<p>The engine does not provide built-in polling and listening like the <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, and links. ">proton::container</a></code>, but you can drive engines using any polling or threading strategy and any IO library (for example, epoll, kqueue, solaris completion ports, IOCP proactor, boost::asio, libevent, etc.) This can be important for optimizing performance or supporting diverse platforms. The example engine/broker.cpp shows a broker using sockets and poll, but you can see how the code could be adapted.</p>
+<p><code>proton::connection_engine</code> also does not dictate the IO mechanism, but it is an abstract class. <code>proton::socket::engine</code> provides ready-made socket-based IO, but you can write your own subclass with any IO code. Just override the <code>io_read</code>, <code>io_write</code> and <code>io_close</code> methods. For example, the proton test suite implements an in-memory connection using <code>std::deque</code> for test purposes.</p>
 <h2>Delivery guarantees</h2>
 <p>For <em>at-most-once</em>, the sender settles the message as soon as it sends it. If the connection is lost before the message is received by the receiver, the message will not be delivered.</p>
 <p>For <em>at-least-once</em>, the receiver accepts and settles the message on receipt. If the connection is lost before the sender is informed of the settlement, then the delivery is considered in-doubt and should be retried. This will ensure it eventually gets delivered (provided of course the connection and link can be reestablished). It may mean that it is delivered multiple times though.</p>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message