http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__terminus.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__terminus.html b/content/releases/qpid-proton-master/proton/c/api/group__terminus.html index ba5db5b..0018ca4 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__terminus.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__terminus.html @@ -3,7 +3,8 @@ <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.11"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Qpid Proton C API: Terminus</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> @@ -14,7 +15,6 @@ <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> @@ -55,7 +55,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.11 --> +<!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> @@ -199,7 +199,9 @@ Functions</h2></td></tr> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>A source or target for messages. </p> <h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="gad202baf5c904d6991e13521b7c93fdc2"></a> +<a id="gad202baf5c904d6991e13521b7c93fdc2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad202baf5c904d6991e13521b7c93fdc2">◆ </a></span>pn_terminus_t</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -215,33 +217,35 @@ Functions</h2></td></tr> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> -<a class="anchor" id="gac6fb89a5fa96476db51b60f10dc785d0"></a> +<a id="ga3cb9c86d1e2bb024de2658f9def098e7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3cb9c86d1e2bb024de2658f9def098e7">◆ </a></span>pn_terminus_type_t</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">enum <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a></td> + <td class="memname">enum <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a></td> </tr> </table> </div><div class="memdoc"> -<p>Distribution mode of an AMQP terminus. </p> -<p>The distribution mode of a source terminus defines the behaviour when multiple receiving links provide addresses that resolve to the same node. </p> +<p>Type of an AMQP terminus. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac"></a>PN_DIST_MODE_UNSPECIFIED </td><td class="fielddoc"> -<p>the behaviour is defined by the node </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216"></a>PN_UNSPECIFIED </td><td class="fielddoc"><p>indicates a nonexistent terminus, may used as a source or target </p> +</td></tr> +<tr><td class="fieldname"><a id="gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0"></a>PN_SOURCE </td><td class="fielddoc"><p>indicates a source of messages </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523"></a>PN_DIST_MODE_COPY </td><td class="fielddoc"> -<p>the receiver gets all messages </p> +<tr><td class="fieldname"><a id="gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e"></a>PN_TARGET </td><td class="fielddoc"><p>indicates a target for messages </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92"></a>PN_DIST_MODE_MOVE </td><td class="fielddoc"> -<p>the receiver competes for messages </p> +<tr><td class="fieldname"><a id="gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae"></a>PN_COORDINATOR </td><td class="fielddoc"><p>a special target identifying a transaction coordinator </p> </td></tr> </table> </div> </div> -<a class="anchor" id="ga213267363be45848f3299471ea93089b"></a> +<a id="ga213267363be45848f3299471ea93089b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga213267363be45848f3299471ea93089b">◆ </a></span>pn_durability_t</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -254,20 +258,19 @@ Functions</h2></td></tr> <p>Durability mode of an AMQP terminus. </p> <p>An AMQP terminus may provide durable storage for its state, thereby permitting link recovery in the event of endpoint failures. This durability may be applied to the configuration of the terminus only, or to all delivery state as well. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b"></a>PN_NONDURABLE </td><td class="fielddoc"> -<p>indicates a non durable terminus </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b"></a>PN_NONDURABLE </td><td class="fielddoc"><p>indicates a non durable terminus </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58"></a>PN_CONFIGURATION </td><td class="fielddoc"> -<p>indicates a terminus with durably held configuration, but not delivery state </p> +<tr><td class="fieldname"><a id="gga213267363be45848f3299471ea93089ba95b1d5b60c47569e0358258305de1d58"></a>PN_CONFIGURATION </td><td class="fielddoc"><p>indicates a terminus with durably held configuration, but not delivery state </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2"></a>PN_DELIVERIES </td><td class="fielddoc"> -<p>indicates a terminus with both durably held configuration and durably held delivery state. </p> +<tr><td class="fieldname"><a id="gga213267363be45848f3299471ea93089bac2e0a9f773faf4ee8fd43f77855933d2"></a>PN_DELIVERIES </td><td class="fielddoc"><p>indicates a terminus with both durably held configuration and durably held delivery state. </p> </td></tr> </table> </div> </div> -<a class="anchor" id="gab4089b27ee99a348deab776f3d4931f0"></a> +<a id="gab4089b27ee99a348deab776f3d4931f0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab4089b27ee99a348deab776f3d4931f0">◆ </a></span>pn_expiry_policy_t</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -280,57 +283,52 @@ Functions</h2></td></tr> <p>Expiry policy of an AMQP terminus. </p> <p>An orphaned terminus can only exist for the timeout configured by <a class="el" href="group__terminus.html#ga8b6c30afc3aa73aac6fc30875fbc386d" title="Set the timeout of a terminus object. ">pn_terminus_set_timeout</a>. The expiry policy determins when a terminus is considered orphaned, i.e. when the expiry timer starts counting down. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0ad559c0f96078b8b7d8b84b77354b2391"></a>PN_EXPIRE_WITH_LINK </td><td class="fielddoc"> -<p>the terminus is orphaned when the parent link is closed </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab4089b27ee99a348deab776f3d4931f0ad559c0f96078b8b7d8b84b77354b2391"></a>PN_EXPIRE_WITH_LINK </td><td class="fielddoc"><p>the terminus is orphaned when the parent link is closed </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a02ac8e7dfc45bb4ae66e97624adaca01"></a>PN_EXPIRE_WITH_SESSION </td><td class="fielddoc"> -<p>the terminus is orphaned when the parent session is closed </p> +<tr><td class="fieldname"><a id="ggab4089b27ee99a348deab776f3d4931f0a02ac8e7dfc45bb4ae66e97624adaca01"></a>PN_EXPIRE_WITH_SESSION </td><td class="fielddoc"><p>the terminus is orphaned when the parent session is closed </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5"></a>PN_EXPIRE_WITH_CONNECTION </td><td class="fielddoc"> -<p>the terminus is orphaned when the parent connection is closed </p> +<tr><td class="fieldname"><a id="ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5"></a>PN_EXPIRE_WITH_CONNECTION </td><td class="fielddoc"><p>the terminus is orphaned when the parent connection is closed </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556"></a>PN_EXPIRE_NEVER </td><td class="fielddoc"> -<p>the terminus is never considered orphaned </p> +<tr><td class="fieldname"><a id="ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556"></a>PN_EXPIRE_NEVER </td><td class="fielddoc"><p>the terminus is never considered orphaned </p> </td></tr> </table> </div> </div> -<a class="anchor" id="ga3cb9c86d1e2bb024de2658f9def098e7"></a> +<a id="gac6fb89a5fa96476db51b60f10dc785d0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac6fb89a5fa96476db51b60f10dc785d0">◆ </a></span>pn_distribution_mode_t</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">enum <a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a></td> + <td class="memname">enum <a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a></td> </tr> </table> </div><div class="memdoc"> -<p>Type of an AMQP terminus. </p> +<p>Distribution mode of an AMQP terminus. </p> +<p>The distribution mode of a source terminus defines the behaviour when multiple receiving links provide addresses that resolve to the same node. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216"></a>PN_UNSPECIFIED </td><td class="fielddoc"> -<p>indicates a nonexistent terminus, may used as a source or target </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0"></a>PN_SOURCE </td><td class="fielddoc"> -<p>indicates a source of messages </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac"></a>PN_DIST_MODE_UNSPECIFIED </td><td class="fielddoc"><p>the behaviour is defined by the node </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e"></a>PN_TARGET </td><td class="fielddoc"> -<p>indicates a target for messages </p> +<tr><td class="fieldname"><a id="ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523"></a>PN_DIST_MODE_COPY </td><td class="fielddoc"><p>the receiver gets all messages </p> </td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae"></a>PN_COORDINATOR </td><td class="fielddoc"> -<p>a special target identifying a transaction coordinator </p> +<tr><td class="fieldname"><a id="ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92"></a>PN_DIST_MODE_MOVE </td><td class="fielddoc"><p>the receiver competes for messages </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga5cc480060f3fda737a333ac7a2ea0d70"></a> +<a id="ga2461341ae0d8c2261277837e6e20d2de"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2461341ae0d8c2261277837e6e20d2de">◆ </a></span>pn_terminus_get_type()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_capabilities </td> + <td class="memname"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> pn_terminus_get_type </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em></td><td>)</td> @@ -339,24 +337,25 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Access/modify the AMQP capabilities data for a terminus object. </p> -<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP capabilities for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> +<p>Get the type of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus capabilities </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the terminus type </dd></dl> </div> </div> -<a class="anchor" id="gaa1ad0b04b1625ac1ba5993b6679dcfcf"></a> +<a id="ga822fceb77515b691a10bf5381e4562ec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga822fceb77515b691a10bf5381e4562ec">◆ </a></span>pn_terminus_set_type()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_copy </td> + <td class="memname">int pn_terminus_set_type </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em>, </td> @@ -364,8 +363,8 @@ Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>src</em> </td> + <td class="paramtype"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td> + <td class="paramname"><em>type</em> </td> </tr> <tr> <td></td> @@ -375,11 +374,11 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Copy a terminus object. </p> +<p>Set the type of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>the terminus object to be copied into </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>the terminus to be copied from </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>the terminus type </td></tr> </table> </dd> </dl> @@ -387,12 +386,14 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gafb9c4b3d344dd94ae174ecd8d25f503c"></a> +<a id="ga3507b6cfe260a2bfaae9321235db7c9a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3507b6cfe260a2bfaae9321235db7c9a">◆ </a></span>pn_terminus_get_address()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_filter </td> + <td class="memname">const char* pn_terminus_get_address </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em></td><td>)</td> @@ -401,46 +402,61 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Access/modify the AMQP filter set for a terminus object. </p> -<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP filter set for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> +<p>Get the address of a terminus object. </p> +<p>The pointer returned by this operation is valid until <a class="el" href="group__terminus.html#ga0603db45f03fcef0ef18f4f89ebf3de1" title="Set the address of a terminus object. ">pn_terminus_set_address</a> is called or until the terminus is freed due to its parent link being freed.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a source terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus filter set </dd></dl> - +<dl class="section return"><dt>Returns</dt><dd>a pointer to the address </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a16">broker.c</a>.</dd> +</dl> </div> </div> -<a class="anchor" id="ga3507b6cfe260a2bfaae9321235db7c9a"></a> +<a id="ga0603db45f03fcef0ef18f4f89ebf3de1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0603db45f03fcef0ef18f4f89ebf3de1">◆ </a></span>pn_terminus_set_address()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">const char* pn_terminus_get_address </td> + <td class="memname">int pn_terminus_set_address </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em></td><td>)</td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>address</em> </td> + </tr> + <tr> <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Get the address of a terminus object. </p> -<p>The pointer returned by this operation is valid until <a class="el" href="group__terminus.html#ga0603db45f03fcef0ef18f4f89ebf3de1" title="Set the address of a terminus object. ">pn_terminus_set_address</a> is called or until the terminus is freed due to its parent link being freed.</p> +<p>Set the address of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an AMQP address string </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>a pointer to the address </dd></dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a18">broker.c</a>.</dd> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a49">broker.c</a>, <a class="el" href="direct_8c-example.html#a48">direct.c</a>, <a class="el" href="receive_8c-example.html#a21">receive.c</a>, and <a class="el" href="send_8c-example.html#a32">send.c</a>.</dd> </dl> </div> </div> -<a class="anchor" id="ga5edfc0f1d61880e1951c21f92c19af53"></a> +<a id="ga5edfc0f1d61880e1951c21f92c19af53"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5edfc0f1d61880e1951c21f92c19af53">◆ </a></span>pn_terminus_get_distribution_mode()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -465,37 +481,52 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gad9f06855cd6538f672c63836b8ef0ae5"></a> +<a id="gaabb94d82847495c909aab24365d048c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaabb94d82847495c909aab24365d048c6">◆ </a></span>pn_terminus_set_distribution_mode()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> pn_terminus_get_durability </td> + <td class="memname">int pn_terminus_set_distribution_mode </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em></td><td>)</td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> </td> + <td class="paramname"><em>mode</em> </td> + </tr> + <tr> <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Get the durability mode of a terminus object. </p> +<p>Set the distribution mode of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the distribution mode for the terminus </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the terminus durability mode </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> </div> </div> -<a class="anchor" id="ga0f9df2253065f81fd304f39a846e6468"></a> +<a id="gad9f06855cd6538f672c63836b8ef0ae5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad9f06855cd6538f672c63836b8ef0ae5">◆ </a></span>pn_terminus_get_durability()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> pn_terminus_get_expiry_policy </td> + <td class="memname"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> pn_terminus_get_durability </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em></td><td>)</td> @@ -504,48 +535,63 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get the expiry policy of a terminus object. </p> +<p>Get the durability mode of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the expiry policy of the terminus </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the terminus durability mode </dd></dl> </div> </div> -<a class="anchor" id="ga62ba74b0c8fad5417a62cffe53996690"></a> +<a id="gac5e15021927b18d0aa3fd712e4b0ac73"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac5e15021927b18d0aa3fd712e4b0ac73">◆ </a></span>pn_terminus_set_durability()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> pn_terminus_get_timeout </td> + <td class="memname">int pn_terminus_set_durability </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em></td><td>)</td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td> + <td class="paramname"><em>durability</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Get the timeout of a terminus object. </p> +<p>Set the durability mode of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">durability</td><td>the terminus durability mode </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the timeout of the terminus </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> </div> </div> -<a class="anchor" id="ga2461341ae0d8c2261277837e6e20d2de"></a> +<a id="ga0f9df2253065f81fd304f39a846e6468"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0f9df2253065f81fd304f39a846e6468">◆ </a></span>pn_terminus_get_expiry_policy()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> pn_terminus_get_type </td> + <td class="memname"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> pn_terminus_get_expiry_policy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em></td><td>)</td> @@ -554,48 +600,63 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get the type of a terminus object. </p> +<p>Get the expiry policy of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>the terminus type </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the expiry policy of the terminus </dd></dl> </div> </div> -<a class="anchor" id="gaf9d4257ba00d3e0e0f8d983324018209"></a> +<a id="gaaad123d27d82b2f7d051489a8bff73c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaad123d27d82b2f7d051489a8bff73c6">◆ </a></span>pn_terminus_set_expiry_policy()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">bool pn_terminus_is_dynamic </td> + <td class="memname">int pn_terminus_set_expiry_policy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em></td><td>)</td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td> + <td class="paramname"><em>policy</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Get the dynamic flag for a terminus object. </p> +<p>Set the expiry policy of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>the expiry policy for the terminus </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>true if the dynamic flag is set for the terminus, false otherwise </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> </div> </div> -<a class="anchor" id="ga35d4ced3a1e9056c50adf3a6e051e0d8"></a> +<a id="ga62ba74b0c8fad5417a62cffe53996690"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga62ba74b0c8fad5417a62cffe53996690">◆ </a></span>pn_terminus_get_timeout()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_outcomes </td> + <td class="memname"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> pn_terminus_get_timeout </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em></td><td>)</td> @@ -604,87 +665,90 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Access/modify the AMQP outcomes for a terminus object. </p> -<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP outcomes for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> +<p>Get the timeout of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus outcomes </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the timeout of the terminus </dd></dl> </div> </div> -<a class="anchor" id="gae9c9515f94353eb82cb421e46ce4bb24"></a> +<a id="ga8b6c30afc3aa73aac6fc30875fbc386d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8b6c30afc3aa73aac6fc30875fbc386d">◆ </a></span>pn_terminus_set_timeout()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_properties </td> + <td class="memname">int pn_terminus_set_timeout </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em></td><td>)</td> + <td class="paramname"><em>terminus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Access/modify the AMQP properties data for a terminus object. </p> -<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP properties for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> +<p>Set the timeout of a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the timeout for the terminus </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus properties </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> </div> </div> -<a class="anchor" id="ga0603db45f03fcef0ef18f4f89ebf3de1"></a> +<a id="gaf9d4257ba00d3e0e0f8d983324018209"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf9d4257ba00d3e0e0f8d983324018209">◆ </a></span>pn_terminus_is_dynamic()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_address </td> + <td class="memname">bool pn_terminus_is_dynamic </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>address</em> </td> - </tr> - <tr> + <td class="paramname"><em>terminus</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the address of a terminus object. </p> +<p>Get the dynamic flag for a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an AMQP address string </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> -<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a51">broker.c</a>, <a class="el" href="receive_8c-example.html#a21">receive.c</a>, and <a class="el" href="send_8c-example.html#a39">send.c</a>.</dd> -</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the dynamic flag is set for the terminus, false otherwise </dd></dl> + </div> </div> -<a class="anchor" id="gaabb94d82847495c909aab24365d048c6"></a> +<a id="ga7779782e173db3efcd5de211e0f935ae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7779782e173db3efcd5de211e0f935ae">◆ </a></span>pn_terminus_set_dynamic()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_distribution_mode </td> + <td class="memname">int pn_terminus_set_dynamic </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em>, </td> @@ -692,8 +756,8 @@ Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0">pn_distribution_mode_t</a> </td> - <td class="paramname"><em>mode</em> </td> + <td class="paramtype">bool </td> + <td class="paramname"><em>dynamic</em> </td> </tr> <tr> <td></td> @@ -703,11 +767,11 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Set the distribution mode of a terminus object. </p> +<p>Set the dynamic flag for a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the distribution mode for the terminus </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dynamic</td><td>the dynamic flag for the terminus </td></tr> </table> </dd> </dl> @@ -715,156 +779,126 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gac5e15021927b18d0aa3fd712e4b0ac73"></a> +<a id="gae9c9515f94353eb82cb421e46ce4bb24"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae9c9515f94353eb82cb421e46ce4bb24">◆ </a></span>pn_terminus_properties()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_durability </td> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_properties </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>terminus</em></td><td>)</td> <td></td> - <td class="paramtype"><a class="el" href="group__terminus.html#ga213267363be45848f3299471ea93089b">pn_durability_t</a> </td> - <td class="paramname"><em>durability</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the durability mode of a terminus object. </p> +<p>Access/modify the AMQP properties data for a terminus object. </p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP properties for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">durability</td><td>the terminus durability mode </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus properties </dd></dl> </div> </div> -<a class="anchor" id="ga7779782e173db3efcd5de211e0f935ae"></a> +<a id="ga5cc480060f3fda737a333ac7a2ea0d70"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5cc480060f3fda737a333ac7a2ea0d70">◆ </a></span>pn_terminus_capabilities()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_dynamic </td> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_capabilities </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool </td> - <td class="paramname"><em>dynamic</em> </td> - </tr> - <tr> + <td class="paramname"><em>terminus</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the dynamic flag for a terminus object. </p> +<p>Access/modify the AMQP capabilities data for a terminus object. </p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP capabilities for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">dynamic</td><td>the dynamic flag for the terminus </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus capabilities </dd></dl> </div> </div> -<a class="anchor" id="gaaad123d27d82b2f7d051489a8bff73c6"></a> +<a id="ga35d4ced3a1e9056c50adf3a6e051e0d8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga35d4ced3a1e9056c50adf3a6e051e0d8">◆ </a></span>pn_terminus_outcomes()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_expiry_policy </td> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_outcomes </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__terminus.html#gab4089b27ee99a348deab776f3d4931f0">pn_expiry_policy_t</a> </td> - <td class="paramname"><em>policy</em> </td> - </tr> - <tr> + <td class="paramname"><em>terminus</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the expiry policy of a terminus object. </p> +<p>Access/modify the AMQP outcomes for a terminus object. </p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP outcomes for the parent terminus object. Note that this MUST take the form of an array of symbols to be valid.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>the expiry policy for the terminus </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus outcomes </dd></dl> </div> </div> -<a class="anchor" id="ga8b6c30afc3aa73aac6fc30875fbc386d"></a> +<a id="gafb9c4b3d344dd94ae174ecd8d25f503c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafb9c4b3d344dd94ae174ecd8d25f503c">◆ </a></span>pn_terminus_filter()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_timeout </td> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_terminus_filter </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> - <td class="paramname"><em>terminus</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> </td> - <td class="paramname"><em>timeout</em> </td> - </tr> - <tr> + <td class="paramname"><em>terminus</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the timeout of a terminus object. </p> +<p>Access/modify the AMQP filter set for a terminus object. </p> +<p>This operation will return a pointer to a <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object that is valid until the terminus object is freed due to its parent link being freed. Any data contained by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> object will be sent as the AMQP filter set for the parent terminus object. Note that this MUST take the form of a symbol keyed map to be valid.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the timeout for the terminus </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a source terminus object </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to a pn_data_t representing the terminus filter set </dd></dl> </div> </div> -<a class="anchor" id="ga822fceb77515b691a10bf5381e4562ec"></a> +<a id="gaa1ad0b04b1625ac1ba5993b6679dcfcf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa1ad0b04b1625ac1ba5993b6679dcfcf">◆ </a></span>pn_terminus_copy()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int pn_terminus_set_type </td> + <td class="memname">int pn_terminus_copy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> <td class="paramname"><em>terminus</em>, </td> @@ -872,8 +906,8 @@ Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7">pn_terminus_type_t</a> </td> - <td class="paramname"><em>type</em> </td> + <td class="paramtype"><a class="el" href="group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2">pn_terminus_t</a> * </td> + <td class="paramname"><em>src</em> </td> </tr> <tr> <td></td> @@ -883,11 +917,11 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Set the type of a terminus object. </p> +<p>Copy a terminus object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>a terminus object </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>the terminus type </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">terminus</td><td>the terminus object to be copied into </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>the terminus to be copied from </td></tr> </table> </dd> </dl> @@ -902,7 +936,7 @@ Functions</h2></td></tr> <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.11 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__terminus.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__terminus.js b/content/releases/qpid-proton-master/proton/c/api/group__terminus.js index 6ed6bb9..efad5dc 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__terminus.js +++ b/content/releases/qpid-proton-master/proton/c/api/group__terminus.js @@ -1,10 +1,11 @@ var group__terminus = [ [ "pn_terminus_t", "group__terminus.html#gad202baf5c904d6991e13521b7c93fdc2", null ], - [ "pn_distribution_mode_t", "group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0", [ - [ "PN_DIST_MODE_UNSPECIFIED", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac", null ], - [ "PN_DIST_MODE_COPY", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523", null ], - [ "PN_DIST_MODE_MOVE", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92", null ] + [ "pn_terminus_type_t", "group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7", [ + [ "PN_UNSPECIFIED", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216", null ], + [ "PN_SOURCE", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0", null ], + [ "PN_TARGET", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e", null ], + [ "PN_COORDINATOR", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae", null ] ] ], [ "pn_durability_t", "group__terminus.html#ga213267363be45848f3299471ea93089b", [ [ "PN_NONDURABLE", "group__terminus.html#gga213267363be45848f3299471ea93089ba403e259f8d858d6a12f463dbd7e5dc6b", null ], @@ -17,29 +18,28 @@ var group__terminus = [ "PN_EXPIRE_WITH_CONNECTION", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a188731d2f46e10273d74ae7cedbd5bb5", null ], [ "PN_EXPIRE_NEVER", "group__terminus.html#ggab4089b27ee99a348deab776f3d4931f0a52bf932997783f578fd29c0a4659c556", null ] ] ], - [ "pn_terminus_type_t", "group__terminus.html#ga3cb9c86d1e2bb024de2658f9def098e7", [ - [ "PN_UNSPECIFIED", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7accee852b0d609496d88d91d683784216", null ], - [ "PN_SOURCE", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a7fd70c48647a2edc5167bce3ade8f2f0", null ], - [ "PN_TARGET", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a760e5ca8afcbee9f43a72cfd09b7c54e", null ], - [ "PN_COORDINATOR", "group__terminus.html#gga3cb9c86d1e2bb024de2658f9def098e7a75bb94f03973a939835d98e9b1999aae", null ] + [ "pn_distribution_mode_t", "group__terminus.html#gac6fb89a5fa96476db51b60f10dc785d0", [ + [ "PN_DIST_MODE_UNSPECIFIED", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a74d3ae9ce3ad50e5c5cc71164a2a8aac", null ], + [ "PN_DIST_MODE_COPY", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a914fec87d6b3211d5f2eeb780819e523", null ], + [ "PN_DIST_MODE_MOVE", "group__terminus.html#ggac6fb89a5fa96476db51b60f10dc785d0a9e076691930f95f32c850ea01a808b92", null ] ] ], - [ "pn_terminus_capabilities", "group__terminus.html#ga5cc480060f3fda737a333ac7a2ea0d70", null ], - [ "pn_terminus_copy", "group__terminus.html#gaa1ad0b04b1625ac1ba5993b6679dcfcf", null ], - [ "pn_terminus_filter", "group__terminus.html#gafb9c4b3d344dd94ae174ecd8d25f503c", null ], + [ "pn_terminus_get_type", "group__terminus.html#ga2461341ae0d8c2261277837e6e20d2de", null ], + [ "pn_terminus_set_type", "group__terminus.html#ga822fceb77515b691a10bf5381e4562ec", null ], [ "pn_terminus_get_address", "group__terminus.html#ga3507b6cfe260a2bfaae9321235db7c9a", null ], + [ "pn_terminus_set_address", "group__terminus.html#ga0603db45f03fcef0ef18f4f89ebf3de1", null ], [ "pn_terminus_get_distribution_mode", "group__terminus.html#ga5edfc0f1d61880e1951c21f92c19af53", null ], + [ "pn_terminus_set_distribution_mode", "group__terminus.html#gaabb94d82847495c909aab24365d048c6", null ], [ "pn_terminus_get_durability", "group__terminus.html#gad9f06855cd6538f672c63836b8ef0ae5", null ], + [ "pn_terminus_set_durability", "group__terminus.html#gac5e15021927b18d0aa3fd712e4b0ac73", null ], [ "pn_terminus_get_expiry_policy", "group__terminus.html#ga0f9df2253065f81fd304f39a846e6468", null ], + [ "pn_terminus_set_expiry_policy", "group__terminus.html#gaaad123d27d82b2f7d051489a8bff73c6", null ], [ "pn_terminus_get_timeout", "group__terminus.html#ga62ba74b0c8fad5417a62cffe53996690", null ], - [ "pn_terminus_get_type", "group__terminus.html#ga2461341ae0d8c2261277837e6e20d2de", null ], + [ "pn_terminus_set_timeout", "group__terminus.html#ga8b6c30afc3aa73aac6fc30875fbc386d", null ], [ "pn_terminus_is_dynamic", "group__terminus.html#gaf9d4257ba00d3e0e0f8d983324018209", null ], - [ "pn_terminus_outcomes", "group__terminus.html#ga35d4ced3a1e9056c50adf3a6e051e0d8", null ], - [ "pn_terminus_properties", "group__terminus.html#gae9c9515f94353eb82cb421e46ce4bb24", null ], - [ "pn_terminus_set_address", "group__terminus.html#ga0603db45f03fcef0ef18f4f89ebf3de1", null ], - [ "pn_terminus_set_distribution_mode", "group__terminus.html#gaabb94d82847495c909aab24365d048c6", null ], - [ "pn_terminus_set_durability", "group__terminus.html#gac5e15021927b18d0aa3fd712e4b0ac73", null ], [ "pn_terminus_set_dynamic", "group__terminus.html#ga7779782e173db3efcd5de211e0f935ae", null ], - [ "pn_terminus_set_expiry_policy", "group__terminus.html#gaaad123d27d82b2f7d051489a8bff73c6", null ], - [ "pn_terminus_set_timeout", "group__terminus.html#ga8b6c30afc3aa73aac6fc30875fbc386d", null ], - [ "pn_terminus_set_type", "group__terminus.html#ga822fceb77515b691a10bf5381e4562ec", null ] + [ "pn_terminus_properties", "group__terminus.html#gae9c9515f94353eb82cb421e46ce4bb24", null ], + [ "pn_terminus_capabilities", "group__terminus.html#ga5cc480060f3fda737a333ac7a2ea0d70", null ], + [ "pn_terminus_outcomes", "group__terminus.html#ga35d4ced3a1e9056c50adf3a6e051e0d8", null ], + [ "pn_terminus_filter", "group__terminus.html#gafb9c4b3d344dd94ae174ecd8d25f503c", null ], + [ "pn_terminus_copy", "group__terminus.html#gaa1ad0b04b1625ac1ba5993b6679dcfcf", null ] ]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
