Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: Parse</title> +<title>Qpid Dispatch Library API: parse</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -87,11 +87,517 @@ $(document).ready(function(){initNavTree </div> <div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Parse</div> </div> +<div class="title">parse</div> </div> </div><!--header--> <div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:gaecb4d9935dfda6923193d2ce8bfc34f3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a></td></tr> +<tr class="separator:gaecb4d9935dfda6923193d2ce8bfc34f3"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gafe9bb8521824ff2a0f1643a92863abb0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gafe9bb8521824ff2a0f1643a92863abb0">qd_parse</a> (<a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a> *iter)</td></tr> +<tr class="separator:gafe9bb8521824ff2a0f1643a92863abb0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4fa67076550cc11c684fabefccd7143a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga4fa67076550cc11c684fabefccd7143a">qd_parse_free</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:ga4fa67076550cc11c684fabefccd7143a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa234807e27451a9fd9ec64f77c118d66"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gaa234807e27451a9fd9ec64f77c118d66">qd_parse_ok</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gaa234807e27451a9fd9ec64f77c118d66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa51872c37a7fbbbcb491bd6e10fdda2c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gaa51872c37a7fbbbcb491bd6e10fdda2c">qd_parse_error</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gaa51872c37a7fbbbcb491bd6e10fdda2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga94fbb662212932e50e0bf77f7959a379"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga94fbb662212932e50e0bf77f7959a379">qd_parse_tag</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:ga94fbb662212932e50e0bf77f7959a379"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga77f9aca9d39a90aa51c0eee909082dd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga77f9aca9d39a90aa51c0eee909082dd1">qd_parse_raw</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:ga77f9aca9d39a90aa51c0eee909082dd1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae2287d9be964fcc51db853d216dd6b48"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gae2287d9be964fcc51db853d216dd6b48">qd_parse_as_uint</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gae2287d9be964fcc51db853d216dd6b48"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab5f92e2d51e06847d7be8d75d523062c"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gab5f92e2d51e06847d7be8d75d523062c">qd_parse_as_ulong</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gab5f92e2d51e06847d7be8d75d523062c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacefeaf1dbd5161b2f0a4f2d876faba6c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gacefeaf1dbd5161b2f0a4f2d876faba6c">qd_parse_as_int</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gacefeaf1dbd5161b2f0a4f2d876faba6c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8e020571caa57ad69681a9d8e4802ad3"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga8e020571caa57ad69681a9d8e4802ad3">qd_parse_as_long</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:ga8e020571caa57ad69681a9d8e4802ad3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaed5e6bba6c4a65907d91eb8b2190bcc6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gaed5e6bba6c4a65907d91eb8b2190bcc6">qd_parse_sub_count</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gaed5e6bba6c4a65907d91eb8b2190bcc6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga82e84b452cd57a52980a99123da635f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga82e84b452cd57a52980a99123da635f5">qd_parse_sub_key</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field, uint32_t idx)</td></tr> +<tr class="separator:ga82e84b452cd57a52980a99123da635f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf4c64c166111dcb2bf16623dac00c038"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gaf4c64c166111dcb2bf16623dac00c038">qd_parse_sub_value</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field, uint32_t idx)</td></tr> +<tr class="separator:gaf4c64c166111dcb2bf16623dac00c038"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad011c95c6bd6eb60e5bbdab11a299c78"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gad011c95c6bd6eb60e5bbdab11a299c78">qd_parse_is_map</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gad011c95c6bd6eb60e5bbdab11a299c78"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac8e74ddb9758471ed84fee66afe0090a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#gac8e74ddb9758471ed84fee66afe0090a">qd_parse_is_list</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:gac8e74ddb9758471ed84fee66afe0090a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga795c120d686622d8dd42881d68ab4a74"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga795c120d686622d8dd42881d68ab4a74">qd_parse_is_scalar</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field)</td></tr> +<tr class="separator:ga795c120d686622d8dd42881d68ab4a74"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga105de7665fc1d7886d5df7d1f0cbe94d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parse.html#ga105de7665fc1d7886d5df7d1f0cbe94d">qd_parse_value_by_key</a> (<a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> *field, const char *key)</td></tr> +<tr class="separator:ga105de7665fc1d7886d5df7d1f0cbe94d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Parse data from qd_field_iterator_t into a tree structure represeniting an AMQP data type tree. </p> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="gaecb4d9935dfda6923193d2ce8bfc34f3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> <a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gafe9bb8521824ff2a0f1643a92863abb0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a>* qd_parse </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a> * </td> + <td class="paramname"><em>iter</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Parse a field delimited by a field iterator.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">iter</td><td>Field iterator for the field being parsed </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the newly created field. </dd></dl> + +</div> +</div> +<a class="anchor" id="gacefeaf1dbd5161b2f0a4f2d876faba6c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t qd_parse_as_int </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the raw content as a signed integer up to 32-bits. This is valid only for scalar fields of a fixed size of 4-octets or fewer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The raw content of the field cast as an int32_t. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8e020571caa57ad69681a9d8e4802ad3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int64_t qd_parse_as_long </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the raw content as a signed integer up to 64-bits. This is valid only for scalar fields of a fixed size of 8-octets or fewer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The raw content of the field cast as an int64_t. </dd></dl> + +</div> +</div> +<a class="anchor" id="gae2287d9be964fcc51db853d216dd6b48"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t qd_parse_as_uint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the raw content as an unsigned integer up to 32-bits. This is valid only for scalar fields of a fixed size of 4-octets or fewer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The raw content of the field cast as a uint32_t. </dd></dl> + +</div> +</div> +<a class="anchor" id="gab5f92e2d51e06847d7be8d75d523062c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint64_t qd_parse_as_ulong </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the raw content as an unsigned integer up to 64-bits. This is valid only for scalar fields of a fixed size of 8-octets or fewer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The raw content of the field cast as a uint64_t. </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa51872c37a7fbbbcb491bd6e10fdda2c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* qd_parse_error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the text of the error describing the parse error if the field is not well-formed.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a null-terminated string describing the parse failure. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga4fa67076550cc11c684fabefccd7143a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_parse_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Free the resources associated with a parsed field.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>A field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="gac8e74ddb9758471ed84fee66afe0090a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int qd_parse_is_list </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convenience Function - Return true iff the field is a list.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse[<em>sub</em>{value,key}] </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>non-zero if the condition is mat. </dd></dl> + +</div> +</div> +<a class="anchor" id="gad011c95c6bd6eb60e5bbdab11a299c78"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int qd_parse_is_map </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convenience Function - Return true iff the field is a map.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse[<em>sub</em>{value,key}] </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>non-zero if the condition is mat. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga795c120d686622d8dd42881d68ab4a74"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int qd_parse_is_scalar </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convenience Function - Return true iff the field is a scalar type.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse[<em>sub</em>{value,key}] </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>non-zero if the condition is mat. </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa234807e27451a9fd9ec64f77c118d66"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int qd_parse_ok </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Check to see if the field parse was successful (i.e. the field was well-formed).</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true iff the field was well-formed and successfully parsed. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga77f9aca9d39a90aa51c0eee909082dd1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a>* qd_parse_raw </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return an iterator for the raw content of the field. This is useful only for scalar fields. It is not appropriate for compound fields. For compound fields, use the sub-field functions instead.</p> +<p>The returned iterator describes the raw content of the field, and can be used for comparison, indexing, or copying.</p> +<p>IMPORTANT: The returned iterator is owned by the field and <em>must not</em> be freed by the caller of this function.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A field iterator that describes the field's raw content. </dd></dl> + +</div> +</div> +<a class="anchor" id="gaed5e6bba6c4a65907d91eb8b2190bcc6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t qd_parse_sub_count </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the number of sub-field in a compound field. If the field is a list or array, this is the number of items in the list/array. If the field is a map, this is the number of key/value pairs in the map (i.e. half the number of actual sub-field in the map).</p> +<p>For scalar fields, this function will return zero.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The number of sub-fields in the field. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga82e84b452cd57a52980a99123da635f5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a>* qd_parse_sub_key </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>idx</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return a qd_parsed_field_t for the idx'th key in a map field. If 'field' is not a map, or idx is equal-to or greater-than the number of sub-fields in field, this function will return NULL.</p> +<p>IMPORTANT: The pointer returned by this function remains owned by the parent field. It <em>must not</em> be freed by the caller.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + <tr><td class="paramname">idx</td><td>The index of the desired sub-field (in range 0..sub_count) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the parsed sub-field </dd></dl> + +</div> +</div> +<a class="anchor" id="gaf4c64c166111dcb2bf16623dac00c038"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a>* qd_parse_sub_value </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>idx</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return a qd_parsed_field_t for the idx'th value in a compound field. If idx is equal-to or greater-than the number of sub-fields in field, this function will return NULL.</p> +<p>IMPORTANT: The pointer returned by this function remains owned by the parent field. It <em>must not</em> be freed by the caller.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + <tr><td class="paramname">idx</td><td>The index of the desired sub-field (in range 0..sub_count) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the parsed sub-field </dd></dl> + +</div> +</div> +<a class="anchor" id="ga94fbb662212932e50e0bf77f7959a379"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint8_t qd_parse_tag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the AMQP tag for the parsed (and well-formed) field.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The tag (see <a class="el" href="amqp_8h.html">amqp.h</a>) that indicates the type of the field. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga105de7665fc1d7886d5df7d1f0cbe94d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a>* qd_parse_value_by_key </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td> + <td class="paramname"><em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>key</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convenience Function - Return the value for a key in a map.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">field</td><td>The field pointer returned by qd_parse[<em>sub</em>{value,key}] </td></tr> + <tr><td class="paramname">key</td><td>The key to search for in the map. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The value field corresponding to the key or NULL. </dd></dl> + +</div> +</div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part -->
Added: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.js URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.js?rev=1653654&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.js (added) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__parse.js Wed Jan 21 21:07:42 2015 @@ -0,0 +1,21 @@ +var group__parse = +[ + [ "qd_parsed_field_t", "group__parse.html#gaecb4d9935dfda6923193d2ce8bfc34f3", null ], + [ "qd_parse", "group__parse.html#gafe9bb8521824ff2a0f1643a92863abb0", null ], + [ "qd_parse_as_int", "group__parse.html#gacefeaf1dbd5161b2f0a4f2d876faba6c", null ], + [ "qd_parse_as_long", "group__parse.html#ga8e020571caa57ad69681a9d8e4802ad3", null ], + [ "qd_parse_as_uint", "group__parse.html#gae2287d9be964fcc51db853d216dd6b48", null ], + [ "qd_parse_as_ulong", "group__parse.html#gab5f92e2d51e06847d7be8d75d523062c", null ], + [ "qd_parse_error", "group__parse.html#gaa51872c37a7fbbbcb491bd6e10fdda2c", null ], + [ "qd_parse_free", "group__parse.html#ga4fa67076550cc11c684fabefccd7143a", null ], + [ "qd_parse_is_list", "group__parse.html#gac8e74ddb9758471ed84fee66afe0090a", null ], + [ "qd_parse_is_map", "group__parse.html#gad011c95c6bd6eb60e5bbdab11a299c78", null ], + [ "qd_parse_is_scalar", "group__parse.html#ga795c120d686622d8dd42881d68ab4a74", null ], + [ "qd_parse_ok", "group__parse.html#gaa234807e27451a9fd9ec64f77c118d66", null ], + [ "qd_parse_raw", "group__parse.html#ga77f9aca9d39a90aa51c0eee909082dd1", null ], + [ "qd_parse_sub_count", "group__parse.html#gaed5e6bba6c4a65907d91eb8b2190bcc6", null ], + [ "qd_parse_sub_key", "group__parse.html#ga82e84b452cd57a52980a99123da635f5", null ], + [ "qd_parse_sub_value", "group__parse.html#gaf4c64c166111dcb2bf16623dac00c038", null ], + [ "qd_parse_tag", "group__parse.html#ga94fbb662212932e50e0bf77f7959a379", null ], + [ "qd_parse_value_by_key", "group__parse.html#ga105de7665fc1d7886d5df7d1f0cbe94d", null ] +]; \ No newline at end of file Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: Router</title> +<title>Qpid Dispatch Library API: router</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -87,11 +87,702 @@ $(document).ready(function(){initNavTree </div> <div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Router</div> </div> +<div class="title">router</div> </div> </div><!--header--> <div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ga57e0efc22a83bf03f98cdd9c3cb1c06a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a></td></tr> +<tr class="separator:ga57e0efc22a83bf03f98cdd9c3cb1c06a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf2e78df04ea3d2f36a83f34a3463806f"><td class="memItemLeft" align="right" valign="top">typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gaf2e78df04ea3d2f36a83f34a3463806f">qd_address_semantics_t</a></td></tr> +<tr class="separator:gaf2e78df04ea3d2f36a83f34a3463806f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga40b73db46b35fc510c38be9361d56c98"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga40b73db46b35fc510c38be9361d56c98">qd_router_message_cb_t</a> )(void *context, <a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, int link_id)</td></tr> +<tr class="separator:ga40b73db46b35fc510c38be9361d56c98"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaf208ece99e5eefb7737bd574672cc658"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gaf208ece99e5eefb7737bd574672cc658">qd_router_id</a> (const <a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> +<tr class="separator:gaf208ece99e5eefb7737bd574672cc658"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga642629d363cf448edb48b7777ebe1f3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga642629d363cf448edb48b7777ebe1f3c">qd_router_register_address</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, const char *address, <a class="el" href="group__router.html#ga40b73db46b35fc510c38be9361d56c98">qd_router_message_cb_t</a> handler, <a class="el" href="group__router.html#gaf2e78df04ea3d2f36a83f34a3463806f">qd_address_semantics_t</a> semantics, bool global, void *context)</td></tr> +<tr class="separator:ga642629d363cf448edb48b7777ebe1f3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1947a8ce8e8ea812886e6fd2ed1000a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga1947a8ce8e8ea812886e6fd2ed1000a8">qd_router_unregister_address</a> (<a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *address)</td></tr> +<tr class="separator:ga1947a8ce8e8ea812886e6fd2ed1000a8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4668e11dd7cd30e9556680f33f81892d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga4668e11dd7cd30e9556680f33f81892d">qd_address_set_redirect</a> (<a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *address, <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *redirect)</td></tr> +<tr class="separator:ga4668e11dd7cd30e9556680f33f81892d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae7a3cbbf34b403b802a3b6901a4fca8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gae7a3cbbf34b403b802a3b6901a4fca8a">qd_address_set_static_cc</a> (<a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *address, <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *cc)</td></tr> +<tr class="separator:gae7a3cbbf34b403b802a3b6901a4fca8a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa1113bda895ae3b1d058f4c71f7702b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gaa1113bda895ae3b1d058f4c71f7702b0">qd_address_set_dynamic_cc</a> (<a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *address, <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *cc)</td></tr> +<tr class="separator:gaa1113bda895ae3b1d058f4c71f7702b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2f2a07f660820d889c49ad348676bf37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga2f2a07f660820d889c49ad348676bf37">qd_router_send</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a> *address, <a class="el" href="structqd__message__t.html">qd_message_t</a> *msg)</td></tr> +<tr class="separator:ga2f2a07f660820d889c49ad348676bf37"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab319ef8ac1bf439e6bb4f65db069fa98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gab319ef8ac1bf439e6bb4f65db069fa98">qd_router_send2</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, const char *address, <a class="el" href="structqd__message__t.html">qd_message_t</a> *msg)</td></tr> +<tr class="separator:gab319ef8ac1bf439e6bb4f65db069fa98"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7fa1c87ded14143a4310bf56e8cbfc86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga7fa1c87ded14143a4310bf56e8cbfc86">qd_router_build_node_list</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> *field)</td></tr> +<tr class="separator:ga7fa1c87ded14143a4310bf56e8cbfc86"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga730aaacfde80e76a6b4bd2a68738eaa4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga730aaacfde80e76a6b4bd2a68738eaa4">qd_address_logstr</a> (<a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> *address)</td></tr> +<tr class="separator:ga730aaacfde80e76a6b4bd2a68738eaa4"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> +Address fanout semantics</h2></td></tr> +<tr class="memitem:gad01c71a24146bc0d9cf77f0866a81aeb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gad01c71a24146bc0d9cf77f0866a81aeb">QD_FANOUTMASK</a>   0x03</td></tr> +<tr class="separator:gad01c71a24146bc0d9cf77f0866a81aeb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44ffba7152f928e6f545d46f9848243f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga44ffba7152f928e6f545d46f9848243f">QD_FANOUT_SINGLE</a>   0x00</td></tr> +<tr class="memdesc:ga44ffba7152f928e6f545d46f9848243f"><td class="mdescLeft"> </td><td class="mdescRight">Message will be delivered to a single consumer. <a href="#ga44ffba7152f928e6f545d46f9848243f">More...</a><br/></td></tr> +<tr class="separator:ga44ffba7152f928e6f545d46f9848243f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga495218744157bffbc39dd34a4f70e9d2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga495218744157bffbc39dd34a4f70e9d2">QD_FANOUT_MULTIPLE</a>   0x01</td></tr> +<tr class="memdesc:ga495218744157bffbc39dd34a4f70e9d2"><td class="mdescLeft"> </td><td class="mdescRight">Message will be delivered to multiple consumers. <a href="#ga495218744157bffbc39dd34a4f70e9d2">More...</a><br/></td></tr> +<tr class="separator:ga495218744157bffbc39dd34a4f70e9d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2da37cb8fbe718e4028226fbe6d37d5c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga2da37cb8fbe718e4028226fbe6d37d5c">QD_FANOUT_GROUP</a>   0x02</td></tr> +<tr class="memdesc:ga2da37cb8fbe718e4028226fbe6d37d5c"><td class="mdescLeft"> </td><td class="mdescRight">Message will be delivered to one consumer per group. <a href="#ga2da37cb8fbe718e4028226fbe6d37d5c">More...</a><br/></td></tr> +<tr class="separator:ga2da37cb8fbe718e4028226fbe6d37d5c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gace61a50dc47847c9da9efd2a09feca18"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gace61a50dc47847c9da9efd2a09feca18">QD_FANOUT</a>(d)   (d & <a class="el" href="group__router.html#gad01c71a24146bc0d9cf77f0866a81aeb">QD_FANOUTMASK</a>)</td></tr> +<tr class="separator:gace61a50dc47847c9da9efd2a09feca18"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> +Address bias semantics for SINGLE/GROUP fanout</h2></td></tr> +<tr class="memitem:ga70494c65d82d415c5d736ef61e48cb94"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga70494c65d82d415c5d736ef61e48cb94">QD_BIASMASK</a>   0x0c</td></tr> +<tr class="separator:ga70494c65d82d415c5d736ef61e48cb94"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6da59208075ed3d059dc537d97081ab9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga6da59208075ed3d059dc537d97081ab9">QD_BIAS_NONE</a>   0x00</td></tr> +<tr class="memdesc:ga6da59208075ed3d059dc537d97081ab9"><td class="mdescLeft"> </td><td class="mdescRight">Apply no bias (also used for multiple fanout). <a href="#ga6da59208075ed3d059dc537d97081ab9">More...</a><br/></td></tr> +<tr class="separator:ga6da59208075ed3d059dc537d97081ab9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga24df81192da647f9f34cf2a83f7d0d9f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga24df81192da647f9f34cf2a83f7d0d9f">QD_BIAS_CLOSEST</a>   0x04</td></tr> +<tr class="memdesc:ga24df81192da647f9f34cf2a83f7d0d9f"><td class="mdescLeft"> </td><td class="mdescRight">Message will be delivered to the closest (lowest cost) consumer. <a href="#ga24df81192da647f9f34cf2a83f7d0d9f">More...</a><br/></td></tr> +<tr class="separator:ga24df81192da647f9f34cf2a83f7d0d9f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0fa2942e81777b1c3c363689cd6c67a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga0fa2942e81777b1c3c363689cd6c67a4">QD_BIAS_SPREAD</a>   0x08</td></tr> +<tr class="memdesc:ga0fa2942e81777b1c3c363689cd6c67a4"><td class="mdescLeft"> </td><td class="mdescRight">Messages will be spread arbitrarily across all consumers. <a href="#ga0fa2942e81777b1c3c363689cd6c67a4">More...</a><br/></td></tr> +<tr class="separator:ga0fa2942e81777b1c3c363689cd6c67a4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3ac01c5a0091321f8804aa000e39b75d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga3ac01c5a0091321f8804aa000e39b75d">QD_BIAS_LATENCY</a>   0x0c</td></tr> +<tr class="memdesc:ga3ac01c5a0091321f8804aa000e39b75d"><td class="mdescLeft"> </td><td class="mdescRight">Messages will be spread to minimize latency in light of each consumer's rate of consumption. <a href="#ga3ac01c5a0091321f8804aa000e39b75d">More...</a><br/></td></tr> +<tr class="separator:ga3ac01c5a0091321f8804aa000e39b75d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga79d218f0a28f347daddf4a41da87edaa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga79d218f0a28f347daddf4a41da87edaa">QD_BIAS</a>(d)   (d & <a class="el" href="group__router.html#ga70494c65d82d415c5d736ef61e48cb94">QD_BIASMASK</a>)</td></tr> +<tr class="separator:ga79d218f0a28f347daddf4a41da87edaa"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> +Address congestion semantics.</h2></td></tr> +<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp1309cc996f9dfb3056e86f75a947fdd5"></a>This controls that the router will do with received messages that are destined for congested destinations. </p> +</td></tr> +<tr class="memitem:gaeaad43b784be3d98b7679e91ec6cabde"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gaeaad43b784be3d98b7679e91ec6cabde">QD_CONGESTIONMASK</a>   0x30</td></tr> +<tr class="separator:gaeaad43b784be3d98b7679e91ec6cabde"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga23cbb544dffcaa54491f4d244e4ae7a3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3">QD_CONGESTION_DROP</a>   0x00</td></tr> +<tr class="separator:ga23cbb544dffcaa54491f4d244e4ae7a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa90aaebffddecfd09e48c3c7463e295a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gaa90aaebffddecfd09e48c3c7463e295a">QD_CONGESTION_BACKPRESSURE</a>   0x10</td></tr> +<tr class="separator:gaa90aaebffddecfd09e48c3c7463e295a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga159e4bb2c788a3711022fc0e6f61a4c5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga159e4bb2c788a3711022fc0e6f61a4c5">QD_CONGESTION_REDIRECT</a>   0x20</td></tr> +<tr class="separator:ga159e4bb2c788a3711022fc0e6f61a4c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga733bd4ceab8c801bde29f6194532cf8c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga733bd4ceab8c801bde29f6194532cf8c">QD_CONGESTION</a>(d)   (d & <a class="el" href="group__router.html#gaeaad43b784be3d98b7679e91ec6cabde">QD_CONGESTIONMASK</a>)</td></tr> +<tr class="separator:ga733bd4ceab8c801bde29f6194532cf8c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> +Other semantics</h2></td></tr> +<tr class="memitem:gac8741b4708ad60b578b009366eaeb4ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#gac8741b4708ad60b578b009366eaeb4ec">QD_DROP_FOR_SLOW_CONSUMERS</a>   0x40</td></tr> +<tr class="separator:gac8741b4708ad60b578b009366eaeb4ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga561d9bdc1b4b81310956dc1fedda1cf0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga561d9bdc1b4b81310956dc1fedda1cf0">QD_BYPASS_VALID_ORIGINS</a>   0x80</td></tr> +<tr class="separator:ga561d9bdc1b4b81310956dc1fedda1cf0"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a> +Sematics groups</h2></td></tr> +<tr class="memitem:ga84c325241aaada359ac15b367c4cd0cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga84c325241aaada359ac15b367c4cd0cb">QD_SEMANTICS_ROUTER_CONTROL</a>   (<a class="el" href="group__router.html#ga495218744157bffbc39dd34a4f70e9d2">QD_FANOUT_MULTIPLE</a> | <a class="el" href="group__router.html#ga6da59208075ed3d059dc537d97081ab9">QD_BIAS_NONE</a> | <a class="el" href="group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3">QD_CONGESTION_DROP</a> | <a class="el" href="group__router.html#gac8741b4708ad60b578b009366eaeb4ec">QD_DROP_FOR_SLOW_CONSUMERS</a> | <a class="el" href="group__router.html#ga561d9bdc1b4b81310956dc1fedda1cf0">QD_BYPASS_VALID_ORIGINS</a>)</td></tr> +<tr class="separator:ga84c325241aaada359ac15b367c4cd0cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga040d5aaf1d77e948df7f3b7d338dbfb8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__router.html#ga040d5aaf1d77e948df7f3b7d338dbfb8">QD_SEMANTICS_DEFAULT</a>   (<a class="el" href="group__router.html#ga495218744157bffbc39dd34a4f70e9d2">QD_FANOUT_MULTIPLE</a> | <a class="el" href="group__router.html#ga6da59208075ed3d059dc537d97081ab9">QD_BIAS_NONE</a> | <a class="el" href="group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3">QD_CONGESTION_DROP</a> | <a class="el" href="group__router.html#gac8741b4708ad60b578b009366eaeb4ec">QD_DROP_FOR_SLOW_CONSUMERS</a>)</td></tr> +<tr class="separator:ga040d5aaf1d77e948df7f3b7d338dbfb8"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Register addresses, send messages. </p> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="ga79d218f0a28f347daddf4a41da87edaa"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIAS</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">d</td><td>)</td> + <td>   (d & <a class="el" href="group__router.html#ga70494c65d82d415c5d736ef61e48cb94">QD_BIASMASK</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga24df81192da647f9f34cf2a83f7d0d9f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIAS_CLOSEST   0x04</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Message will be delivered to the closest (lowest cost) consumer. </p> + +</div> +</div> +<a class="anchor" id="ga3ac01c5a0091321f8804aa000e39b75d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIAS_LATENCY   0x0c</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Messages will be spread to minimize latency in light of each consumer's rate of consumption. </p> + +</div> +</div> +<a class="anchor" id="ga6da59208075ed3d059dc537d97081ab9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIAS_NONE   0x00</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Apply no bias (also used for multiple fanout). </p> + +</div> +</div> +<a class="anchor" id="ga0fa2942e81777b1c3c363689cd6c67a4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIAS_SPREAD   0x08</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Messages will be spread arbitrarily across all consumers. </p> + +</div> +</div> +<a class="anchor" id="ga70494c65d82d415c5d736ef61e48cb94"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BIASMASK   0x0c</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga561d9bdc1b4b81310956dc1fedda1cf0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_BYPASS_VALID_ORIGINS   0x80</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga733bd4ceab8c801bde29f6194532cf8c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_CONGESTION</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">d</td><td>)</td> + <td>   (d & <a class="el" href="group__router.html#gaeaad43b784be3d98b7679e91ec6cabde">QD_CONGESTIONMASK</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="gaa90aaebffddecfd09e48c3c7463e295a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_CONGESTION_BACKPRESSURE   0x10</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Stop issuing replacement credits to slow the producer. This puts a cap on the total number of messages addressed to this address from a particular producer that can be buffered in the router. </p> + +</div> +</div> +<a class="anchor" id="ga23cbb544dffcaa54491f4d244e4ae7a3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_CONGESTION_DROP   0x00</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Drop/Release the message. </p> + +</div> +</div> +<a class="anchor" id="ga159e4bb2c788a3711022fc0e6f61a4c5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_CONGESTION_REDIRECT   0x20</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Redirect messages to an alternate address. </p> + +</div> +</div> +<a class="anchor" id="gaeaad43b784be3d98b7679e91ec6cabde"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_CONGESTIONMASK   0x30</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="gac8741b4708ad60b578b009366eaeb4ec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_DROP_FOR_SLOW_CONSUMERS   0x40</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="gace61a50dc47847c9da9efd2a09feca18"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_FANOUT</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">d</td><td>)</td> + <td>   (d & <a class="el" href="group__router.html#gad01c71a24146bc0d9cf77f0866a81aeb">QD_FANOUTMASK</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get fanout bits. </p> + +</div> +</div> +<a class="anchor" id="ga2da37cb8fbe718e4028226fbe6d37d5c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_FANOUT_GROUP   0x02</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Message will be delivered to one consumer per group. </p> + +</div> +</div> +<a class="anchor" id="ga495218744157bffbc39dd34a4f70e9d2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_FANOUT_MULTIPLE   0x01</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Message will be delivered to multiple consumers. </p> + +</div> +</div> +<a class="anchor" id="ga44ffba7152f928e6f545d46f9848243f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_FANOUT_SINGLE   0x00</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Message will be delivered to a single consumer. </p> + +</div> +</div> +<a class="anchor" id="gad01c71a24146bc0d9cf77f0866a81aeb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_FANOUTMASK   0x03</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga040d5aaf1d77e948df7f3b7d338dbfb8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_SEMANTICS_DEFAULT   (<a class="el" href="group__router.html#ga495218744157bffbc39dd34a4f70e9d2">QD_FANOUT_MULTIPLE</a> | <a class="el" href="group__router.html#ga6da59208075ed3d059dc537d97081ab9">QD_BIAS_NONE</a> | <a class="el" href="group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3">QD_CONGESTION_DROP</a> | <a class="el" href="group__router.html#gac8741b4708ad60b578b009366eaeb4ec">QD_DROP_FOR_SLOW_CONSUMERS</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga84c325241aaada359ac15b367c4cd0cb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define QD_SEMANTICS_ROUTER_CONTROL   (<a class="el" href="group__router.html#ga495218744157bffbc39dd34a4f70e9d2">QD_FANOUT_MULTIPLE</a> | <a class="el" href="group__router.html#ga6da59208075ed3d059dc537d97081ab9">QD_BIAS_NONE</a> | <a class="el" href="group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3">QD_CONGESTION_DROP</a> | <a class="el" href="group__router.html#gac8741b4708ad60b578b009366eaeb4ec">QD_DROP_FOR_SLOW_CONSUMERS</a> | <a class="el" href="group__router.html#ga561d9bdc1b4b81310956dc1fedda1cf0">QD_BYPASS_VALID_ORIGINS</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="gaf2e78df04ea3d2f36a83f34a3463806f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef uint8_t <a class="el" href="group__router.html#gaf2e78df04ea3d2f36a83f34a3463806f">qd_address_semantics_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga57e0efc22a83bf03f98cdd9c3cb1c06a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> <a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga40b73db46b35fc510c38be9361d56c98"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* qd_router_message_cb_t)(void *context, <a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, int link_id)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga730aaacfde80e76a6b4bd2a68738eaa4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* qd_address_logstr </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>address</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>String form of address for logging </p> + +</div> +</div> +<a class="anchor" id="gaa1113bda895ae3b1d058f4c71f7702b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_address_set_dynamic_cc </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>cc</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga4668e11dd7cd30e9556680f33f81892d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_address_set_redirect </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>redirect</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="gae7a3cbbf34b403b802a3b6901a4fca8a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_address_set_static_cc </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>cc</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga7fa1c87ded14143a4310bf56e8cbfc86"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_router_build_node_list </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> + <td class="paramname"><em>qd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> * </td> + <td class="paramname"><em>field</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="gaf208ece99e5eefb7737bd574672cc658"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* qd_router_id </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> + <td class="paramname"><em>qd</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ga642629d363cf448edb48b7777ebe1f3c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a>* qd_router_register_address </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> + <td class="paramname"><em>qd</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="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__router.html#ga40b73db46b35fc510c38be9361d56c98">qd_router_message_cb_t</a> </td> + <td class="paramname"><em>handler</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__router.html#gaf2e78df04ea3d2f36a83f34a3463806f">qd_address_semantics_t</a> </td> + <td class="paramname"><em>semantics</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>global</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Register an address in the router's hash table. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">qd</td><td>Pointer to the dispatch instance. </td></tr> + <tr><td class="paramname">address</td><td>String form of address </td></tr> + <tr><td class="paramname">handler</td><td>Callback to be called when a message is received for the address. </td></tr> + <tr><td class="paramname">semantics</td><td>Semantics for the address. </td></tr> + <tr><td class="paramname">global</td><td>True if the address is global. </td></tr> + <tr><td class="paramname">context</td><td>Context to be passed to the handler. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga2f2a07f660820d889c49ad348676bf37"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_router_send </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> + <td class="paramname"><em>qd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a> * </td> + <td class="paramname"><em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structqd__message__t.html">qd_message_t</a> * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Send msg to local links and next-hops for address </p> + +</div> +</div> +<a class="anchor" id="gab319ef8ac1bf439e6bb4f65db069fa98"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_router_send2 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> * </td> + <td class="paramname"><em>qd</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="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structqd__message__t.html">qd_message_t</a> * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Send msg to local links and next-hops for address </p> + +</div> +</div> +<a class="anchor" id="ga1947a8ce8e8ea812886e6fd2ed1000a8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void qd_router_unregister_address </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a">qd_address_t</a> * </td> + <td class="paramname"><em>address</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> Added: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.js URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.js?rev=1653654&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.js (added) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__router.js Wed Jan 21 21:07:42 2015 @@ -0,0 +1,36 @@ +var group__router = +[ + [ "QD_BIAS", "group__router.html#ga79d218f0a28f347daddf4a41da87edaa", null ], + [ "QD_BIAS_CLOSEST", "group__router.html#ga24df81192da647f9f34cf2a83f7d0d9f", null ], + [ "QD_BIAS_LATENCY", "group__router.html#ga3ac01c5a0091321f8804aa000e39b75d", null ], + [ "QD_BIAS_NONE", "group__router.html#ga6da59208075ed3d059dc537d97081ab9", null ], + [ "QD_BIAS_SPREAD", "group__router.html#ga0fa2942e81777b1c3c363689cd6c67a4", null ], + [ "QD_BIASMASK", "group__router.html#ga70494c65d82d415c5d736ef61e48cb94", null ], + [ "QD_BYPASS_VALID_ORIGINS", "group__router.html#ga561d9bdc1b4b81310956dc1fedda1cf0", null ], + [ "QD_CONGESTION", "group__router.html#ga733bd4ceab8c801bde29f6194532cf8c", null ], + [ "QD_CONGESTION_BACKPRESSURE", "group__router.html#gaa90aaebffddecfd09e48c3c7463e295a", null ], + [ "QD_CONGESTION_DROP", "group__router.html#ga23cbb544dffcaa54491f4d244e4ae7a3", null ], + [ "QD_CONGESTION_REDIRECT", "group__router.html#ga159e4bb2c788a3711022fc0e6f61a4c5", null ], + [ "QD_CONGESTIONMASK", "group__router.html#gaeaad43b784be3d98b7679e91ec6cabde", null ], + [ "QD_DROP_FOR_SLOW_CONSUMERS", "group__router.html#gac8741b4708ad60b578b009366eaeb4ec", null ], + [ "QD_FANOUT", "group__router.html#gace61a50dc47847c9da9efd2a09feca18", null ], + [ "QD_FANOUT_GROUP", "group__router.html#ga2da37cb8fbe718e4028226fbe6d37d5c", null ], + [ "QD_FANOUT_MULTIPLE", "group__router.html#ga495218744157bffbc39dd34a4f70e9d2", null ], + [ "QD_FANOUT_SINGLE", "group__router.html#ga44ffba7152f928e6f545d46f9848243f", null ], + [ "QD_FANOUTMASK", "group__router.html#gad01c71a24146bc0d9cf77f0866a81aeb", null ], + [ "QD_SEMANTICS_DEFAULT", "group__router.html#ga040d5aaf1d77e948df7f3b7d338dbfb8", null ], + [ "QD_SEMANTICS_ROUTER_CONTROL", "group__router.html#ga84c325241aaada359ac15b367c4cd0cb", null ], + [ "qd_address_semantics_t", "group__router.html#gaf2e78df04ea3d2f36a83f34a3463806f", null ], + [ "qd_address_t", "group__router.html#ga57e0efc22a83bf03f98cdd9c3cb1c06a", null ], + [ "qd_router_message_cb_t", "group__router.html#ga40b73db46b35fc510c38be9361d56c98", null ], + [ "qd_address_logstr", "group__router.html#ga730aaacfde80e76a6b4bd2a68738eaa4", null ], + [ "qd_address_set_dynamic_cc", "group__router.html#gaa1113bda895ae3b1d058f4c71f7702b0", null ], + [ "qd_address_set_redirect", "group__router.html#ga4668e11dd7cd30e9556680f33f81892d", null ], + [ "qd_address_set_static_cc", "group__router.html#gae7a3cbbf34b403b802a3b6901a4fca8a", null ], + [ "qd_router_build_node_list", "group__router.html#ga7fa1c87ded14143a4310bf56e8cbfc86", null ], + [ "qd_router_id", "group__router.html#gaf208ece99e5eefb7737bd574672cc658", null ], + [ "qd_router_register_address", "group__router.html#ga642629d363cf448edb48b7777ebe1f3c", null ], + [ "qd_router_send", "group__router.html#ga2f2a07f660820d889c49ad348676bf37", null ], + [ "qd_router_send2", "group__router.html#gab319ef8ac1bf439e6bb4f65db069fa98", null ], + [ "qd_router_unregister_address", "group__router.html#ga1947a8ce8e8ea812886e6fd2ed1000a8", null ] +]; \ No newline at end of file Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: Server</title> +<title>Qpid Dispatch Library API: server</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Server</div> </div> +<div class="title">server</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server__signal.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server__signal.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server__signal.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__server__signal.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: Server Signal</title> +<title>Qpid Dispatch Library API: server_signal</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Server Signal</div> </div> +<div class="title">server_signal</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__timer.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__timer.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__timer.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__timer.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: Timer</title> +<title>Qpid Dispatch Library API: timer</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Timer</div> </div> +<div class="title">timer</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> @@ -181,6 +181,7 @@ Functions</h2></td></tr> <p>Create a new timer object.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> + <tr><td class="paramname">qd</td><td>Pointer to the dispatch instance. </td></tr> <tr><td class="paramname">cb</td><td>The callback function to be invoked when the timer expires. </td></tr> <tr><td class="paramname">context</td><td>An opaque, user-supplied context to be passed into the callback. </td></tr> </table> Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__user__fd.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__user__fd.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__user__fd.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__user__fd.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ <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.6"/> -<title>Qpid Dispatch Library API: User FD</title> +<title>Qpid Dispatch Library API: user_fd</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">User FD</div> </div> +<div class="title">user_fd</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> @@ -216,6 +216,7 @@ Functions</h2></td></tr> <p>A user-fd is appropriate for use when the application opens and manages file descriptors for purposes other than AMQP communication. Registering a user fd with the dispatch server controls processing of the FD alongside the FDs used for messaging.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> + <tr><td class="paramname">qd</td><td>Pointer to the dispatch instance. </td></tr> <tr><td class="paramname">fd</td><td>The open file descriptor being managed by the application. </td></tr> <tr><td class="paramname">context</td><td>User context passed back in the connection handler. </td></tr> </table> Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/hash_8h_source.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/hash_8h_source.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/hash_8h_source.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/hash_8h_source.html Wed Jan 21 21:07:42 2015 @@ -140,7 +140,7 @@ $(document).ready(function(){initNavTree <div class="ttc" id="error_8h_html_a2b2570938d294123a4ee4f237cafce03"><div class="ttname"><a href="error_8h.html#a2b2570938d294123a4ee4f237cafce03">qd_error_t</a></div><div class="ttdeci">qd_error_t</div><div class="ttdef"><b>Definition:</b> error.h:39</div></div> <div class="ttc" id="hash_8h_html_a43292c0293d8535a72baf5128bd6f4b0"><div class="ttname"><a href="hash_8h.html#a43292c0293d8535a72baf5128bd6f4b0">qd_hash_remove_by_handle</a></div><div class="ttdeci">qd_error_t qd_hash_remove_by_handle(qd_hash_t *h, qd_hash_handle_t *handle)</div></div> <div class="ttc" id="hash_8h_html_a67c799caf6646e3dbd38118cf6766b49"><div class="ttname"><a href="hash_8h.html#a67c799caf6646e3dbd38118cf6766b49">qd_hash_handle_t</a></div><div class="ttdeci">struct qd_hash_handle_t qd_hash_handle_t</div><div class="ttdef"><b>Definition:</b> hash.h:31</div></div> -<div class="ttc" id="group__iterator_html_gaf8ba7602a7db1784a595eabf47a42fcd"><div class="ttname"><a href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a></div><div class="ttdeci">struct qd_field_iterator_t qd_field_iterator_t</div><div class="ttdef"><b>Definition:</b> iterator.h:38</div></div> +<div class="ttc" id="group__iterator_html_gaf8ba7602a7db1784a595eabf47a42fcd"><div class="ttname"><a href="group__iterator.html#gaf8ba7602a7db1784a595eabf47a42fcd">qd_field_iterator_t</a></div><div class="ttdeci">struct qd_field_iterator_t qd_field_iterator_t</div><div class="ttdef"><b>Definition:</b> iterator.h:40</div></div> <div class="ttc" id="hash_8h_html_ada24b9fbafa3ec1d4329ef03e3f1052c"><div class="ttname"><a href="hash_8h.html#ada24b9fbafa3ec1d4329ef03e3f1052c">qd_hash_handle_free</a></div><div class="ttdeci">void qd_hash_handle_free(qd_hash_handle_t *handle)</div></div> <div class="ttc" id="hash_8h_html_ab05db798588236f14effdcff2ac287fa"><div class="ttname"><a href="hash_8h.html#ab05db798588236f14effdcff2ac287fa">qd_hash_retrieve_const</a></div><div class="ttdeci">qd_error_t qd_hash_retrieve_const(qd_hash_t *h, qd_field_iterator_t *key, const void **val)</div></div> <div class="ttc" id="error_8h_html"><div class="ttname"><a href="error_8h.html">error.h</a></div></div> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
