http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__message.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__message.html b/content/releases/qpid-dispatch-0.3/api/group__message.html deleted file mode 100644 index b859e27..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__message.html +++ /dev/null @@ -1,822 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<title>Qpid Dispatch Library API: Message</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="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/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__message.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#nested-classes">Classes</a> | -<a href="#typedef-members">Typedefs</a> | -<a href="#enum-members">Enumerations</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Message</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> -Classes</h2></td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structqd__message__t.html">qd_message_t</a></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> -Typedefs</h2></td></tr> -<tr class="memitem:gaf10da9283f1b958fdb364bc19e90c384"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structqd__message__t.html">qd_message_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gaf10da9283f1b958fdb364bc19e90c384">qd_message_t</a></td></tr> -<tr class="separator:gaf10da9283f1b958fdb364bc19e90c384"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> -Enumerations</h2></td></tr> -<tr class="memitem:ga166c435e09037d5221a38d78f0e5020a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga166c435e09037d5221a38d78f0e5020a">qd_message_depth_t</a> { <br/> -  <a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa1ab625d172750098870f403848bfb9fa">QD_DEPTH_NONE</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa031202a2a28bd87b75c7aa7f169ab3fe">QD_DEPTH_HEADER</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa24c1238121396ecf2c9ca74e156f71a8">QD_DEPTH_DELIVERY_ANNOTATIONS</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa9ee445cc976c271d797cf12767cbb2dd">QD_DEPTH_MESSAGE_ANNOTATIONS</a>, -<br/> -  <a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa58222da579b4443162d517b41730d7b1">QD_DEPTH_PROPERTIES</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa5ce317baaa124315a30845c8009f2f06">QD_DEPTH_APPLICATION_PROPERTIES</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa18c3ab9e6ebc0b4227c6df183bb5ac38">QD_DEPTH_BODY</a>, -<a class="el" href="group__message.html#gga166c435e09037d5221a38d78f0e5020aa0055c919662caea8ea974acb81a7fa33">QD_DEPTH_ALL</a> -<br/> - }</td></tr> -<tr class="separator:ga166c435e09037d5221a38d78f0e5020a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac27f162f7e0ff9b847ed727d9ba417ae"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> { <br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea254fdc65bea60bcafcf00fdd5d50d161">QD_FIELD_HEADER</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea0b00ec22155f5e848794622091607c61">QD_FIELD_DELIVERY_ANNOTATION</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabdc8a43f464a5ffb89bd02d6da52c9dd">QD_FIELD_MESSAGE_ANNOTATION</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabdb30c08831298a2c1f06b6b9ec0729b">QD_FIELD_PROPERTIES</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeae2c4983c9b1315d35637257f7934e1dc">QD_FIELD_APPLICATION_PROPERTIES</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9a5eadeb163e2a9ba6e6e12efcfd62e2">QD_FIELD_BODY</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea4b2f8241aa7e9be5a9a14692cdcbef0e">QD_FIELD_FOOTER</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea99ba075295d95b3fd7e8ded5ff29eaf2">QD_FIELD_DURABLE</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaa499dbd20955b6eb7a41f99caa7c3663">QD_FIELD_PRIORITY</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaf166a292e09e4cd68f977087306b42e7">QD_FIELD_TTL</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea5dddbb185948533b4deed308961d019b">QD_FIELD_FIRST_ACQUIRER</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeacff1a30871971ad51aa4ef82a3ae2e87">QD_FIELD_DELIVERY_COUNT</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea5aa1fe13d370d7f99f8872cf68a5e30a">QD_FIELD_MESSAGE_ID</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea308741405c1e3fd6af75f48eee94164f">QD_FIELD_USER_ID</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea976a90c9d7a0c339923d5e1025b3f97a">QD_FIELD_TO</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabb1a5bee6a000446c969df01b2a170ea">QD_FIELD_SUBJECT</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9e532d300613034c9128703b4f5d7e8b">QD_FIELD_REPLY_TO</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeafe5af512adfb2227ae4fdf79a52ede1e">QD_FIELD_CORRELATION_ID</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaefc2edd07fe5e6f75e55a858caa3a89c">QD_FIELD_CONTENT_TYPE</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea312d0041c3761e8ecff4bdd191947129">QD_FIELD_CONTENT_ENCODING</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aead13295d83937016e14deee0cb01afa4d">QD_FIELD_ABSOLUTE_EXPIRY_TIME</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeae1a8b6fa60aad20bc1a1a00167f4bd58">QD_FIELD_CREATION_TIME</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9a2f02f7ab51ee6b28408f4ac8ec11e4">QD_FIELD_GROUP_ID</a>, -<a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea94f90788812a608463b1fdc34d01d646">QD_FIELD_GROUP_SEQUENCE</a>, -<br/> -  <a class="el" href="group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea43e7a434549112ada6477f50b7251b5b">QD_FIELD_REPLY_TO_GROUP_ID</a> -<br/> - }</td></tr> -<tr class="separator:gac27f162f7e0ff9b847ed727d9ba417ae"><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:gab3ec9f3d20b652d8e52265023c1f43b0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gab3ec9f3d20b652d8e52265023c1f43b0">DEQ_DECLARE</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a>, qd_message_list_t)</td></tr> -<tr class="separator:gab3ec9f3d20b652d8e52265023c1f43b0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga195d99a2c830ab439214c4dfc69ae6d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structqd__message__t.html">qd_message_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga195d99a2c830ab439214c4dfc69ae6d4">qd_message</a> (void)</td></tr> -<tr class="separator:ga195d99a2c830ab439214c4dfc69ae6d4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga37cb6dce4bbacca1d00b9f410dc28265"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga37cb6dce4bbacca1d00b9f410dc28265">qd_message_free</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg)</td></tr> -<tr class="separator:ga37cb6dce4bbacca1d00b9f410dc28265"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga80cb50cf1c408458097f6da8738324f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structqd__message__t.html">qd_message_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga80cb50cf1c408458097f6da8738324f0">qd_message_copy</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg)</td></tr> -<tr class="separator:ga80cb50cf1c408458097f6da8738324f0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6c75cc558deec6b6074768ec9a36424e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="parse_8h.html#aecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga6c75cc558deec6b6074768ec9a36424e">qd_message_message_annotations</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg)</td></tr> -<tr class="separator:ga6c75cc558deec6b6074768ec9a36424e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6cd57e1345f04e3495f2132df77c9c50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga6cd57e1345f04e3495f2132df77c9c50">qd_message_set_message_annotations</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> *da)</td></tr> -<tr class="separator:ga6cd57e1345f04e3495f2132df77c9c50"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga18202afec8f50e308a4dcec36194962f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structqd__message__t.html">qd_message_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga18202afec8f50e308a4dcec36194962f">qd_message_receive</a> (<a class="el" href="group__container.html#ga42734cb017f1ba5af285ccb28df0cea6">qd_delivery_t</a> *delivery)</td></tr> -<tr class="separator:ga18202afec8f50e308a4dcec36194962f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gacc16aaa6449232d28d4bff5d11c483f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gacc16aaa6449232d28d4bff5d11c483f8">qd_message_send</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__container.html#ga082a4e64f813ba6e3a3587913e5905f2">qd_link_t</a> *link)</td></tr> -<tr class="separator:gacc16aaa6449232d28d4bff5d11c483f8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga94e69b6cbad79eb134f51f4a1e31735b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga94e69b6cbad79eb134f51f4a1e31735b">qd_message_check</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__message.html#ga166c435e09037d5221a38d78f0e5020a">qd_message_depth_t</a> depth)</td></tr> -<tr class="separator:ga94e69b6cbad79eb134f51f4a1e31735b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9213dc56edce6568cc4ab3e67cd5da3a"><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__message.html#ga9213dc56edce6568cc4ab3e67cd5da3a">qd_message_field_iterator_typed</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> field)</td></tr> -<tr class="separator:ga9213dc56edce6568cc4ab3e67cd5da3a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga3139c0a22806ffb43bcc7da4664f126d"><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__message.html#ga3139c0a22806ffb43bcc7da4664f126d">qd_message_field_iterator</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> field)</td></tr> -<tr class="separator:ga3139c0a22806ffb43bcc7da4664f126d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaeef101480b7dc051c724b043f2484f74"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gaeef101480b7dc051c724b043f2484f74">qd_message_field_length</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> field)</td></tr> -<tr class="separator:gaeef101480b7dc051c724b043f2484f74"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac187dd4c950acf0248441a6ffb9e08da"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gac187dd4c950acf0248441a6ffb9e08da">qd_message_field_copy</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> field, void *buffer, size_t *hdr_length)</td></tr> -<tr class="separator:gac187dd4c950acf0248441a6ffb9e08da"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaaa72aba0ea4070d1d63a3cb0663c1e68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gaaa72aba0ea4070d1d63a3cb0663c1e68">qd_message_compose_1</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, const char *to, qd_buffer_list_t *buffers)</td></tr> -<tr class="separator:gaaa72aba0ea4070d1d63a3cb0663c1e68"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gabd29f988387d796f98c0dd3f1c6dc9be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gabd29f988387d796f98c0dd3f1c6dc9be">qd_message_compose_2</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> *content)</td></tr> -<tr class="separator:gabd29f988387d796f98c0dd3f1c6dc9be"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4648ea575d9da5d557601ec26b193e14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga4648ea575d9da5d557601ec26b193e14">qd_message_compose_3</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, <a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> *content1, <a class="el" href="compose_8h.html#a5cba74773480056c26b3d4139fa5e0bf">qd_composed_field_t</a> *content2)</td></tr> -<tr class="separator:ga4648ea575d9da5d557601ec26b193e14"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gad9fd5d20dd04dc994f17fd5acbffe8c6"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gad9fd5d20dd04dc994f17fd5acbffe8c6">qd_message_repr</a> (<a class="el" href="structqd__message__t.html">qd_message_t</a> *msg, char *buffer, size_t len)</td></tr> -<tr class="separator:gad9fd5d20dd04dc994f17fd5acbffe8c6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga40a223be5234280ab2eba21e1a803af4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#ga40a223be5234280ab2eba21e1a803af4">qd_message_repr_len</a> ()</td></tr> -<tr class="separator:ga40a223be5234280ab2eba21e1a803af4"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Message representation. </p> -<h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="gaf10da9283f1b958fdb364bc19e90c384"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef struct <a class="el" href="structqd__message__t.html">qd_message_t</a> <a class="el" href="structqd__message__t.html">qd_message_t</a></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<h2 class="groupheader">Enumeration Type Documentation</h2> -<a class="anchor" id="ga166c435e09037d5221a38d78f0e5020a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="group__message.html#ga166c435e09037d5221a38d78f0e5020a">qd_message_depth_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa1ab625d172750098870f403848bfb9fa"></a>QD_DEPTH_NONE</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa031202a2a28bd87b75c7aa7f169ab3fe"></a>QD_DEPTH_HEADER</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa24c1238121396ecf2c9ca74e156f71a8"></a>QD_DEPTH_DELIVERY_ANNOTATIONS</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa9ee445cc976c271d797cf12767cbb2dd"></a>QD_DEPTH_MESSAGE_ANNOTATIONS</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa58222da579b4443162d517b41730d7b1"></a>QD_DEPTH_PROPERTIES</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa5ce317baaa124315a30845c8009f2f06"></a>QD_DEPTH_APPLICATION_PROPERTIES</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa18c3ab9e6ebc0b4227c6df183bb5ac38"></a>QD_DEPTH_BODY</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="gga166c435e09037d5221a38d78f0e5020aa0055c919662caea8ea974acb81a7fa33"></a>QD_DEPTH_ALL</em> </td><td class="fielddoc"> -</td></tr> -</table> - -</div> -</div> -<a class="anchor" id="gac27f162f7e0ff9b847ed727d9ba417ae"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a></td> - </tr> - </table> -</div><div class="memdoc"> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea254fdc65bea60bcafcf00fdd5d50d161"></a>QD_FIELD_HEADER</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea0b00ec22155f5e848794622091607c61"></a>QD_FIELD_DELIVERY_ANNOTATION</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeabdc8a43f464a5ffb89bd02d6da52c9dd"></a>QD_FIELD_MESSAGE_ANNOTATION</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeabdb30c08831298a2c1f06b6b9ec0729b"></a>QD_FIELD_PROPERTIES</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeae2c4983c9b1315d35637257f7934e1dc"></a>QD_FIELD_APPLICATION_PROPERTIES</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea9a5eadeb163e2a9ba6e6e12efcfd62e2"></a>QD_FIELD_BODY</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea4b2f8241aa7e9be5a9a14692cdcbef0e"></a>QD_FIELD_FOOTER</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea99ba075295d95b3fd7e8ded5ff29eaf2"></a>QD_FIELD_DURABLE</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeaa499dbd20955b6eb7a41f99caa7c3663"></a>QD_FIELD_PRIORITY</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeaf166a292e09e4cd68f977087306b42e7"></a>QD_FIELD_TTL</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea5dddbb185948533b4deed308961d019b"></a>QD_FIELD_FIRST_ACQUIRER</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeacff1a30871971ad51aa4ef82a3ae2e87"></a>QD_FIELD_DELIVERY_COUNT</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea5aa1fe13d370d7f99f8872cf68a5e30a"></a>QD_FIELD_MESSAGE_ID</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea308741405c1e3fd6af75f48eee94164f"></a>QD_FIELD_USER_ID</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea976a90c9d7a0c339923d5e1025b3f97a"></a>QD_FIELD_TO</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeabb1a5bee6a000446c969df01b2a170ea"></a>QD_FIELD_SUBJECT</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea9e532d300613034c9128703b4f5d7e8b"></a>QD_FIELD_REPLY_TO</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeafe5af512adfb2227ae4fdf79a52ede1e"></a>QD_FIELD_CORRELATION_ID</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeaefc2edd07fe5e6f75e55a858caa3a89c"></a>QD_FIELD_CONTENT_TYPE</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea312d0041c3761e8ecff4bdd191947129"></a>QD_FIELD_CONTENT_ENCODING</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aead13295d83937016e14deee0cb01afa4d"></a>QD_FIELD_ABSOLUTE_EXPIRY_TIME</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aeae1a8b6fa60aad20bc1a1a00167f4bd58"></a>QD_FIELD_CREATION_TIME</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea9a2f02f7ab51ee6b28408f4ac8ec11e4"></a>QD_FIELD_GROUP_ID</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea94f90788812a608463b1fdc34d01d646"></a>QD_FIELD_GROUP_SEQUENCE</em> </td><td class="fielddoc"> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="ggac27f162f7e0ff9b847ed727d9ba417aea43e7a434549112ada6477f50b7251b5b"></a>QD_FIELD_REPLY_TO_GROUP_ID</em> </td><td class="fielddoc"> -</td></tr> -</table> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gab3ec9f3d20b652d8e52265023c1f43b0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">DEQ_DECLARE </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structqd__message__t.html">qd_message_t</a> </td> - <td class="paramname">, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">qd_message_list_t </td> - <td class="paramname"> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="ga195d99a2c830ab439214c4dfc69ae6d4"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="structqd__message__t.html">qd_message_t</a>* qd_message </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Allocate a new message.</p> -<dl class="section return"><dt>Returns</dt><dd>A pointer to a <a class="el" href="structqd__message__t.html">qd_message_t</a> that is the sole reference to a newly allocated message. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga94e69b6cbad79eb134f51f4a1e31735b"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int qd_message_check </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__message.html#ga166c435e09037d5221a38d78f0e5020a">qd_message_depth_t</a> </td> - <td class="paramname"><em>depth</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Check that the message is well-formed up to a certain depth. Any part of the message that is beyond the specified depth is not checked for validity. </p> - -</div> -</div> -<a class="anchor" id="gaaa72aba0ea4070d1d63a3cb0663c1e68"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_compose_1 </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 class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>to</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">qd_buffer_list_t * </td> - <td class="paramname"><em>buffers</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="gabd29f988387d796f98c0dd3f1c6dc9be"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_compose_2 </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 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>content</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="ga4648ea575d9da5d557601ec26b193e14"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_compose_3 </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 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>content1</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>content2</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="ga80cb50cf1c408458097f6da8738324f0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="structqd__message__t.html">qd_message_t</a>* qd_message_copy </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Make a new reference to an existing message.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>A pointer to a <a class="el" href="structqd__message__t.html">qd_message_t</a> referencing a message. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A new pointer to the same referenced message. </dd></dl> - -</div> -</div> -<a class="anchor" id="gac187dd4c950acf0248441a6ffb9e08da"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">ssize_t qd_message_field_copy </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_field_t</a> </td> - <td class="paramname"><em>field</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>buffer</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t * </td> - <td class="paramname"><em>hdr_length</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="ga3139c0a22806ffb43bcc7da4664f126d"></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_message_field_iterator </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_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="ga9213dc56edce6568cc4ab3e67cd5da3a"></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_message_field_iterator_typed </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_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"> -<p>Return an iterator for the requested message field. If the field is not in the message, return NULL.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>A pointer to a message. </td></tr> - <tr><td class="paramname">field</td><td>The field to be returned via iterator. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A field iterator that spans the requested field. </dd></dl> - -</div> -</div> -<a class="anchor" id="gaeef101480b7dc051c724b043f2484f74"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">ssize_t qd_message_field_length </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae">qd_message_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="ga37cb6dce4bbacca1d00b9f410dc28265"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_free </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free a message reference. If this is the last reference to the message, free the message as well.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>A pointer to a <a class="el" href="structqd__message__t.html">qd_message_t</a> that is no longer needed. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga6c75cc558deec6b6074768ec9a36424e"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="parse_8h.html#aecb4d9935dfda6923193d2ce8bfc34f3">qd_parsed_field_t</a>* qd_message_message_annotations </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Retrieve the message annotations from a message.</p> -<p>IMPORTANT: The pointer returned by this function remains owned by the message. The caller MUST NOT free the parsed field.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>Pointer to a received message. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Pointer to the parsed field for the message annotations. If the message doesn't have message annotations, the return value shall be NULL. </dd></dl> - -</div> -</div> -<a class="anchor" id="ga18202afec8f50e308a4dcec36194962f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="structqd__message__t.html">qd_message_t</a>* qd_message_receive </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group__container.html#ga42734cb017f1ba5af285ccb28df0cea6">qd_delivery_t</a> * </td> - <td class="paramname"><em>delivery</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Receive message data via a delivery. This function may be called more than once on the same delivery if the message spans multiple frames. Once a complete message has been received, this function shall return the message.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">delivery</td><td>An incoming delivery from a link </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the complete message or 0 if the message is not yet complete. </dd></dl> - -</div> -</div> -<a class="anchor" id="gad9fd5d20dd04dc994f17fd5acbffe8c6"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">char* qd_message_repr </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 class="paramkey"></td> - <td></td> - <td class="paramtype">char * </td> - <td class="paramname"><em>buffer</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>len</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Put string representation of a message suitable for logging in buffer. </p> -<dl class="section return"><dt>Returns</dt><dd>buffer </dd></dl> - -</div> -</div> -<a class="anchor" id="ga40a223be5234280ab2eba21e1a803af4"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int qd_message_repr_len </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Recommended buffer length for qd_message_repr </p> - -</div> -</div> -<a class="anchor" id="gacc16aaa6449232d28d4bff5d11c483f8"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_send </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 class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="group__container.html#ga082a4e64f813ba6e3a3587913e5905f2">qd_link_t</a> * </td> - <td class="paramname"><em>link</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Send the message outbound on an outgoing link.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>A pointer to a message to be sent. </td></tr> - <tr><td class="paramname">link</td><td>The outgoing link on which to send the message. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga6cd57e1345f04e3495f2132df77c9c50"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_message_set_message_annotations </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 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>da</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the message annotations for the message. If the message already has message annotations, they will be overwritten/replaced by the new field.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">msg</td><td>Pointer to a receiver message. </td></tr> - <tr><td class="paramname">da</td><td>Pointer to a composed field representing the new message annotations of the message. If null, the message will not have a message annotations field. IMPORTANT: The message will not take ownership of the composed field. The caller is responsible for freeing it after this call. Since the contents are copied into the message, it is safe to free the composed field any time after the call to this function. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__message.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__message.js b/content/releases/qpid-dispatch-0.3/api/group__message.js deleted file mode 100644 index a35ac81..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__message.js +++ /dev/null @@ -1,62 +0,0 @@ -var group__message = -[ - [ "qd_message_t", "structqd__message__t.html", [ - [ "DEQ_LINKS", "structqd__message__t.html#a027092a77136ebd73712f54565da3a41", null ] - ] ], - [ "qd_message_t", "group__message.html#gaf10da9283f1b958fdb364bc19e90c384", null ], - [ "qd_message_depth_t", "group__message.html#ga166c435e09037d5221a38d78f0e5020a", [ - [ "QD_DEPTH_NONE", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa1ab625d172750098870f403848bfb9fa", null ], - [ "QD_DEPTH_HEADER", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa031202a2a28bd87b75c7aa7f169ab3fe", null ], - [ "QD_DEPTH_DELIVERY_ANNOTATIONS", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa24c1238121396ecf2c9ca74e156f71a8", null ], - [ "QD_DEPTH_MESSAGE_ANNOTATIONS", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa9ee445cc976c271d797cf12767cbb2dd", null ], - [ "QD_DEPTH_PROPERTIES", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa58222da579b4443162d517b41730d7b1", null ], - [ "QD_DEPTH_APPLICATION_PROPERTIES", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa5ce317baaa124315a30845c8009f2f06", null ], - [ "QD_DEPTH_BODY", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa18c3ab9e6ebc0b4227c6df183bb5ac38", null ], - [ "QD_DEPTH_ALL", "group__message.html#gga166c435e09037d5221a38d78f0e5020aa0055c919662caea8ea974acb81a7fa33", null ] - ] ], - [ "qd_message_field_t", "group__message.html#gac27f162f7e0ff9b847ed727d9ba417ae", [ - [ "QD_FIELD_HEADER", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea254fdc65bea60bcafcf00fdd5d50d161", null ], - [ "QD_FIELD_DELIVERY_ANNOTATION", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea0b00ec22155f5e848794622091607c61", null ], - [ "QD_FIELD_MESSAGE_ANNOTATION", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabdc8a43f464a5ffb89bd02d6da52c9dd", null ], - [ "QD_FIELD_PROPERTIES", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabdb30c08831298a2c1f06b6b9ec0729b", null ], - [ "QD_FIELD_APPLICATION_PROPERTIES", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeae2c4983c9b1315d35637257f7934e1dc", null ], - [ "QD_FIELD_BODY", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9a5eadeb163e2a9ba6e6e12efcfd62e2", null ], - [ "QD_FIELD_FOOTER", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea4b2f8241aa7e9be5a9a14692cdcbef0e", null ], - [ "QD_FIELD_DURABLE", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea99ba075295d95b3fd7e8ded5ff29eaf2", null ], - [ "QD_FIELD_PRIORITY", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaa499dbd20955b6eb7a41f99caa7c3663", null ], - [ "QD_FIELD_TTL", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaf166a292e09e4cd68f977087306b42e7", null ], - [ "QD_FIELD_FIRST_ACQUIRER", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea5dddbb185948533b4deed308961d019b", null ], - [ "QD_FIELD_DELIVERY_COUNT", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeacff1a30871971ad51aa4ef82a3ae2e87", null ], - [ "QD_FIELD_MESSAGE_ID", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea5aa1fe13d370d7f99f8872cf68a5e30a", null ], - [ "QD_FIELD_USER_ID", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea308741405c1e3fd6af75f48eee94164f", null ], - [ "QD_FIELD_TO", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea976a90c9d7a0c339923d5e1025b3f97a", null ], - [ "QD_FIELD_SUBJECT", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeabb1a5bee6a000446c969df01b2a170ea", null ], - [ "QD_FIELD_REPLY_TO", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9e532d300613034c9128703b4f5d7e8b", null ], - [ "QD_FIELD_CORRELATION_ID", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeafe5af512adfb2227ae4fdf79a52ede1e", null ], - [ "QD_FIELD_CONTENT_TYPE", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeaefc2edd07fe5e6f75e55a858caa3a89c", null ], - [ "QD_FIELD_CONTENT_ENCODING", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea312d0041c3761e8ecff4bdd191947129", null ], - [ "QD_FIELD_ABSOLUTE_EXPIRY_TIME", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aead13295d83937016e14deee0cb01afa4d", null ], - [ "QD_FIELD_CREATION_TIME", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aeae1a8b6fa60aad20bc1a1a00167f4bd58", null ], - [ "QD_FIELD_GROUP_ID", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea9a2f02f7ab51ee6b28408f4ac8ec11e4", null ], - [ "QD_FIELD_GROUP_SEQUENCE", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea94f90788812a608463b1fdc34d01d646", null ], - [ "QD_FIELD_REPLY_TO_GROUP_ID", "group__message.html#ggac27f162f7e0ff9b847ed727d9ba417aea43e7a434549112ada6477f50b7251b5b", null ] - ] ], - [ "DEQ_DECLARE", "group__message.html#gab3ec9f3d20b652d8e52265023c1f43b0", null ], - [ "qd_message", "group__message.html#ga195d99a2c830ab439214c4dfc69ae6d4", null ], - [ "qd_message_check", "group__message.html#ga94e69b6cbad79eb134f51f4a1e31735b", null ], - [ "qd_message_compose_1", "group__message.html#gaaa72aba0ea4070d1d63a3cb0663c1e68", null ], - [ "qd_message_compose_2", "group__message.html#gabd29f988387d796f98c0dd3f1c6dc9be", null ], - [ "qd_message_compose_3", "group__message.html#ga4648ea575d9da5d557601ec26b193e14", null ], - [ "qd_message_copy", "group__message.html#ga80cb50cf1c408458097f6da8738324f0", null ], - [ "qd_message_field_copy", "group__message.html#gac187dd4c950acf0248441a6ffb9e08da", null ], - [ "qd_message_field_iterator", "group__message.html#ga3139c0a22806ffb43bcc7da4664f126d", null ], - [ "qd_message_field_iterator_typed", "group__message.html#ga9213dc56edce6568cc4ab3e67cd5da3a", null ], - [ "qd_message_field_length", "group__message.html#gaeef101480b7dc051c724b043f2484f74", null ], - [ "qd_message_free", "group__message.html#ga37cb6dce4bbacca1d00b9f410dc28265", null ], - [ "qd_message_message_annotations", "group__message.html#ga6c75cc558deec6b6074768ec9a36424e", null ], - [ "qd_message_receive", "group__message.html#ga18202afec8f50e308a4dcec36194962f", null ], - [ "qd_message_repr", "group__message.html#gad9fd5d20dd04dc994f17fd5acbffe8c6", null ], - [ "qd_message_repr_len", "group__message.html#ga40a223be5234280ab2eba21e1a803af4", null ], - [ "qd_message_send", "group__message.html#gacc16aaa6449232d28d4bff5d11c483f8", null ], - [ "qd_message_set_message_annotations", "group__message.html#ga6cd57e1345f04e3495f2132df77c9c50", null ] -]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__parse.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__parse.html b/content/releases/qpid-dispatch-0.3/api/group__parse.html deleted file mode 100644 index a1aa064..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__parse.html +++ /dev/null @@ -1,106 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<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> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__parse.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="headertitle"> -<div class="title">Parse</div> </div> -</div><!--header--> -<div class="contents"> -<p>Parse data from qd_field_iterator_t into a tree structure represeniting an AMQP data type tree. </p> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__router.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__router.html b/content/releases/qpid-dispatch-0.3/api/group__router.html deleted file mode 100644 index 78d8c2e..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__router.html +++ /dev/null @@ -1,106 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<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> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__router.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="headertitle"> -<div class="title">Router</div> </div> -</div><!--header--> -<div class="contents"> -<p>Register addresses, send messages. </p> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server.html b/content/releases/qpid-dispatch-0.3/api/group__server.html deleted file mode 100644 index 4a17b26..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server.html +++ /dev/null @@ -1,318 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.6"/> -<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> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Qpid Dispatch Library API -  <span id="projectnumber">0.3</span> - </div> - </td> - <td> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group__server.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="summary"> -<a href="#typedef-members">Typedefs</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Server</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:ga9068697fea6e5f583169d10aedeece95"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga9068697fea6e5f583169d10aedeece95">qd_thread_start_cb_t</a> )(void *context, int thread_id)</td></tr> -<tr class="separator:ga9068697fea6e5f583169d10aedeece95"><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:gac624573ea1e1171323fe56773c8ddb6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#gac624573ea1e1171323fe56773c8ddb6d">qd_server_set_start_handler</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd, <a class="el" href="group__server.html#ga9068697fea6e5f583169d10aedeece95">qd_thread_start_cb_t</a> start_handler, void *context)</td></tr> -<tr class="separator:gac624573ea1e1171323fe56773c8ddb6d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1663cfc5a681f324fc5c31b6d9283b2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga1663cfc5a681f324fc5c31b6d9283b2c">qd_server_run</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> -<tr class="separator:ga1663cfc5a681f324fc5c31b6d9283b2c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga925c7e9eca6399bbfcf53e8db0adc063"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga925c7e9eca6399bbfcf53e8db0adc063">qd_server_start</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> -<tr class="separator:ga925c7e9eca6399bbfcf53e8db0adc063"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga70870292ce04e41f96f147614733b088"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga70870292ce04e41f96f147614733b088">qd_server_stop</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> -<tr class="separator:ga70870292ce04e41f96f147614733b088"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga7d10d6b50b0adb46b82f50aa98bc6295"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga7d10d6b50b0adb46b82f50aa98bc6295">qd_server_pause</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> -<tr class="separator:ga7d10d6b50b0adb46b82f50aa98bc6295"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga674f776fb34b1d15e667212dc29a0d92"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__server.html#ga674f776fb34b1d15e667212dc29a0d92">qd_server_resume</a> (<a class="el" href="group__dispatch.html#gaef7922e4eb6670388fd2d3e6d88297a9">qd_dispatch_t</a> *qd)</td></tr> -<tr class="separator:ga674f776fb34b1d15e667212dc29a0d92"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Control server threads, starting and stopping the server. </p> -<h2 class="groupheader">Typedef Documentation</h2> -<a class="anchor" id="ga9068697fea6e5f583169d10aedeece95"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">typedef void(* qd_thread_start_cb_t)(void *context, int thread_id)</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Thread Start Handler</p> -<p>Callback invoked when a new server thread is started. The callback is invoked on the newly created thread.</p> -<p>This handler can be used to set processor affinity or other thread-specific tuning values.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>The handler context supplied in qd_server_initialize. </td></tr> - <tr><td class="paramname">thread_id</td><td>The integer thread identifier that uniquely identifies this thread. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga7d10d6b50b0adb46b82f50aa98bc6295"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_pause </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Pause (quiesce) the server.</p> -<p>This call blocks until all of the worker threads (except the one calling this function) are finished processing and have been blocked. When this call returns, the calling thread is the only thread running in the process.</p> -<p>If the calling process is <em>not</em> one of the server's worker threads, then this function will block all of the worker threads before returning.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga674f776fb34b1d15e667212dc29a0d92"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_resume </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Resume normal operation of a paused server.</p> -<p>This call unblocks all of the worker threads so they can resume normal connection processing.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga1663cfc5a681f324fc5c31b6d9283b2c"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_run </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Run the server threads until completion - The blocking version.</p> -<p>Start the operation of the server, including launching all of the worker threads. This function does not return until after the server has been stopped. The thread that calls qd_server_run is used as one of the worker threads.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="gac624573ea1e1171323fe56773c8ddb6d"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_set_start_handler </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__server.html#ga9068697fea6e5f583169d10aedeece95">qd_thread_start_cb_t</a> </td> - <td class="paramname"><em>start_handler</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>Set the optional thread-start handler.</p> -<p>This handler is called once on each worker thread at the time the thread is started. This may be used to set tuning settings like processor affinity, etc.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - <tr><td class="paramname">start_handler</td><td>The thread-start handler invoked per thread on thread startup. </td></tr> - <tr><td class="paramname">context</td><td>Opaque context to be passed back in the callback function. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga925c7e9eca6399bbfcf53e8db0adc063"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_start </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Start the server threads and return immediately - The non-blocking version.</p> -<p>Start the operation of the server, including launching all of the worker threads.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="ga70870292ce04e41f96f147614733b088"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void qd_server_stop </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><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Stop the server</p> -<p>Stop the server and join all of its worker threads. This function may be called from any thread. When this function returns, all of the other server threads have been closed and joined. The calling thread will be the only running thread in the process.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">qd</td><td>The dispatch handle returned by qd_dispatch. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated by - <a href="http://www.doxygen.org/index.html";> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/fb1899b6/content/releases/qpid-dispatch-0.3/api/group__server.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-dispatch-0.3/api/group__server.js b/content/releases/qpid-dispatch-0.3/api/group__server.js deleted file mode 100644 index e62f9c2..0000000 --- a/content/releases/qpid-dispatch-0.3/api/group__server.js +++ /dev/null @@ -1,10 +0,0 @@ -var group__server = -[ - [ "qd_thread_start_cb_t", "group__server.html#ga9068697fea6e5f583169d10aedeece95", null ], - [ "qd_server_pause", "group__server.html#ga7d10d6b50b0adb46b82f50aa98bc6295", null ], - [ "qd_server_resume", "group__server.html#ga674f776fb34b1d15e667212dc29a0d92", null ], - [ "qd_server_run", "group__server.html#ga1663cfc5a681f324fc5c31b6d9283b2c", null ], - [ "qd_server_set_start_handler", "group__server.html#gac624573ea1e1171323fe56773c8ddb6d", null ], - [ "qd_server_start", "group__server.html#ga925c7e9eca6399bbfcf53e8db0adc063", null ], - [ "qd_server_stop", "group__server.html#ga70870292ce04e41f96f147614733b088", null ] -]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
