http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.html b/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.html index 7a5578a..7563775 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.html @@ -95,60 +95,99 @@ $(document).ready(function(){initNavTree('hierarchy.html','');}); <div class="contents"> <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;"> </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:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span class="icona"><span class="icon">C</span></span><b>basic_string< Char ></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;"> </span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">▼</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;"> </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;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< N ></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;"> </span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 16 ></a></td><td class="desc"></td></tr> -<tr id="row_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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;"> </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;"> </span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 4 ></a></td><td class="desc"></td></tr> -<tr id="row_4_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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;"> </span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 8 ></a></td><td class="desc"></td></tr> -<tr id="row_5_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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;"> </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;"> </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;"> </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;"> </span><span id="arr_9_" class="arrow" onclick="toggleFolder('9_')">▼</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;"> </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;"> </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;"> </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;"> </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;"> </span><span id="arr_12_" class="arrow" onclick="toggleFolder('12_')">▼</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;"> </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;"> </span><span id="arr_12_1_" class="arrow" onclick="toggleFolder('12_1_')">▼</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;"> </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;"> </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;"> </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;"> </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;"> </span><span id="arr_14_" class="arrow" onclick="toggleFolder('14_')">▼</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;"> </span><span id="arr_14_0_" class="arrow" onclick="toggleFolder('14_0_')">▼</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;"> </span><span id="arr_14_0_0_" class="arrow" onclick="toggleFolder('14_0_0_')">▼</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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </span><span id="arr_22_" class="arrow" onclick="toggleFolder('22_')">▼</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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </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;"> </span><span id="arr_31_" class="arrow" onclick="toggleFolder('31_')">▼</span><span class="icona"><span class="icon">C</span></span><b>vector< T ></b></td><td class="desc">STL class </td></tr> -<tr id="row_31_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>basic_string< Char ></b></td><td class="desc">STL class </td></tr> +<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>string</b></td><td class="desc">STL class </td></tr> +<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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">A std::string that represents the AMQP symbol type </td></tr> +<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< byte_array< N > ></b></td><td class="desc"></td></tr> +<tr id="row_1_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 16 ></a></td><td class="desc"></td></tr> +<tr id="row_1_0_0_"><td class="entry"><span style="width:48px;display:inline-block;"> </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_1_0_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_1_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_1_1_" class="arrow" onclick="toggleFolder('1_1_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 4 ></a></td><td class="desc"></td></tr> +<tr id="row_1_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_1_2_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_1_2_" class="arrow" onclick="toggleFolder('1_2_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< 8 ></a></td><td class="desc"></td></tr> +<tr id="row_1_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_1_3_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1byte__array.html" target="_self">byte_array< N ></a></td><td class="desc">Arbitrary fixed-size data </td></tr> +<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< duration ></b></td><td class="desc"></td></tr> +<tr id="row_2_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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_3_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< object< pn_connection_t > ></b></td><td class="desc"></td></tr> +<tr id="row_3_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_3_0_" class="arrow" onclick="toggleFolder('3_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>object< pn_connection_t ></b></td><td class="desc"></td></tr> +<tr id="row_3_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_4_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< object< pn_delivery_t > ></b></td><td class="desc"></td></tr> +<tr id="row_4_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_4_0_" class="arrow" onclick="toggleFolder('4_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>object< pn_delivery_t ></b></td><td class="desc"></td></tr> +<tr id="row_4_0_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_4_0_0_" class="arrow" onclick="toggleFolder('4_0_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1transfer.html" target="_self">transfer</a></td><td class="desc">The base class for delivery and tracker </td></tr> +<tr id="row_4_0_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </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 received message </td></tr> +<tr id="row_4_0_0_1_"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1tracker.html" target="_self">tracker</a></td><td class="desc">A tracker for a sent message </td></tr> +<tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< object< pn_link_t > ></b></td><td class="desc"></td></tr> +<tr id="row_5_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_5_0_" class="arrow" onclick="toggleFolder('5_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>object< pn_link_t ></b></td><td class="desc"></td></tr> +<tr id="row_5_0_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_5_0_0_" class="arrow" onclick="toggleFolder('5_0_0_')">▼</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_5_0_0_0_"><td class="entry"><span style="width:64px;display:inline-block;"> </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 channel for receiving messages </td></tr> +<tr id="row_5_0_0_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </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 channel for sending messages </td></tr> +<tr id="row_6_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_6_" class="arrow" onclick="toggleFolder('6_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< object< pn_session_t > ></b></td><td class="desc"></td></tr> +<tr id="row_6_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_6_0_" class="arrow" onclick="toggleFolder('6_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>object< pn_session_t ></b></td><td class="desc"></td></tr> +<tr id="row_6_0_0_"><td class="entry"><span style="width:48px;display:inline-block;"> </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 senders and receivers </td></tr> +<tr id="row_7_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_7_" class="arrow" onclick="toggleFolder('7_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< object< pn_transport_t > ></b></td><td class="desc"></td></tr> +<tr id="row_7_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_7_0_" class="arrow" onclick="toggleFolder('7_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>object< pn_transport_t ></b></td><td class="desc"></td></tr> +<tr id="row_7_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1transport.html" target="_self">transport</a></td><td class="desc">A network channel supporting an AMQP connection </td></tr> +<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><b>comparable< object< T > ></b></td><td class="desc"></td></tr> +<tr id="row_9_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_9_" class="arrow" onclick="toggleFolder('9_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< scalar_base ></b></td><td class="desc"></td></tr> +<tr id="row_9_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_9_0_" class="arrow" onclick="toggleFolder('9_0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>scalar_base</b></td><td class="desc">Base class for scalar types </td></tr> +<tr id="row_9_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_9_0_1_"><td class="entry"><span style="width:48px;display:inline-block;"> </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_9_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </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_10_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_10_" class="arrow" onclick="toggleFolder('10_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< timestamp ></b></td><td class="desc"></td></tr> +<tr id="row_10_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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 64-bit timestamp in milliseconds since the Unix epoch </td></tr> +<tr id="row_11_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_11_" class="arrow" onclick="toggleFolder('11_')">▼</span><span class="icona"><span class="icon">C</span></span><b>comparable< value ></b></td><td class="desc"></td></tr> +<tr id="row_11_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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 </td></tr> +<tr id="row_12_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1connection__engine.html" target="_self">connection_engine</a></td><td class="desc"><b>Experimental</b> - An AMQP protocol engine for a single connection </td></tr> +<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </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_14_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1io_1_1const__buffer.html" target="_self">const_buffer</a></td><td class="desc"><b>Experimental</b> - Pointer to a const memory region with a size </td></tr> +<tr id="row_15_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_15_" class="arrow" onclick="toggleFolder('15_')">▼</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, senders, and receivers </td></tr> +<tr id="row_15_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1default__container.html" target="_self">default_container</a></td><td class="desc">A single-threaded container </td></tr> +<tr id="row_15_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1container__impl__base.html" target="_self">container_impl_base</a></td><td class="desc"><b>Experimental</b> - A base container implementation </td></tr> +<tr id="row_16_"><td class="entry"><span style="width:16px;display:inline-block;"> </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"><b>Experimental</b> - Stream-like decoder from AMQP bytes to C++ values </td></tr> +<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1delivery__mode.html" target="_self">delivery_mode</a></td><td class="desc">The message delivery policy to establish when opening a link </td></tr> +<tr id="row_18_"><td class="entry"><span style="width:16px;display:inline-block;"> </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"><b>Experimental</b> - Stream-like encoder from AMQP bytes to C++ values </td></tr> +<tr id="row_19_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_19_" class="arrow" onclick="toggleFolder('19_')">▼</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_19_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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_19_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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_19_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </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 senders and receivers </td></tr> +<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1error__condition.html" target="_self">error_condition</a></td><td class="desc">Describes an endpoint error state </td></tr> +<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1event__loop.html" target="_self">event_loop</a></td><td class="desc"><b>Experimental</b> - A serial execution context </td></tr> +<tr id="row_22_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_22_" class="arrow" onclick="toggleFolder('22_')">▼</span><span class="icona"><span class="icon">C</span></span><b>exception</b></td><td class="desc">STL class </td></tr> +<tr id="row_22_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_22_0_" class="arrow" onclick="toggleFolder('22_0_')">▼</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_22_0_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_22_0_0_" class="arrow" onclick="toggleFolder('22_0_0_')">▼</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_22_0_0_0_"><td class="entry"><span style="width:64px;display:inline-block;"> </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">An error converting between AMQP and C++ data </td></tr> +<tr id="row_22_0_0_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </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">An operation timed out </td></tr> +<tr id="row_22_0_0_2_"><td class="entry"><span style="width:64px;display:inline-block;"> </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">An error encountered during URL parsing </td></tr> +<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1finish" target="_self">finish</a></td><td class="desc"><b>Experimental</b> - Finish inserting or extracting a complex type </td></tr> +<tr id="row_24_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1inject__handler.html" target="_self">inject_handler</a></td><td class="desc"><b>Experimental</b> - A handler for injected code </td></tr> +<tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1io_1_1link__namer.html" target="_self">link_namer</a></td><td class="desc"><b>Experimental</b> - Generate default link names that are unique within a container </td></tr> +<tr id="row_26_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1listen__handler.html" target="_self">listen_handler</a></td><td class="desc"><b>Experimental</b> - A handler for incoming connections </td></tr> +<tr id="row_27_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1listener.html" target="_self">listener</a></td><td class="desc">A listener for incoming connections </td></tr> +<tr id="row_28_"><td class="entry"><span style="width:16px;display:inline-block;"> </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_29_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1messaging__handler.html" target="_self">messaging_handler</a></td><td class="desc">A handler for Proton messaging events </td></tr> +<tr id="row_30_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structproton_1_1io_1_1mutable__buffer.html" target="_self">mutable_buffer</a></td><td class="desc"><b>Experimental</b> - Pointer to a mutable memory region with a size </td></tr> +<tr id="row_31_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1receiver__options.html" target="_self">receiver_options</a></td><td class="desc">Options for creating a receiver </td></tr> +<tr id="row_32_"><td class="entry"><span style="width:16px;display:inline-block;"> </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_33_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1sender__options.html" target="_self">sender_options</a></td><td class="desc">Options for creating a sender </td></tr> +<tr id="row_34_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1session__options.html" target="_self">session_options</a></td><td class="desc">Options for creating a session </td></tr> +<tr id="row_35_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1source__options.html" target="_self">source_options</a></td><td class="desc">Options for creating a source node for a sender or receiver </td></tr> +<tr id="row_36_"><td class="entry"><span style="width:16px;display:inline-block;"> </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_37_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1ssl__certificate.html" target="_self">ssl_certificate</a></td><td class="desc"><b>Experimental</b> - An SSL certificate </td></tr> +<tr id="row_38_"><td class="entry"><span style="width:16px;display:inline-block;"> </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"><b>Experimental</b> - SSL configuration for outbound connections </td></tr> +<tr id="row_39_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </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"><b>Experimental</b> - SSL configuration for inbound connections </td></tr> +<tr id="row_40_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start" target="_self">start</a></td><td class="desc"><b>Experimental</b> - Start encoding a complex type </td></tr> +<tr id="row_41_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </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"><b>Experimental</b> - Save and restore codec state </td></tr> +<tr id="row_42_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1target__options.html" target="_self">target_options</a></td><td class="desc">Options for creating a target node for a sender or receiver </td></tr> +<tr id="row_43_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_43_" class="arrow" onclick="toggleFolder('43_')">▼</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_43_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1source.html" target="_self">source</a></td><td class="desc">The source node is where messages originate </td></tr> +<tr id="row_43_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1target.html" target="_self">target</a></td><td class="desc">The target is the destination node of a sent or received message </td></tr> +<tr id="row_44_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classproton_1_1thread__safe.html" target="_self">thread_safe< T ></a></td><td class="desc"><b>Experimental</b> - A thread-safe object wrapper </td></tr> +<tr id="row_45_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </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_46_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_46_" class="arrow" onclick="toggleFolder('46_')">▼</span><span class="icona"><span class="icon">C</span></span><b>value_base</b></td><td class="desc">Separate value data from implicit conversion constructors to avoid recursions </td></tr> +<tr id="row_46_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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 </td></tr> +<tr id="row_47_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_47_" class="arrow" onclick="toggleFolder('47_')">▼</span><span class="icona"><span class="icon">C</span></span><b>vector< T ></b></td><td class="desc">STL class </td></tr> +<tr id="row_47_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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 -->
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.js b/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.js index 8f56ff8..5bf9b0b 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.js +++ b/content/releases/qpid-proton-master/proton/cpp/api/hierarchy.js @@ -1,40 +1,88 @@ var hierarchy = [ - [ "acceptor", "classproton_1_1acceptor.html", null ], [ "basic_string< Char >", null, [ [ "string", null, [ [ "symbol", "classproton_1_1symbol.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< byte_array< N > >", null, [ + [ "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 ] + ] ], + [ "comparable< duration >", null, [ + [ "duration", "classproton_1_1duration.html", null ] + ] ], + [ "comparable< object< pn_connection_t > >", null, [ + [ "object< pn_connection_t >", null, [ + [ "connection", "classproton_1_1connection.html", null ] + ] ] + ] ], + [ "comparable< object< pn_delivery_t > >", null, [ + [ "object< pn_delivery_t >", null, [ + [ "transfer", "classproton_1_1transfer.html", [ + [ "delivery", "classproton_1_1delivery.html", null ], + [ "tracker", "classproton_1_1tracker.html", null ] + ] ] + ] ] + ] ], + [ "comparable< object< pn_link_t > >", null, [ + [ "object< pn_link_t >", null, [ + [ "link", "classproton_1_1link.html", [ + [ "receiver", "classproton_1_1receiver.html", null ], + [ "sender", "classproton_1_1sender.html", null ] + ] ] + ] ] + ] ], + [ "comparable< object< pn_session_t > >", null, [ + [ "object< pn_session_t >", null, [ + [ "session", "classproton_1_1session.html", null ] + ] ] ] ], - [ "byte_array< 4 >", "classproton_1_1byte__array.html", [ - [ "decimal32", "classproton_1_1decimal32.html", null ] + [ "comparable< object< pn_transport_t > >", null, [ + [ "object< pn_transport_t >", null, [ + [ "transport", "classproton_1_1transport.html", null ] + ] ] + ] ], + [ "comparable< object< T > >", null, null ], + [ "comparable< scalar_base >", null, [ + [ "scalar_base", null, [ + [ "annotation_key", "classproton_1_1annotation__key.html", null ], + [ "message_id", "classproton_1_1message__id.html", null ], + [ "scalar", "classproton_1_1scalar.html", null ] + ] ] ] ], - [ "byte_array< 8 >", "classproton_1_1byte__array.html", [ - [ "decimal64", "classproton_1_1decimal64.html", null ] + [ "comparable< timestamp >", null, [ + [ "timestamp", "classproton_1_1timestamp.html", null ] ] ], - [ "condition", "classproton_1_1condition.html", null ], + [ "comparable< value >", null, [ + [ "value", "classproton_1_1value.html", null ] + ] ], + [ "connection_engine", "classproton_1_1io_1_1connection__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 ] + [ "const_buffer", "structproton_1_1io_1_1const__buffer.html", null ], + [ "container", "classproton_1_1container.html", [ + [ "default_container", "classproton_1_1default__container.html", null ], + [ "container_impl_base", "classproton_1_1io_1_1container__impl__base.html", null ] ] ], - [ "delivery", "classproton_1_1delivery.html", null ], - [ "duration", "classproton_1_1duration.html", null ], + [ "decoder", "classproton_1_1codec_1_1decoder.html", null ], + [ "delivery_mode", "structproton_1_1delivery__mode.html", null ], + [ "encoder", "classproton_1_1codec_1_1encoder.html", null ], [ "endpoint", "classproton_1_1endpoint.html", [ [ "connection", "classproton_1_1connection.html", null ], - [ "link", "classproton_1_1link.html", [ - [ "receiver", "classproton_1_1receiver.html", null ], - [ "sender", "classproton_1_1sender.html", null ] - ] ], + [ "link", "classproton_1_1link.html", null ], [ "session", "classproton_1_1session.html", null ] ] ], - [ "engine", "classproton_1_1io_1_1socket_1_1engine.html", null ], + [ "error_condition", "classproton_1_1error__condition.html", null ], + [ "event_loop", "classproton_1_1event__loop.html", null ], [ "exception", null, [ [ "runtime_error", null, [ [ "error", "structproton_1_1error.html", [ @@ -44,26 +92,35 @@ var hierarchy = ] ] ] ] ] ], - [ "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_1socket_1_1listener.html", null ], + [ "finish", "namespaceproton_1_1codec.html#structproton_1_1codec_1_1finish", null ], + [ "inject_handler", "classproton_1_1inject__handler.html", null ], + [ "link_namer", "classproton_1_1io_1_1link__namer.html", null ], + [ "listen_handler", "classproton_1_1listen__handler.html", null ], + [ "listener", "classproton_1_1listener.html", null ], [ "message", "classproton_1_1message.html", null ], + [ "messaging_handler", "classproton_1_1messaging__handler.html", null ], + [ "mutable_buffer", "structproton_1_1io_1_1mutable__buffer.html", null ], + [ "receiver_options", "classproton_1_1receiver__options.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 ], + [ "sender_options", "classproton_1_1sender__options.html", null ], + [ "session_options", "classproton_1_1session__options.html", null ], + [ "source_options", "classproton_1_1source__options.html", null ], [ "ssl", "classproton_1_1ssl.html", null ], + [ "ssl_certificate", "classproton_1_1ssl__certificate.html", null ], [ "ssl_client_options", "classproton_1_1ssl__client__options.html", null ], [ "ssl_server_options", "classproton_1_1ssl__server__options.html", null ], - [ "terminus", "classproton_1_1terminus.html", null ], - [ "timestamp", "classproton_1_1timestamp.html", null ], + [ "start", "namespaceproton_1_1codec.html#structproton_1_1codec_1_1start", null ], + [ "state_guard", "structproton_1_1codec_1_1state__guard.html", null ], + [ "target_options", "classproton_1_1target__options.html", null ], + [ "terminus", "classproton_1_1terminus.html", [ + [ "source", "classproton_1_1source.html", null ], + [ "target", "classproton_1_1target.html", null ] + ] ], + [ "thread_safe< T >", "classproton_1_1thread__safe.html", null ], [ "url", "classproton_1_1url.html", null ], - [ "value", "classproton_1_1value.html", null ], + [ "value_base", null, [ + [ "value", "classproton_1_1value.html", null ] + ] ], [ "vector< T >", null, [ [ "binary", "classproton_1_1binary.html", null ] ] ] http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/index.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/index.html b/content/releases/qpid-proton-master/proton/cpp/api/index.html index 67fb3ba..cc1c2fa 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/index.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/index.html @@ -94,12 +94,12 @@ $(document).ready(function(){initNavTree('index.html','');}); </div><!--header--> <div class="contents"> <div class="textblock"><p>This is the C++ API for the Proton AMQP protocol engine. It allows you to write client and server applications that send and receive AMQP messages.</p> -<p>The best way to start is with the <a class="el" href="tutorial.html">tutorial</a>.</p> +<p>The best way to start is with the tutorial.</p> <h2>An overview of the AMQP model</h2> -<p>Messages are transferred between connected peers over <em>links</em>. The sending end of a link is a <code><a class="el" href="classproton_1_1sender.html" title="A link for sending messages. ">proton::sender</a></code>, and the receiving end is a <code><a class="el" href="classproton_1_1receiver.html" title="A link for receiving messages. ">proton::receiver</a></code>. Links have named 'source' and 'target' addresses. See "Sources and Targets" below for more information.</p> -<p>Links are grouped in a <code><a class="el" href="classproton_1_1session.html" title="A container of links. ">proton::session</a></code>. Messages for links in the same session are sent sequentially. Messages on different sessions can be interleaved, so a large message being sent on one session does not block messages being sent on other sessions.</p> +<p>Messages are transferred between connected peers over <em>links</em>. The sending end of a link is a <code><a class="el" href="classproton_1_1sender.html" title="A channel for sending messages. ">proton::sender</a></code>, and the receiving end is a <code><a class="el" href="classproton_1_1receiver.html" title="A channel for receiving messages. ">proton::receiver</a></code>. Links have named 'source' and 'target' addresses. See "Sources and Targets" below for more information.</p> +<p>Links are grouped in a <code><a class="el" href="classproton_1_1session.html" title="A container of senders and receivers. ">proton::session</a></code>. Messages for links in the same session are sent sequentially. Messages on different sessions can be interleaved, so a large message being sent on one session does not block messages being sent on other sessions.</p> <p>Sessions are created over a <code><a class="el" href="classproton_1_1connection.html" title="A connection to a remote AMQP peer. ">proton::connection</a></code>, which represents the network connection. You can create links directly on a connection using its default session if you don't need multiple sessions.</p> -<p><code><a class="el" href="classproton_1_1message.html" title="An AMQP message. ">proton::message</a></code> represents the message: the body (content), headers, annotations, and so on. A <code><a class="el" href="classproton_1_1delivery.html" title="A message transfer. ">proton::delivery</a></code> represents the act of transferring a message over a link. The receiver acknowledges the delivery by accepting or rejecting it. The delivery is <em>settled</em> when both ends are done with it. Different settlement methods give different levels of reliability: <em>at-most-once</em>, <em>at-least-once</em>, and <em>exactly-once</em>. See "Delivery Guarantees" below for details.</p> +<p><code><a class="el" href="classproton_1_1message.html" title="An AMQP message. ">proton::message</a></code> represents the message: the body (content), properties, headers and annotations. A <code><a class="el" href="classproton_1_1delivery.html" title="A received message. ">proton::delivery</a></code> represents the act of transferring a message over a link. The receiver acknowledges the delivery by accepting or rejecting it. The delivery is <em>settled</em> when both ends are done with it. Different settlement methods give different levels of reliability: <em>at-most-once</em>, <em>at-least-once</em>, and <em>exactly-once</em>. See "Delivery Guarantees" below for details.</p> <h2>Sources and targets</h2> <p>Every link has two addresses, <em>source</em> and <em>target</em>. The most common pattern for using these addresses is as follows:</p> <p>When a client creates a <em>receiver</em> link, it sets the <em>source</em> address. This means "I want to receive messages from this source." This is often referred to as "subscribing" to the source. When a client creates a <em>sender</em> link, it sets the <em>target</em> address. This means "I want to send to this target."</p> @@ -107,22 +107,24 @@ $(document).ready(function(){initNavTree('index.html','');}); <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 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 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>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> -<p>Finally, for <em>exactly-once</em>, the receiver accepts the message but doesn't settle it. The sender settles once it is aware that the receiver accepted it. In this way the receiver retains knowledge of an accepted message until it is sure the sender knows it has been accepted. If the connection is lost before settlement, the receiver informs the sender of all the unsettled deliveries it knows about, and from this the sender can deduce which need to be redelivered. The sender likewise informs the receiver which deliveries it knows about, from which the receiver can deduce which have already been settled. </p> +<p>Finally, for <em>exactly-once</em>, the receiver accepts the message but doesn't settle it. The sender settles once it is aware that the receiver accepted it. In this way the receiver retains knowledge of an accepted message until it is sure the sender knows it has been accepted. If the connection is lost before settlement, the receiver informs the sender of all the unsettled deliveries it knows about, and from this the sender can deduce which need to be redelivered. The sender likewise informs the receiver which deliveries it knows about, from which the receiver can deduce which have already been settled.</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 channel for sending messages. ">proton::sender</a></code>, <code><a class="el" href="classproton_1_1receiver.html" title="A channel for receiving messages. ">proton::receiver</a></code>, or <code><a class="el" href="classproton_1_1delivery.html" title="A received message. ">proton::delivery</a></code>.</p> +<p>To handle incoming commands, subclass the <code><a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a></code> interface. The handler member functions are called when AMQP protocol events occur on a connection. For example <code><a class="el" href="classproton_1_1messaging__handler.html#a96879b0b0b7ade11f98d3f450abd4c46" title="A message is received. ">proton::messaging_handler::on_message</a></code> is called when a message is received.</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. ">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 several ways to manage handlers and AMQP objects, for different types of application. All of them use the same <code><a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a></code> sub-classes so code can be re-used if you change your approach.</p> +<h3>proton::container - Easy single-threaded applications</h3> +<p><code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, senders, and receivers. ">proton::container</a></code> is the top level object in a proton application. Use proton::connection::connect() and <a class="el" href="classproton_1_1container.html#a27d60b6665f37220d9be70f11ab69654" title="Start listening on url. ">proton::container::listen()</a> to create connections. The container polls multiple connections and calls protocol events on your <code><a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a></code> sub-classes.</p> +<p>You can implement your own container to integrate proton with arbitrary your own container using the <code><a class="el" href="classproton_1_1io_1_1connection__engine.html" title="Experimental - An AMQP protocol engine for a single connection. ">proton::io::connection_engine</a></code>.</p> +<h3>proton::io::connection_engine - Integrating with foreign IO</h3> +<p>The <code><a class="el" href="classproton_1_1io_1_1connection__engine.html" title="Experimental - An AMQP protocol engine for a single connection. ">proton::io::connection_engine</a></code> is different from the other proton APIs. You might think of it as more like an SPI (service provider interface).</p> +<p>The engine provides a very low-level way of driving a <code><a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a></code>: You feed raw byte-sequence fragments of an AMQP-encoded stream to the engine and it converts that into calls on a proton::handler. The engine provides you with outgoing protocol stream bytes in return.</p> +<p>The engine is deliberately very simple and low level. It does no IO, no thread-related locking, and is written in simple C++98-compatible code.</p> +<p>You can use the engine directly to connect your application to any kind of IO framework or library, memory-based streams, or any other source or sink for byte-stream data.</p> +<p>You can also use the engine to build a custom implementation of <code><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, senders, and receivers. ">proton::container</a></code> so portable proton applications can run without modification on your platform. </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/io_page.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/io_page.html b/content/releases/qpid-proton-master/proton/cpp/api/io_page.html new file mode 100755 index 0000000..802d618 --- /dev/null +++ b/content/releases/qpid-proton-master/proton/cpp/api/io_page.html @@ -0,0 +1,116 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.10"/> +<title>Qpid Proton C++ API: IO integration</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Qpid Proton C++ API +  <span id="projectnumber">master</span> + </div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.10 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('io_page.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">IO integration </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p><b>Experimental</b></p> +<p>The <a class="el" href="namespaceproton_1_1io.html" title="Experimental - An SPI for multithreaded network IO. ">proton::io</a> namespace contains a low-level service provider interface (SPI) that can be used to implement the proton API over any native or third-party IO library.</p> +<p>The <a class="el" href="classproton_1_1io_1_1connection__engine.html" title="Experimental - An AMQP protocol engine for a single connection. ">proton::io::connection_engine</a> is the core engine that converts raw AMQP bytes read from any IO source into <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">proton::messaging_handler</a> event calls and generates AMQP byte-encoded output that can be written to any IO destination.</p> +<p>Integrations need to implement two user-visible interfaces:</p> +<ul> +<li><a class="el" href="classproton_1_1container.html" title="A top-level container of connections, sessions, senders, and receivers. ">proton::container</a> lets the user initiate or listen for connections.</li> +<li><a class="el" href="classproton_1_1event__loop.html" title="Experimental - A serial execution context. ">proton::event_loop</a> lets the user serialize their own work with a connection.</li> +</ul> +<dl class="section see"><dt>See also</dt><dd>mt/epoll_container.cpp for an example of an integration. </dd></dl> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html";> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li> + </ul> +</div> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
