http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.html b/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.html index d3b9cdf..d3b57f9 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.html @@ -167,7 +167,7 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="separator:ga001b2f3c1bfe4d24d53b93d79dccbfe3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="memItemLeft" align="right" valign="top"><a id="gad0c98415e0105efb71e8c1a8c4c1e5fb"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gad0c98415e0105efb71e8c1a8c4c1e5fb">pn_connection_driver_close</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *c)</td></tr> -<tr class="memdesc:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="mdescLeft"> </td><td class="mdescRight">Close both sides side. <br /></td></tr> +<tr class="memdesc:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="mdescLeft"> </td><td class="mdescRight">Close both sides. <br /></td></tr> <tr class="separator:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga00b32ae810a25ba6e172d6ed870982a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5">pn_connection_driver_next_event</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> <tr class="memdesc:ga00b32ae810a25ba6e172d6ed870982a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the next event to handle. <a href="#ga00b32ae810a25ba6e172d6ed870982a5">More...</a><br /></td></tr> @@ -180,28 +180,31 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="memdesc:ga38f56836858b2d4a04ab961f650950d4"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the the driver is closed for reading and writing and there are no more events. <a href="#ga38f56836858b2d4a04ab961f650950d4">More...</a><br /></td></tr> <tr class="separator:ga38f56836858b2d4a04ab961f650950d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga373eb1f632468582d025f5d6acf9655e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e">pn_connection_driver_errorf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *name, const char *fmt,...)</td></tr> -<tr class="memdesc:ga373eb1f632468582d025f5d6acf9655e"><td class="mdescLeft"> </td><td class="mdescRight">Set IO error information. <a href="#ga373eb1f632468582d025f5d6acf9655e">More...</a><br /></td></tr> +<tr class="memdesc:ga373eb1f632468582d025f5d6acf9655e"><td class="mdescLeft"> </td><td class="mdescRight">Set transport error. <a href="#ga373eb1f632468582d025f5d6acf9655e">More...</a><br /></td></tr> <tr class="separator:ga373eb1f632468582d025f5d6acf9655e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad774f90adceaf86748a0ae781f66daf2"><td class="memItemLeft" align="right" valign="top"><a id="gad774f90adceaf86748a0ae781f66daf2"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gad774f90adceaf86748a0ae781f66daf2">pn_connection_driver_verrorf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *name, const char *fmt, va_list)</td></tr> -<tr class="memdesc:gad774f90adceaf86748a0ae781f66daf2"><td class="mdescLeft"> </td><td class="mdescRight">Set IO error information via a va_list, see <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set IO error information. ">pn_connection_driver_errorf()</a> <br /></td></tr> +<tr class="memdesc:gad774f90adceaf86748a0ae781f66daf2"><td class="mdescLeft"> </td><td class="mdescRight">Set transport error via a va_list, see <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set transport error. ">pn_connection_driver_errorf()</a> <br /></td></tr> <tr class="separator:gad774f90adceaf86748a0ae781f66daf2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gada5c75a658ae2814f253a91723be9baf"><td class="memItemLeft" align="right" valign="top"><a id="gada5c75a658ae2814f253a91723be9baf"></a> +<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gada5c75a658ae2814f253a91723be9baf">pn_event_batch_connection_driver</a> (<a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *batch)</td></tr> +<tr class="memdesc:gada5c75a658ae2814f253a91723be9baf"><td class="mdescLeft"> </td><td class="mdescRight">If batch is part of a connection_driver, return the connection_driver address, else return NULL. <br /></td></tr> +<tr class="separator:gada5c75a658ae2814f253a91723be9baf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadb682f03cb66b5898c4b285353e0005e"><td class="memItemLeft" align="right" valign="top"><a id="gadb682f03cb66b5898c4b285353e0005e"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gadb682f03cb66b5898c4b285353e0005e">pn_connection_driver_log</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *msg)</td></tr> -<tr class="memdesc:gadb682f03cb66b5898c4b285353e0005e"><td class="mdescLeft"> </td><td class="mdescRight">Log a string message using the connection's transport log. <br /></td></tr> +<tr class="memdesc:gadb682f03cb66b5898c4b285353e0005e"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#gad603e8d72578bcedd2d9235f74f28f37" title="Log a message using a transport's logging mechanism. ">pn_transport_log()</a>. <br /></td></tr> <tr class="separator:gadb682f03cb66b5898c4b285353e0005e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga756d1d7130b79f639d71d331f9005cab"><td class="memItemLeft" align="right" valign="top"><a id="ga756d1d7130b79f639d71d331f9005cab"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga756d1d7130b79f639d71d331f9005cab">pn_connection_driver_logf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *fmt,...)</td></tr> -<tr class="memdesc:ga756d1d7130b79f639d71d331f9005cab"><td class="mdescLeft"> </td><td class="mdescRight">Log a printf formatted message using the connection's transport log. <br /></td></tr> +<tr class="memdesc:ga756d1d7130b79f639d71d331f9005cab"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#ga26cff9ffda93e2ffc8606e19eefe7f84" title="Log a printf formatted message using a transport's logging mechanism. ">pn_transport_logf()</a>. <br /></td></tr> <tr class="separator:ga756d1d7130b79f639d71d331f9005cab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="memItemLeft" align="right" valign="top"><a id="gabf97a6a0b608fd096fcaa4f2692c2c63"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gabf97a6a0b608fd096fcaa4f2692c2c63">pn_connection_driver_vlogf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *fmt, va_list ap)</td></tr> -<tr class="memdesc:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="mdescLeft"> </td><td class="mdescRight">Log a printf formatted message using the connection's transport log. <br /></td></tr> +<tr class="memdesc:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#gac773c1b9226783f36e2f2d4770e90e3f" title="Log a printf formatted message using a transport's logging mechanism. ">pn_transport_vlogf()</a>. <br /></td></tr> <tr class="separator:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gada5c75a658ae2814f253a91723be9baf"><td class="memItemLeft" align="right" valign="top"><a id="gada5c75a658ae2814f253a91723be9baf"></a> -<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gada5c75a658ae2814f253a91723be9baf">pn_event_batch_connection_driver</a> (<a class="el" href="group__event.html#ga6bc581dfeaa8e8d46d07d37229d565c9">pn_event_batch_t</a> *batch)</td></tr> -<tr class="memdesc:gada5c75a658ae2814f253a91723be9baf"><td class="mdescLeft"> </td><td class="mdescRight">If batch is part of a connection_driver, return the connection_driver address, else return NULL. <br /></td></tr> -<tr class="separator:gada5c75a658ae2814f253a91723be9baf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gab9d4f3255c83d7792fc17e5a020ff1c0">pn_connection_driver_ptr</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="memdesc:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="mdescLeft"> </td><td class="mdescRight">Associate a pn_connection_t with its <a class="el" href="group__connection__driver.html#structpn__connection__driver__t" title="The elements needed to drive AMQP IO and events. ">pn_connection_driver_t</a>. <a href="#gab9d4f3255c83d7792fc17e5a020ff1c0">More...</a><br /></td></tr> +<tr class="separator:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p><b>Unsettled API</b> - An API for low-level IO integration. </p> @@ -214,7 +217,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <p>The <code>pn_connection_driver_*</code> functions provide a simplified API and extra logic to use <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff" title="An AMQP Connection object. ">pn_connection_t</a> and <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8" title="A network channel supporting an AMQP connection. ">pn_transport_t</a> as a unit. You can also access them directly for features that do not have <code>pn_connection_driver_*</code> functions.</p> <p>The driver buffers events and data. You should run it until <a class="el" href="group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4" title="Return true if the the driver is closed for reading and writing and there are no more events...">pn_connection_driver_finished()</a> is true, to ensure all reading, writing, and event handling (including <code>ERROR</code> and <code>FINAL</code> events) is finished.</p> <h2>Error handling</h2> -<p>The <code>pn_connection_driver_*</code> functions do not return an error code. IO errors are set on the transport condition and are returned as a <code>PN_TRANSPORT_ERROR</code>. The integration code can set errors using <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set IO error information. ">pn_connection_driver_errorf()</a>.</p> +<p>The <code>pn_connection_driver_*</code> functions do not return an error code. IO errors are set on the transport condition and are returned as a <code>PN_TRANSPORT_ERROR</code>. The integration code can set errors using <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set transport error. ">pn_connection_driver_errorf()</a>.</p> <h2>IO patterns</h2> <p>This API supports asynchronous, proactive, non-blocking and reactive IO. An integration does not have to follow the dispatch-read-write sequence above, but note that you should handle all available events before calling <a class="el" href="group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438" title="Get the read buffer. ">pn_connection_driver_read_buffer()</a> and check that <code>size</code> is non-zero before starting a blocking or asynchronous read call. A <code>read</code> started while there are unprocessed <code>CLOSE</code> events in the buffer may never complete.</p> <p>AMQP is a full-duplex, asynchronous protocol. The "read" and "write" sides of an AMQP connection can close separately.</p> @@ -277,7 +280,7 @@ batch</td> </div><div class="memdoc"> <p>The write side of the transport is closed, it will no longer produce bytes to write to external IO. </p> -<p>Synonynm for PN_TRANSPORT_HEAD_CLOSED </p> +<p>Synonym for PN_TRANSPORT_HEAD_CLOSED </p> </div> </div> @@ -294,7 +297,7 @@ batch</td> </div><div class="memdoc"> <p>The read side of the transport is closed, it will no longer read bytes from external IO. </p> -<p>Alisas for PN_TRANSPORT_TAIL_CLOSED </p> +<p>Alias for PN_TRANSPORT_TAIL_CLOSED </p> </div> </div> @@ -332,9 +335,9 @@ batch</td> </div><div class="memdoc"> <p>Set connection and transport to the provided values, or create a new <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> or <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> if either is NULL. </p> -<p>The provided values belong to the connection driver and will be freed by <a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96" title="Unbind, release and free the connection and transport. ">pn_connection_driver_destroy()</a></p> +<p>The provided values belong to the connection driver and will be freed by <a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96" title="Unbind, release and free the connection and transport. ">pn_connection_driver_destroy()</a>.</p> <p>The transport is bound automatically after the PN_CONNECTION_INIT has been is handled by the application. It can be bound earlier with <a class="el" href="group__connection__driver.html#gad2bdef0f5abe7cf593afcee237c6af56" title="Force binding of the transport. ">pn_connection_driver_bind()</a>.</p> -<p>The following functions must be called before the transport is bound to have effect: pn_connection_set_username(), <a class="el" href="group__connection.html#ga8be7fdeb5a229d16e45fa122844fb285" title="Set the authentication password for a client connection. ">pn_connection_set_password()</a>, <a class="el" href="group__transport.html#gac5bebd26c0942bc17d7fad36577110f8" title="Configure a transport as a server. ">pn_transport_set_server()</a></p> +<p>The following functions must be called before the transport is bound to have effect: pn_connection_set_username(), <a class="el" href="group__connection.html#ga8be7fdeb5a229d16e45fa122844fb285" title="Set the authentication password for a client connection. ">pn_connection_set_password()</a>, <a class="el" href="group__transport.html#gac5bebd26c0942bc17d7fad36577110f8" title="Configure a transport as a server. ">pn_transport_set_server()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>PN_OUT_OF_MEMORY if any allocation fails. </dd></dl> </div> @@ -602,12 +605,35 @@ batch</td> </table> </div><div class="memdoc"> -<p>Set IO error information. </p> +<p>Set transport error. </p> <p>The name and formatted description are set on the transport condition, and returned as a PN_TRANSPORT_ERROR event from <a class="el" href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5" title="Get the next event to handle. ">pn_connection_driver_next_event()</a>.</p> <p>You must call this <em>before</em> <a class="el" href="group__connection__driver.html#ga11b59aec2b54acdefd63dfbce8d09a3f" title="Close the read side. ">pn_connection_driver_read_close()</a> or <a class="el" href="group__connection__driver.html#gafdca1cd72d6da760d3df7981085b36ce" title="Close the write side. ">pn_connection_driver_write_close()</a> to ensure the error is processed. </p> </div> </div> +<a id="gab9d4f3255c83d7792fc17e5a020ff1c0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab9d4f3255c83d7792fc17e5a020ff1c0">◆ </a></span>pn_connection_driver_ptr()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a>** pn_connection_driver_ptr </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Associate a pn_connection_t with its <a class="el" href="group__connection__driver.html#structpn__connection__driver__t" title="The elements needed to drive AMQP IO and events. ">pn_connection_driver_t</a>. </p> +<p><b>NOTE</b>: this is only for use by IO integration writers. If you are using the standard pn_proactor_t you <em>must not</em> use this function.</p> +<dl class="section return"><dt>Returns</dt><dd>pointer to the pn_connection_driver_t* field in a pn_connection_t.</dd></dl> +<p>Return type is pointer to a pointer so that the caller can (if desired) use atomic operations when loading and storing the value. </p> + +</div> +</div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.js b/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.js index ea7ef37..31840dc 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__connection__driver.js @@ -27,8 +27,9 @@ var group__connection__driver = [ "pn_connection_driver_finished", "group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4", null ], [ "pn_connection_driver_errorf", "group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e", null ], [ "pn_connection_driver_verrorf", "group__connection__driver.html#gad774f90adceaf86748a0ae781f66daf2", null ], + [ "pn_event_batch_connection_driver", "group__connection__driver.html#gada5c75a658ae2814f253a91723be9baf", null ], [ "pn_connection_driver_log", "group__connection__driver.html#gadb682f03cb66b5898c4b285353e0005e", null ], [ "pn_connection_driver_logf", "group__connection__driver.html#ga756d1d7130b79f639d71d331f9005cab", null ], [ "pn_connection_driver_vlogf", "group__connection__driver.html#gabf97a6a0b608fd096fcaa4f2692c2c63", null ], - [ "pn_event_batch_connection_driver", "group__connection__driver.html#gada5c75a658ae2814f253a91723be9baf", null ] + [ "pn_connection_driver_ptr", "group__connection__driver.html#gab9d4f3255c83d7792fc17e5a020ff1c0", null ] ]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__data.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__data.html b/content/releases/qpid-proton-master/proton/c/api/group__data.html index f61920c..79b9b3e 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__data.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__data.html @@ -118,7 +118,7 @@ Functions</h2></td></tr> <tr class="memdesc:ga68e94dfa5d7ab568425c4a6587bac1db"><td class="mdescLeft"> </td><td class="mdescRight">Access the current error code for a given pn_data_t. <a href="#ga68e94dfa5d7ab568425c4a6587bac1db">More...</a><br /></td></tr> <tr class="separator:ga68e94dfa5d7ab568425c4a6587bac1db"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gada171f4740e6a1132b4d4b9c0aea645c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__data.html#gada171f4740e6a1132b4d4b9c0aea645c">pn_data_error</a> (<a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data)</td></tr> -<tr class="memdesc:gada171f4740e6a1132b4d4b9c0aea645c"><td class="mdescLeft"> </td><td class="mdescRight">Access the current error for a givn pn_data_t. <a href="#gada171f4740e6a1132b4d4b9c0aea645c">More...</a><br /></td></tr> +<tr class="memdesc:gada171f4740e6a1132b4d4b9c0aea645c"><td class="mdescLeft"> </td><td class="mdescRight">Access the current error for a given pn_data_t. <a href="#gada171f4740e6a1132b4d4b9c0aea645c">More...</a><br /></td></tr> <tr class="separator:gada171f4740e6a1132b4d4b9c0aea645c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7611c1394e80b5166b8b8647659f97e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__data.html#ga7611c1394e80b5166b8b8647659f97e6">pn_data_clear</a> (<a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data)</td></tr> <tr class="memdesc:ga7611c1394e80b5166b8b8647659f97e6"><td class="mdescLeft"> </td><td class="mdescRight">Clears a pn_data_t object. <a href="#ga7611c1394e80b5166b8b8647659f97e6">More...</a><br /></td></tr> @@ -322,7 +322,7 @@ Functions</h2></td></tr> <tr class="memdesc:gad03a049653bec28d20dc7587f7e544de"><td class="mdescLeft"> </td><td class="mdescRight">If the current node is a symbol, string, or binary, return the bytes representing its value. <a href="#gad03a049653bec28d20dc7587f7e544de">More...</a><br /></td></tr> <tr class="separator:gad03a049653bec28d20dc7587f7e544de"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac5d5c6e6bf24597caf63d35b1755e646"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__types.html#structpn__atom__t">pn_atom_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__data.html#gac5d5c6e6bf24597caf63d35b1755e646">pn_data_get_atom</a> (<a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data)</td></tr> -<tr class="memdesc:gac5d5c6e6bf24597caf63d35b1755e646"><td class="mdescLeft"> </td><td class="mdescRight">If the current node is a scalar value, return it as a <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a>. <a href="#gac5d5c6e6bf24597caf63d35b1755e646">More...</a><br /></td></tr> +<tr class="memdesc:gac5d5c6e6bf24597caf63d35b1755e646"><td class="mdescLeft"> </td><td class="mdescRight">If the current node is a scalar value, return it as a <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a>. <a href="#gac5d5c6e6bf24597caf63d35b1755e646">More...</a><br /></td></tr> <tr class="separator:gac5d5c6e6bf24597caf63d35b1755e646"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf0e0fbb9c8c757f94b9636a6b54dc332"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__data.html#gaf0e0fbb9c8c757f94b9636a6b54dc332">pn_data_copy</a> (<a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data, <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *src)</td></tr> <tr class="memdesc:gaf0e0fbb9c8c757f94b9636a6b54dc332"><td class="mdescLeft"> </td><td class="mdescRight">Copy the contents of another pn_data_t object. <a href="#gaf0e0fbb9c8c757f94b9636a6b54dc332">More...</a><br /></td></tr> @@ -493,8 +493,8 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Access the current error for a givn pn_data_t. </p> -<p>Every pn_data_t has an error descriptor that is created with the pn_data_t and dies with the pn_data_t. The error descriptor is updated whenever an operation fails. The <a class="el" href="group__data.html#gada171f4740e6a1132b4d4b9c0aea645c" title="Access the current error for a givn pn_data_t. ">pn_data_error()</a> function may be used to access a pn_data_t's error descriptor.</p> +<p>Access the current error for a given pn_data_t. </p> +<p>Every pn_data_t has an error descriptor that is created with the pn_data_t and dies with the pn_data_t. The error descriptor is updated whenever an operation fails. The <a class="el" href="group__data.html#gada171f4740e6a1132b4d4b9c0aea645c" title="Access the current error for a given pn_data_t. ">pn_data_error()</a> function may be used to access a pn_data_t's error descriptor.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> @@ -549,7 +549,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Returns the total number of nodes contained in a pn_data_t object. </p> -<p>This includes all parents, children, siblings, grandchildren, etc. In other words the count of all ancesters and descendents of the current node, along with the current node if there is one.</p> +<p>This includes all parents, children, siblings, grandchildren, etc. In other words the count of all ancestors and descendants of the current node, along with the current node if there is one.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> @@ -790,7 +790,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>zero on succes, or an error on failure </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>zero on success, or an error on failure </dd></dl> </div> </div> @@ -2634,14 +2634,14 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>If the current node is a scalar value, return it as a <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a>. </p> +<p>If the current node is a scalar value, return it as a <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the value of the current node as <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the value of the current node as <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a> </dd></dl> </div> </div> @@ -2676,7 +2676,7 @@ Functions</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> - <tr><td class="paramname">src</td><td>the sourc pn_data_t to copy from </td></tr> + <tr><td class="paramname">src</td><td>the source pn_data_t to copy from </td></tr> </table> </dd> </dl> @@ -2714,7 +2714,7 @@ Functions</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> - <tr><td class="paramname">src</td><td>the sourc pn_data_t to append from </td></tr> + <tr><td class="paramname">src</td><td>the source pn_data_t to append from </td></tr> </table> </dd> </dl> @@ -2758,7 +2758,7 @@ Functions</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr> - <tr><td class="paramname">src</td><td>the sourc pn_data_t to append from </td></tr> + <tr><td class="paramname">src</td><td>the source pn_data_t to append from </td></tr> <tr><td class="paramname">limit</td><td>the maximum number of values to append </td></tr> </table> </dd> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__delivery.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__delivery.html b/content/releases/qpid-proton-master/proton/c/api/group__delivery.html index 3556fbc..c2cae00 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__delivery.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__delivery.html @@ -142,8 +142,10 @@ Functions</h2></td></tr> <tr class="memdesc:ga6a7ef2e317b4ed292cafbb358f0ba6ad"><td class="mdescLeft"> </td><td class="mdescRight">Create a delivery on a link. <a href="#ga6a7ef2e317b4ed292cafbb358f0ba6ad">More...</a><br /></td></tr> <tr class="separator:ga6a7ef2e317b4ed292cafbb358f0ba6ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga17c16f34252597f9e737efae1e2ebb81"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga17c16f34252597f9e737efae1e2ebb81"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331" title="Get the attachments that are associated with a delivery object. ">pn_delivery_attachments()</a>. <a href="#ga17c16f34252597f9e737efae1e2ebb81">More...</a><br /></td></tr> <tr class="separator:ga17c16f34252597f9e737efae1e2ebb81"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga91519d3e4568ee8b622d3653e20f60a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, void *context)</td></tr> +<tr class="memdesc:ga91519d3e4568ee8b622d3653e20f60a6"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331" title="Get the attachments that are associated with a delivery object. ">pn_delivery_attachments()</a>. <a href="#ga91519d3e4568ee8b622d3653e20f60a6">More...</a><br /></td></tr> <tr class="separator:ga91519d3e4568ee8b622d3653e20f60a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3e014fc1759a212bc3ee9e513a274331"><td class="memItemLeft" align="right" valign="top">pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331">pn_delivery_attachments</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> <tr class="memdesc:ga3e014fc1759a212bc3ee9e513a274331"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a delivery object. <a href="#ga3e014fc1759a212bc3ee9e513a274331">More...</a><br /></td></tr> @@ -176,7 +178,7 @@ Functions</h2></td></tr> <tr class="memdesc:ga23c7b3c678228ccb21378e7c8ec9a72d"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery only has partial message data. <a href="#ga23c7b3c678228ccb21378e7c8ec9a72d">More...</a><br /></td></tr> <tr class="separator:ga23c7b3c678228ccb21378e7c8ec9a72d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga712690e0cc84419d7b7ca7c49a10b776"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776">pn_delivery_aborted</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> -<tr class="memdesc:ga712690e0cc84419d7b7ca7c49a10b776"><td class="mdescLeft"> </td><td class="mdescRight">On the receiving side, check if the delivery has been aborted. <a href="#ga712690e0cc84419d7b7ca7c49a10b776">More...</a><br /></td></tr> +<tr class="memdesc:ga712690e0cc84419d7b7ca7c49a10b776"><td class="mdescLeft"> </td><td class="mdescRight">Check if a received delivery has been aborted. <a href="#ga712690e0cc84419d7b7ca7c49a10b776">More...</a><br /></td></tr> <tr class="separator:ga712690e0cc84419d7b7ca7c49a10b776"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga533bd8dd766786695b6e71f8505252f1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga533bd8dd766786695b6e71f8505252f1">pn_delivery_writable</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> <tr class="memdesc:ga533bd8dd766786695b6e71f8505252f1"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is writable. <a href="#ga533bd8dd766786695b6e71f8505252f1">More...</a><br /></td></tr> @@ -197,7 +199,7 @@ Functions</h2></td></tr> <tr class="memdesc:ga365b3efbdd225a239dcf4746127c5f33"><td class="mdescLeft"> </td><td class="mdescRight">Return true if delivery is the current delivery for its link. <a href="#ga365b3efbdd225a239dcf4746127c5f33">More...</a><br /></td></tr> <tr class="separator:ga365b3efbdd225a239dcf4746127c5f33"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga407e51ff91368568d15f938b1771357c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga407e51ff91368568d15f938b1771357c">pn_delivery_abort</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> -<tr class="memdesc:ga407e51ff91368568d15f938b1771357c"><td class="mdescLeft"> </td><td class="mdescRight">On the sending side, abort a delivery. <a href="#ga407e51ff91368568d15f938b1771357c">More...</a><br /></td></tr> +<tr class="memdesc:ga407e51ff91368568d15f938b1771357c"><td class="mdescLeft"> </td><td class="mdescRight">Abort a delivery being sent. <a href="#ga407e51ff91368568d15f938b1771357c">More...</a><br /></td></tr> <tr class="separator:ga407e51ff91368568d15f938b1771357c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga98c275fd7158e8b9d7d48d70503d68df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df">pn_delivery_settle</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> <tr class="memdesc:ga98c275fd7158e8b9d7d48d70503d68df"><td class="mdescLeft"> </td><td class="mdescRight">Settle a delivery. <a href="#ga98c275fd7158e8b9d7d48d70503d68df">More...</a><br /></td></tr> @@ -489,8 +491,10 @@ least once" semantics.</p> </tr> </table> </div><div class="memdoc"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331" title="Get the attachments that are associated with a delivery object. ">pn_delivery_attachments()</a>. </p> <p>Get the application context that is associated with a delivery object.</p> -<p>The application context for a delivery may be set using <a class="el" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a>.</p> +<p>The application context for a delivery may be set using <a class="el" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6" title="Deprecated - Use pn_delivery_attachments(). ">pn_delivery_set_context</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery whose context is to be returned. </td></tr> @@ -526,8 +530,10 @@ least once" semantics.</p> </tr> </table> </div><div class="memdoc"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331" title="Get the attachments that are associated with a delivery object. ">pn_delivery_attachments()</a>. </p> <p>Set a new application context for a delivery object.</p> -<p>The application context for a delivery object may be retrieved using <a class="el" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a>.</p> +<p>The application context for a delivery object may be retrieved using <a class="el" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81" title="Deprecated - Use pn_delivery_attachments(). ">pn_delivery_get_context</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery object </td></tr> @@ -800,7 +806,7 @@ least once" semantics.</p> </div><div class="memdoc"> <p>Check if a delivery only has partial message data. </p> -<p>Note a partial message may be <a class="el" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776" title="On the receiving side, check if the delivery has been aborted. ">pn_delivery_aborted()</a> which means the message is incomplete but the rest of the message will never be delivered.</p> +<p>The receiver can expect more <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe" title="A delivery has been created or updated. ">PN_DELIVERY</a> events for this delivery containing the remainder of this message.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> @@ -827,10 +833,11 @@ least once" semantics.</p> </table> </div><div class="memdoc"> -<p>On the receiving side, check if the delivery has been aborted. </p> -<p>Aborting a delivery means the sender cannot complete the message. It will not send any more data and the data received so far should be discarded by the receiver. An aborted deliver is settled by the sender.</p> -<p>Calling <a class="el" href="group__link.html#ga06c97ce7396973dca0d311567f25f95a" title="Receive message data for the current delivery on a link. ">pn_link_recv()</a> when the current delivery on the link is aborted will return a PN_STATE error code.</p> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__delivery.html#ga407e51ff91368568d15f938b1771357c" title="On the sending side, abort a delivery. ">pn_delivery_abort()</a> </dd></dl> +<p>Check if a received delivery has been aborted. </p> +<p>An aborted delivery means the sender cannot complete this message and the receiver should discard any data already received. The link remains open for future messages.</p> +<p>You must still call <a class="el" href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df" title="Settle a delivery. ">pn_delivery_settle()</a> to free local resources. An aborted delivery consumes a credit, use <a class="el" href="group__link.html#gafec44cf1c79ec03f3ac009e1879e71a9" title="Grant credit for incoming deliveries on a receiver. ">pn_link_flow()</a> to issue new credit as for a successful delivery.</p> +<p>Calling <a class="el" href="group__link.html#ga06c97ce7396973dca0d311567f25f95a" title="Receive message data for the current delivery on a link. ">pn_link_recv()</a> when the current delivery is aborted returns <a class="el" href="group__error.html#ga82db456291c2627e31becc44b733a7f0" title="Delivery aborted error. ">PN_ABORTED</a>.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__delivery.html#ga407e51ff91368568d15f938b1771357c" title="Abort a delivery being sent. ">pn_delivery_abort()</a> </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> @@ -1033,10 +1040,11 @@ least once" semantics.</p> </table> </div><div class="memdoc"> -<p>On the sending side, abort a delivery. </p> -<p>Aborting a delivery means the sender cannot complete the message. It will not send any more data and the data received so far should be discarded by the receiver.</p> -<p>The aborted messages is also settled, and can never be used again.</p> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776" title="On the receiving side, check if the delivery has been aborted. ">pn_delivery_aborted()</a></dd></dl> +<p>Abort a delivery being sent. </p> +<p>Aborting means the sender cannot complete this message. It will not send any more data, and data sent so far should be discarded by the receiver. The link remains open for future messages.</p> +<p>If some data has already been sent on the network, an AMQP "aborted" frame will be sent to inform the peer. If no data has yet been sent, the delivery will simply be forgotten.</p> +<p>The delivery will be freed, and cannot be used after the call.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776" title="Check if a received delivery has been aborted. ">pn_delivery_aborted()</a></dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> @@ -1146,7 +1154,7 @@ least once" semantics.</p> </div><div class="memdoc"> <p>Extracts the first delivery on the connection that has pending operations. </p> -<p>Retrieves the first delivery on the Connection that has pending operations. A readable delivery indicates message data is waiting to be read. A writable delivery indicates that message data may be sent. An updated delivery indicates that the delivery's disposition has changed. A delivery will never be both readable and writible, but it may be both readable and updated or both writiable and updated.</p> +<p>Retrieves the first delivery on the Connection that has pending operations. A readable delivery indicates message data is waiting to be read. A writable delivery indicates that message data may be sent. An updated delivery indicates that the delivery's disposition has changed. A delivery will never be both readable and writable, but it may be both readable and updated or both writable and updated.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>the connection </td></tr> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__error.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__error.html b/content/releases/qpid-proton-master/proton/c/api/group__error.html index 94ce2ec..1e03ec3 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__error.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__error.html @@ -145,8 +145,12 @@ Macros</h2></td></tr> <tr class="separator:gafbb090366e9dbf9a5bb0735df1e23d33"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="memItemLeft" align="right" valign="top"><a id="gab1f773ca03b0953de6ce3caf4c795b8d"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#gab1f773ca03b0953de6ce3caf4c795b8d">PN_OUT_OF_MEMORY</a></td></tr> -<tr class="memdesc:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="mdescLeft"> </td><td class="mdescRight">Out-of-momory error. <br /></td></tr> +<tr class="memdesc:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="mdescLeft"> </td><td class="mdescRight">Out-of-memory error. <br /></td></tr> <tr class="separator:gab1f773ca03b0953de6ce3caf4c795b8d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga82db456291c2627e31becc44b733a7f0"><td class="memItemLeft" align="right" valign="top"><a id="ga82db456291c2627e31becc44b733a7f0"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga82db456291c2627e31becc44b733a7f0">PN_ABORTED</a></td></tr> +<tr class="memdesc:ga82db456291c2627e31becc44b733a7f0"><td class="mdescLeft"> </td><td class="mdescRight">Delivery aborted error. <br /></td></tr> +<tr class="separator:ga82db456291c2627e31becc44b733a7f0"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__error.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__error.js b/content/releases/qpid-proton-master/proton/c/api/group__error.js index 2d7d1c1..b2c7511 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__error.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__error.js @@ -11,6 +11,7 @@ var group__error = [ "PN_INTR", "group__error.html#ga53284958be0c328f90ca3a4a0793d965", null ], [ "PN_INPROGRESS", "group__error.html#gafbb090366e9dbf9a5bb0735df1e23d33", null ], [ "PN_OUT_OF_MEMORY", "group__error.html#gab1f773ca03b0953de6ce3caf4c795b8d", null ], + [ "PN_ABORTED", "group__error.html#ga82db456291c2627e31becc44b733a7f0", null ], [ "pn_error_t", "group__error.html#ga24a289d5b32c9bd8a775600a5af83d52", null ], [ "pn_code", "group__error.html#gac6b84f09fac8e82bd41a62212d4d8f64", null ], [ "pn_error", "group__error.html#ga0992aa0df5290a2ae639246b0c2f5481", null ], http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__event.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__event.html b/content/releases/qpid-proton-master/proton/c/api/group__event.html index 5120623..1c11d08 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__event.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__event.html @@ -437,7 +437,7 @@ void * </td><td class="memItemRight" valign="bottom"><a class="el" href="gr <tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaa28a2bfee806bbc1fe31499c8eec39db0"></a>PN_CONNECTION_WAKE </td><td class="fielddoc"><p><a class="el" href="group__proactor.html#ga0f49c771fe3bff54f58c9d583ca30560" title="Return a PN_CONNECTION_WAKE event for connection as soon as possible. ">pn_connection_wake()</a> was called. </p> <p>Events of this type point to the <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>. </p> </td></tr> -<tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c"></a>PN_LISTENER_ACCEPT </td><td class="fielddoc"><p>Indicates the listener has an incoming connection, call <a class="el" href="group__listener.html#gaaee3c3f3822484bc2e370406abf5b736" title="Bind connection to a new transport accepted from listener. ">pn_listener_accept()</a> to accept it. </p> +<tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c"></a>PN_LISTENER_ACCEPT </td><td class="fielddoc"><p>Indicates the listener has an incoming connection, call <a class="el" href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070" title="Accept an incoming connection request using transport and connection, which can be configured before ...">pn_listener_accept2()</a> to accept it. </p> <p>Events of this type point to the <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a>. </p> </td></tr> <tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaad5920df168cd28daaf253cad789d8aca"></a>PN_LISTENER_CLOSE </td><td class="fielddoc"><p>Indicates the listener has closed. </p> @@ -453,7 +453,7 @@ void * </td><td class="memItemRight" valign="bottom"><a class="el" href="gr <p>There will be no further events unless new listeners or connections are opened, or a new timeout is set (possibly in other threads in a multi-threaded program.)</p> <p>Events of this type point to the <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a>. </p> </td></tr> -<tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaa6e25f00110ab278fd8b34fee00bd5fd7"></a>PN_LISTENER_OPEN </td><td class="fielddoc"><p>The listener is listeneing. </p> +<tr><td class="fieldname"><a id="gga4876e2eed24a4d4e4c52b99842103cdaa6e25f00110ab278fd8b34fee00bd5fd7"></a>PN_LISTENER_OPEN </td><td class="fielddoc"><p>The listener is listening. </p> <p>Events of this type point to the <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a>. </p> </td></tr> </table> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__link.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__link.html b/content/releases/qpid-proton-master/proton/c/api/group__link.html index b54b47b..d63f26d 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__link.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__link.html @@ -133,8 +133,10 @@ Functions</h2></td></tr> <tr class="memdesc:gadd3b8899fe023d3506fb88d228d6b1b7"><td class="mdescLeft"> </td><td class="mdescRight">Free a link object. <a href="#gadd3b8899fe023d3506fb88d228d6b1b7">More...</a><br /></td></tr> <tr class="separator:gadd3b8899fe023d3506fb88d228d6b1b7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga93e6b527743f433da2ff367c1b2c500a"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga93e6b527743f433da2ff367c1b2c500a">pn_link_get_context</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="memdesc:ga93e6b527743f433da2ff367c1b2c500a"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__link.html#ga8b19ffdb7934940fa7c5fd75c5fe2d69" title="Get the attachments that are associated with a link object. ">pn_link_attachments()</a>. <a href="#ga93e6b527743f433da2ff367c1b2c500a">More...</a><br /></td></tr> <tr class="separator:ga93e6b527743f433da2ff367c1b2c500a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga376f2cc18bbd771d95aa8222586d19b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga376f2cc18bbd771d95aa8222586d19b2">pn_link_set_context</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, void *context)</td></tr> +<tr class="memdesc:ga376f2cc18bbd771d95aa8222586d19b2"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__link.html#ga8b19ffdb7934940fa7c5fd75c5fe2d69" title="Get the attachments that are associated with a link object. ">pn_link_attachments()</a>. <a href="#ga376f2cc18bbd771d95aa8222586d19b2">More...</a><br /></td></tr> <tr class="separator:ga376f2cc18bbd771d95aa8222586d19b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8b19ffdb7934940fa7c5fd75c5fe2d69"><td class="memItemLeft" align="right" valign="top">pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga8b19ffdb7934940fa7c5fd75c5fe2d69">pn_link_attachments</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> <tr class="memdesc:ga8b19ffdb7934940fa7c5fd75c5fe2d69"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a link object. <a href="#ga8b19ffdb7934940fa7c5fd75c5fe2d69">More...</a><br /></td></tr> @@ -152,6 +154,7 @@ Functions</h2></td></tr> <tr class="memdesc:gad502b38bc184ad0bfaa86dede81f62c9"><td class="mdescLeft"> </td><td class="mdescRight">Get the endpoint state flags for a link. <a href="#gad502b38bc184ad0bfaa86dede81f62c9">More...</a><br /></td></tr> <tr class="separator:gad502b38bc184ad0bfaa86dede81f62c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf6f11d778aa4622d8aa5db8962bb1f0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#gaf6f11d778aa4622d8aa5db8962bb1f0a">pn_link_error</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> +<tr class="memdesc:gaf6f11d778aa4622d8aa5db8962bb1f0a"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> <a href="#gaf6f11d778aa4622d8aa5db8962bb1f0a">More...</a><br /></td></tr> <tr class="separator:gaf6f11d778aa4622d8aa5db8962bb1f0a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga52c99044eabb7712efa2f1098c760804"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__link.html#ga52c99044eabb7712efa2f1098c760804">pn_link_condition</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link)</td></tr> <tr class="memdesc:ga52c99044eabb7712efa2f1098c760804"><td class="mdescLeft"> </td><td class="mdescRight">Get the local condition associated with a link endpoint. <a href="#ga52c99044eabb7712efa2f1098c760804">More...</a><br /></td></tr> @@ -312,7 +315,7 @@ Functions</h2></td></tr> </td></tr> <tr><td class="fieldname"><a id="gga3fb58bd0b88d37407ebb615c2630e608ac159f0edca565961b554768a42e82bf0"></a>PN_SND_SETTLED </td><td class="fielddoc"><p>The sender will send all deliveries settled to the receiver. </p> </td></tr> -<tr><td class="fieldname"><a id="gga3fb58bd0b88d37407ebb615c2630e608ac33a5700d0247976b465aeb7c1437fd1"></a>PN_SND_MIXED </td><td class="fielddoc"><p>The sender may send a mixure of settled and unsettled deliveries. </p> +<tr><td class="fieldname"><a id="gga3fb58bd0b88d37407ebb615c2630e608ac33a5700d0247976b465aeb7c1437fd1"></a>PN_SND_MIXED </td><td class="fielddoc"><p>The sender may send a mixture of settled and unsettled deliveries. </p> </td></tr> </table> @@ -462,8 +465,10 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__link.html#ga8b19ffdb7934940fa7c5fd75c5fe2d69" title="Get the attachments that are associated with a link object. ">pn_link_attachments()</a>. </p> <p>Get the application context that is associated with a link object.</p> -<p>The application context for a link may be set using <a class="el" href="group__link.html#ga376f2cc18bbd771d95aa8222586d19b2">pn_link_set_context</a>.</p> +<p>The application context for a link may be set using <a class="el" href="group__link.html#ga376f2cc18bbd771d95aa8222586d19b2" title="Deprecated - Use pn_link_attachments(). ">pn_link_set_context</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link whose context is to be returned. </td></tr> @@ -499,8 +504,10 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> + +<p><b>Deprecated</b> - Use <a class="el" href="group__link.html#ga8b19ffdb7934940fa7c5fd75c5fe2d69" title="Get the attachments that are associated with a link object. ">pn_link_attachments()</a>. </p> <p>Set a new application context for a link object.</p> -<p>The application context for a link object may be retrieved using <a class="el" href="group__link.html#ga93e6b527743f433da2ff367c1b2c500a">pn_link_get_context</a>.</p> +<p>The application context for a link object may be retrieved using <a class="el" href="group__link.html#ga93e6b527743f433da2ff367c1b2c500a" title="Deprecated - Use pn_link_attachments(). ">pn_link_get_context</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>the link object </td></tr> @@ -661,6 +668,8 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> + +<p><b>Deprecated</b> </p> <p>Get additional error information associated with the link.</p> <p>Whenever a link operation fails (i.e. returns an error code), additional error details can be obtained using this function. The error object that is returned may also be used to clear the error condition.</p> <p>The pointer returned by this operation is valid until the link object is freed.</p> @@ -1759,7 +1768,13 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the number of bytes received, PN_EOS, or an error code </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>The number of bytes received, or an error code:<ul> +<li><a class="el" href="group__error.html#ga9e0f51b097f94293cdbbdeb5422a27a3" title="End of stream. ">PN_EOS</a>: The message has been completely received</li> +<li>0: No data available now. If <a class="el" href="group__delivery.html#ga23c7b3c678228ccb21378e7c8ec9a72d" title="Check if a delivery only has partial message data. ">pn_delivery_partial()</a> there will be further <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe" title="A delivery has been created or updated. ">PN_DELIVERY</a> events with more data.</li> +<li><a class="el" href="group__error.html#ga5efbe6093556326613d2ccd3864a00aa" title="State error. ">PN_STATE_ERR</a>: The link has no current delivery</li> +<li><a class="el" href="group__error.html#ga82db456291c2627e31becc44b733a7f0" title="Delivery aborted error. ">PN_ABORTED</a>: See <a class="el" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776" title="Check if a received delivery has been aborted. ">pn_delivery_aborted()</a> </li> +</ul> +</dd></dl> </div> </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__listener.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__listener.html b/content/releases/qpid-proton-master/proton/c/api/group__listener.html index 978a078..82e898c 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__listener.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__listener.html @@ -115,9 +115,11 @@ Functions</h2></td></tr> <tr class="memitem:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaf5769baf81fdfa80e5c4326dd4a9ab63">pn_listener_free</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *l)</td></tr> <tr class="memdesc:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="mdescLeft"> </td><td class="mdescRight">Free a listener. <a href="#gaf5769baf81fdfa80e5c4326dd4a9ab63">More...</a><br /></td></tr> <tr class="separator:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaaee3c3f3822484bc2e370406abf5b736"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaaee3c3f3822484bc2e370406abf5b736">pn_listener_accept</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *)</td></tr> -<tr class="memdesc:gaaee3c3f3822484bc2e370406abf5b736"><td class="mdescLeft"> </td><td class="mdescRight">Bind <code>connection</code> to a new transport accepted from <code>listener</code>. <a href="#gaaee3c3f3822484bc2e370406abf5b736">More...</a><br /></td></tr> -<tr class="separator:gaaee3c3f3822484bc2e370406abf5b736"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3719a4ab17b8de42fc6bfb262018d070"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070">pn_listener_accept2</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> +<tr class="memdesc:ga3719a4ab17b8de42fc6bfb262018d070"><td class="mdescLeft"> </td><td class="mdescRight">Accept an incoming connection request using <code>transport</code> and <code>connection</code>, which can be configured before the call. <a href="#ga3719a4ab17b8de42fc6bfb262018d070">More...</a><br /></td></tr> +<tr class="separator:ga3719a4ab17b8de42fc6bfb262018d070"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga8a100386ab4a079ae6924aeaafc72eb9">pn_listener_accept</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="separator:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="memItemLeft" align="right" valign="top"><a id="gaa49d0d11a9f46a75fbbbebf6def2d4b2"></a> PNP_EXTERN <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaa49d0d11a9f46a75fbbbebf6def2d4b2">pn_listener_condition</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *l)</td></tr> <tr class="memdesc:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="mdescLeft"> </td><td class="mdescRight">Get the error condition for a listener. <br /></td></tr> @@ -183,23 +185,29 @@ PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad </div> </div> -<a id="gaaee3c3f3822484bc2e370406abf5b736"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaaee3c3f3822484bc2e370406abf5b736">◆ </a></span>pn_listener_accept()</h2> +<a id="ga3719a4ab17b8de42fc6bfb262018d070"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3719a4ab17b8de42fc6bfb262018d070">◆ </a></span>pn_listener_accept2()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">PNP_EXTERN void pn_listener_accept </td> + <td class="memname">PNP_EXTERN void pn_listener_accept2 </td> <td>(</td> <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> - <td class="paramname">, </td> + <td class="paramname"><em>listener</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> - <td class="paramname"> </td> + <td class="paramname"><em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> + <td class="paramname"><em>transport</em> </td> </tr> <tr> <td></td> @@ -209,8 +217,46 @@ PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad </table> </div><div class="memdoc"> -<p>Bind <code>connection</code> to a new transport accepted from <code>listener</code>. </p> -<p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> events by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a>. </p> +<p>Accept an incoming connection request using <code>transport</code> and <code>connection</code>, which can be configured before the call. </p> +<p>Call after a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c">PN_LISTENER_ACCEPT</a> event.</p> +<p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> events by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle. ">pn_proactor_wait()</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">listener</td><td>the listener </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>If NULL a new connection is created. Memory management is the same as for <a class="el" href="group__proactor.html#gabb093e51449351cf5530bb300bd67ba1" title="Connect transport to addr and bind to connection. ">pn_proactor_connect2()</a> </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>If NULL a new transport is created. Memory management is the same as for <a class="el" href="group__proactor.html#gabb093e51449351cf5530bb300bd67ba1" title="Connect transport to addr and bind to connection. ">pn_proactor_connect2()</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga8a100386ab4a079ae6924aeaafc72eb9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8a100386ab4a079ae6924aeaafc72eb9">◆ </a></span>pn_listener_accept()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PNP_EXTERN void pn_listener_accept </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> + <td class="paramname"><em>listener</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> + <td class="paramname"><em>connection</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use pn_listener_accept2(listener, connection, NULL) </dd></dl> </div> </div> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__listener.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__listener.js b/content/releases/qpid-proton-master/proton/c/api/group__listener.js index c9383d9..52c2656 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__listener.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__listener.js @@ -3,7 +3,8 @@ var group__listener = [ "pn_listener_t", "group__listener.html#ga68ac7072ae60612d0bca5470014bf216", null ], [ "pn_listener", "group__listener.html#gabba0a7d2e916188e3ec07d0acf8f3fc5", null ], [ "pn_listener_free", "group__listener.html#gaf5769baf81fdfa80e5c4326dd4a9ab63", null ], - [ "pn_listener_accept", "group__listener.html#gaaee3c3f3822484bc2e370406abf5b736", null ], + [ "pn_listener_accept2", "group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070", null ], + [ "pn_listener_accept", "group__listener.html#ga8a100386ab4a079ae6924aeaafc72eb9", null ], [ "pn_listener_condition", "group__listener.html#gaa49d0d11a9f46a75fbbbebf6def2d4b2", null ], [ "pn_listener_attachments", "group__listener.html#gae94f2acd3463fc0a42b1b5dd68d9326f", null ], [ "pn_listener_close", "group__listener.html#ga17a5b8573f00e16b233c59a3bb17c104", null ], http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__message.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__message.html b/content/releases/qpid-proton-master/proton/c/api/group__message.html index 864868d..52bb554 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__message.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__message.html @@ -258,17 +258,20 @@ Functions</h2></td></tr> <tr class="memdesc:gadadb16710eccb6d332d039acc9dc1042"><td class="mdescLeft"> </td><td class="mdescRight">Get/set the annotations for a message. <a href="#gadadb16710eccb6d332d039acc9dc1042">More...</a><br /></td></tr> <tr class="separator:gadadb16710eccb6d332d039acc9dc1042"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga43c7ee6ab70316145fb2bb5fcad210ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga43c7ee6ab70316145fb2bb5fcad210ad">pn_message_properties</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg)</td></tr> -<tr class="memdesc:ga43c7ee6ab70316145fb2bb5fcad210ad"><td class="mdescLeft"> </td><td class="mdescRight">Get/set the properties for a message. <a href="#ga43c7ee6ab70316145fb2bb5fcad210ad">More...</a><br /></td></tr> +<tr class="memdesc:ga43c7ee6ab70316145fb2bb5fcad210ad"><td class="mdescLeft"> </td><td class="mdescRight">Get and set the properties for a message. <a href="#ga43c7ee6ab70316145fb2bb5fcad210ad">More...</a><br /></td></tr> <tr class="separator:ga43c7ee6ab70316145fb2bb5fcad210ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga145c06edbcccfbe97136bfb5cb2b22b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga145c06edbcccfbe97136bfb5cb2b22b1">pn_message_body</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg)</td></tr> -<tr class="memdesc:ga145c06edbcccfbe97136bfb5cb2b22b1"><td class="mdescLeft"> </td><td class="mdescRight">Get/set the body of a message. <a href="#ga145c06edbcccfbe97136bfb5cb2b22b1">More...</a><br /></td></tr> +<tr class="memdesc:ga145c06edbcccfbe97136bfb5cb2b22b1"><td class="mdescLeft"> </td><td class="mdescRight">Get and set the body of a message. <a href="#ga145c06edbcccfbe97136bfb5cb2b22b1">More...</a><br /></td></tr> <tr class="separator:ga145c06edbcccfbe97136bfb5cb2b22b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab0bae90838f4661b0c82c15f25e1e988"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gab0bae90838f4661b0c82c15f25e1e988">pn_message_decode</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg, const char *bytes, size_t size)</td></tr> <tr class="memdesc:gab0bae90838f4661b0c82c15f25e1e988"><td class="mdescLeft"> </td><td class="mdescRight">Decode/load message content from AMQP formatted binary data. <a href="#gab0bae90838f4661b0c82c15f25e1e988">More...</a><br /></td></tr> <tr class="separator:gab0bae90838f4661b0c82c15f25e1e988"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2173bbce3c1f4b04074e42d2fe7da473"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga2173bbce3c1f4b04074e42d2fe7da473">pn_message_encode</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg, char *bytes, size_t *size)</td></tr> -<tr class="memdesc:ga2173bbce3c1f4b04074e42d2fe7da473"><td class="mdescLeft"> </td><td class="mdescRight">Encode/save message content as AMQP formatted binary data. <a href="#ga2173bbce3c1f4b04074e42d2fe7da473">More...</a><br /></td></tr> +<tr class="memdesc:ga2173bbce3c1f4b04074e42d2fe7da473"><td class="mdescLeft"> </td><td class="mdescRight">Encode a message as AMQP formatted binary data. <a href="#ga2173bbce3c1f4b04074e42d2fe7da473">More...</a><br /></td></tr> <tr class="separator:ga2173bbce3c1f4b04074e42d2fe7da473"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga86cd32577f0e78bab29bd0e49869f0b5"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga86cd32577f0e78bab29bd0e49869f0b5">pn_message_send</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg, <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *sender, <a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a> *buf)</td></tr> +<tr class="memdesc:ga86cd32577f0e78bab29bd0e49869f0b5"><td class="mdescLeft"> </td><td class="mdescRight">Encode and send a message on a sender link. <a href="#ga86cd32577f0e78bab29bd0e49869f0b5">More...</a><br /></td></tr> +<tr class="separator:ga86cd32577f0e78bab29bd0e49869f0b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga013d429f94d653bc1e00f1f438a079a6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga013d429f94d653bc1e00f1f438a079a6">pn_message_data</a> (<a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg, <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data)</td></tr> <tr class="memdesc:ga013d429f94d653bc1e00f1f438a079a6"><td class="mdescLeft"> </td><td class="mdescRight">Save message content into a pn_data_t object data. <a href="#ga013d429f94d653bc1e00f1f438a079a6">More...</a><br /></td></tr> <tr class="separator:ga013d429f94d653bc1e00f1f438a079a6"><td class="memSeparator" colspan="2"> </td></tr> @@ -872,7 +875,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Get the id for a message. </p> -<p>The message id provides a globally unique identifier for a message. A message id can be an a string, an unsigned long, a uuid or a binary value. This operation returns the value of the id using the <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> descriminated union. See <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> for details on how to access the value.</p> +<p>The message id provides a globally unique identifier for a message. A message id can be an a string, an unsigned long, a uuid or a binary value. This operation returns the value of the id using the <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a> discriminated union. See <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a> for details on how to access the value.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>a message object </td></tr> @@ -1255,7 +1258,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Get the correlation id for a message. </p> -<p>A correlation id can be an a string, an unsigned long, a uuid or a binary value. This operation returns the value of the id using the <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> descriminated union. See <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> for details on how to access the value.</p> +<p>A correlation id can be an a string, an unsigned long, a uuid or a binary value. This operation returns the value of the id using the <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a> discriminated union. See <a class="el" href="group__api__types.html#structpn__atom__t" title="A discriminated union that holds any scalar AMQP value. ">pn_atom_t</a> for details on how to access the value.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>a message object </td></tr> @@ -1868,7 +1871,7 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get/set the properties for a message. </p> +<p>Get and set the properties for a message. </p> <p>This operation returns a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> representing the content of the properties section of a message. The pointer is valid until the message is freed and may be used to both access and modify the content of the properties section of a message.</p> <p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> must either be empty or consist of a string keyed map in order to be considered valid message properties.</p> <dl class="params"><dt>Parameters</dt><dd> @@ -1897,7 +1900,7 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get/set the body of a message. </p> +<p>Get and set the body of a message. </p> <p>This operation returns a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> representing the body of a message. The pointer is valid until the message is freed and may be used to both access and modify the content of the message body.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> @@ -1987,7 +1990,7 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Encode/save message content as AMQP formatted binary data. </p> +<p>Encode a message as AMQP formatted binary data. </p> <p>If the buffer space provided is insufficient to store the content held in the message, the operation will fail and return a PN_OVERFLOW error code.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> @@ -2002,6 +2005,65 @@ Functions</h2></td></tr> </div> </div> +<a id="ga86cd32577f0e78bab29bd0e49869f0b5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga86cd32577f0e78bab29bd0e49869f0b5">◆ </a></span>pn_message_send()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ssize_t pn_message_send </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> * </td> + <td class="paramname"><em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a> * </td> + <td class="paramname"><em>buf</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Encode and send a message on a sender link. </p> +<p>Performs the following steps:</p><ul> +<li>create or expand the buffer <code>buf</code> as required</li> +<li>call <a class="el" href="group__message.html#ga2173bbce3c1f4b04074e42d2fe7da473" title="Encode a message as AMQP formatted binary data. ">pn_message_encode()</a> to encode the message to a buffer</li> +<li>call <a class="el" href="group__link.html#gaa825fac21730f3f9fff37d156e5f88e9" title="Send message data for the current delivery on a link. ">pn_link_send()</a> to send the encoded message bytes</li> +<li>call <a class="el" href="group__link.html#ga93824a3859c37463e44458cd2f63d31f" title="Advance the current delivery of a link to the next delivery on the link. ">pn_link_advance()</a> to indicate the message is complete</li> +</ul> +<p>Note: you must create a delivery for the message before calling <a class="el" href="group__message.html#ga86cd32577f0e78bab29bd0e49869f0b5" title="Encode and send a message on a sender link. ">pn_message_send()</a> see <a class="el" href="group__delivery.html#ga6a7ef2e317b4ed292cafbb358f0ba6ad" title="Create a delivery on a link. ">pn_delivery()</a></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>A message object. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">sender</td><td>A sending link. The message will be encoded and sent with <a class="el" href="group__link.html#gaa825fac21730f3f9fff37d156e5f88e9" title="Send message data for the current delivery on a link. ">pn_link_send()</a> </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">buf</td><td>Used to encode the message.<ul> +<li>if buf == NULL, temporary space will be allocated and freed with malloc()/free()</li> +<li>if buf->start != NULL and buf->size is large enough, the message is encoded to buf->start</li> +<li><p class="startli">if buf->start == NULL or buf->size is not enough, the buffer will be extended like this: </p><pre class="fragment">buf->size = new_size; buf->start = realloc(buf->start, new_size) +</pre><p class="startli">it is possible for the buffer to be extended more than once. </p> +</li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The number of bytes encoded and sent on success. Returns an error code (< 0) on failure and sets <a class="el" href="group__message.html#ga9ad09178e7682efde76e2d39f352dfe8" title="Access the error information for a message. ">pn_message_error()</a> on msg </dd></dl> + +</div> +</div> <a id="ga013d429f94d653bc1e00f1f438a079a6"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga013d429f94d653bc1e00f1f438a079a6">◆ </a></span>pn_message_data()</h2> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/group__message.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__message.js b/content/releases/qpid-proton-master/proton/c/api/group__message.js index 1840c7c..0993d41 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__message.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__message.js @@ -53,5 +53,6 @@ var group__message = [ "pn_message_body", "group__message.html#ga145c06edbcccfbe97136bfb5cb2b22b1", null ], [ "pn_message_decode", "group__message.html#gab0bae90838f4661b0c82c15f25e1e988", null ], [ "pn_message_encode", "group__message.html#ga2173bbce3c1f4b04074e42d2fe7da473", null ], + [ "pn_message_send", "group__message.html#ga86cd32577f0e78bab29bd0e49869f0b5", null ], [ "pn_message_data", "group__message.html#ga013d429f94d653bc1e00f1f438a079a6", null ] ]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
