http://git-wip-us.apache.org/repos/asf/qpid-site/blob/1859e58c/content/releases/qpid-proton-0.17.0/proton/c/api/group__delivery.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.17.0/proton/c/api/group__delivery.html b/content/releases/qpid-proton-0.17.0/proton/c/api/group__delivery.html new file mode 100755 index 0000000..1eadda1 --- /dev/null +++ b/content/releases/qpid-proton-0.17.0/proton/c/api/group__delivery.html @@ -0,0 +1,1430 @@ +<!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.3.1"/> +<title>Qpid Proton C API: Delivery</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 Proton C API +  <span id="projectnumber">0.17.0</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.3.1 --> +<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__delivery.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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Delivery<div class="ingroups"><a class="el" href="group__core.html">Core</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>A message transfer. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gaae349c977b37b584aa62fff6515802ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaae349c977b37b584aa62fff6515802ca"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gaae349c977b37b584aa62fff6515802ca">PN_RECEIVED</a></td></tr> +<tr class="memdesc:gaae349c977b37b584aa62fff6515802ca"><td class="mdescLeft"> </td><td class="mdescRight">The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has been received for a delivery. <br/></td></tr> +<tr class="separator:gaae349c977b37b584aa62fff6515802ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac64952b813a707586c6b3898e09552e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gac64952b813a707586c6b3898e09552e4">PN_ACCEPTED</a></td></tr> +<tr class="memdesc:gac64952b813a707586c6b3898e09552e4"><td class="mdescLeft"> </td><td class="mdescRight">The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed. <a href="#gac64952b813a707586c6b3898e09552e4">More...</a><br/></td></tr> +<tr class="separator:gac64952b813a707586c6b3898e09552e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga44a2635392fe2e6f8869a7e1cd64db2f">PN_REJECTED</a></td></tr> +<tr class="memdesc:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="mdescLeft"> </td><td class="mdescRight">The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition. <a href="#ga44a2635392fe2e6f8869a7e1cd64db2f">More...</a><br/></td></tr> +<tr class="separator:ga44a2635392fe2e6f8869a7e1cd64db2f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga628179c16c4a5f5fd7734bc1bfc6edc3">PN_RELEASED</a></td></tr> +<tr class="memdesc:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="mdescLeft"> </td><td class="mdescRight">The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender. <a href="#ga628179c16c4a5f5fd7734bc1bfc6edc3">More...</a><br/></td></tr> +<tr class="separator:ga628179c16c4a5f5fd7734bc1bfc6edc3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga247e3d1ac7c9096cdd28424353582962"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga247e3d1ac7c9096cdd28424353582962">PN_MODIFIED</a></td></tr> +<tr class="memdesc:ga247e3d1ac7c9096cdd28424353582962"><td class="mdescLeft"> </td><td class="mdescRight">The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to the sender and should be annotated by the sender prior to further delivery attempts. <a href="#ga247e3d1ac7c9096cdd28424353582962">More...</a><br/></td></tr> +<tr class="separator:ga247e3d1ac7c9096cdd28424353582962"><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:ga085159cb4136f84a02777bcc72c73fa3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga085159cb4136f84a02777bcc72c73fa3"></a> +typedef <a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a></td></tr> +<tr class="memdesc:ga085159cb4136f84a02777bcc72c73fa3"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP delivery tag. <br/></td></tr> +<tr class="separator:ga085159cb4136f84a02777bcc72c73fa3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a></td></tr> +<tr class="memdesc:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="mdescLeft"> </td><td class="mdescRight">Dispositions record the current state and/or final outcome of a transfer. <a href="#ga4b28f6cd033babd8a7595fc5d292dca1">More...</a><br/></td></tr> +<tr class="separator:ga4b28f6cd033babd8a7595fc5d292dca1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacdfce854066c0a4ff4db9f9a0478f340"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a></td></tr> +<tr class="memdesc:gacdfce854066c0a4ff4db9f9a0478f340"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP Delivery object. <a href="#gacdfce854066c0a4ff4db9f9a0478f340">More...</a><br/></td></tr> +<tr class="separator:gacdfce854066c0a4ff4db9f9a0478f340"><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:gaea4522ac1fef9228fb6c743d2a36fd27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gaea4522ac1fef9228fb6c743d2a36fd27">pn_dtag</a> (const char *bytes, size_t size)</td></tr> +<tr class="memdesc:gaea4522ac1fef9228fb6c743d2a36fd27"><td class="mdescLeft"> </td><td class="mdescRight">Construct a delivery tag. <a href="#gaea4522ac1fef9228fb6c743d2a36fd27">More...</a><br/></td></tr> +<tr class="separator:gaea4522ac1fef9228fb6c743d2a36fd27"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6a7ef2e317b4ed292cafbb358f0ba6ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga6a7ef2e317b4ed292cafbb358f0ba6ad">pn_delivery</a> (<a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> tag)</td></tr> +<tr class="memdesc:ga6a7ef2e317b4ed292cafbb358f0ba6ad"><td class="mdescLeft"> </td><td class="mdescRight">Create a delivery on a link. <a href="#ga6a7ef2e317b4ed292cafbb358f0ba6ad">More...</a><br/></td></tr> +<tr class="separator:ga6a7ef2e317b4ed292cafbb358f0ba6ad"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga17c16f34252597f9e737efae1e2ebb81"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="separator:ga17c16f34252597f9e737efae1e2ebb81"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga91519d3e4568ee8b622d3653e20f60a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, void *context)</td></tr> +<tr class="separator:ga91519d3e4568ee8b622d3653e20f60a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3e014fc1759a212bc3ee9e513a274331"><td class="memItemLeft" align="right" valign="top">pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331">pn_delivery_attachments</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga3e014fc1759a212bc3ee9e513a274331"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a delivery object. <a href="#ga3e014fc1759a212bc3ee9e513a274331">More...</a><br/></td></tr> +<tr class="separator:ga3e014fc1759a212bc3ee9e513a274331"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6b4029fa3c5a04c3e2320b9fdd0a76c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga6b4029fa3c5a04c3e2320b9fdd0a76c5">pn_delivery_tag</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga6b4029fa3c5a04c3e2320b9fdd0a76c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the tag for a delivery object. <a href="#ga6b4029fa3c5a04c3e2320b9fdd0a76c5">More...</a><br/></td></tr> +<tr class="separator:ga6b4029fa3c5a04c3e2320b9fdd0a76c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad3dd82fe9a649d70d4f3430c34699638"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gad3dd82fe9a649d70d4f3430c34699638">pn_delivery_link</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:gad3dd82fe9a649d70d4f3430c34699638"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent link for a delivery object. <a href="#gad3dd82fe9a649d70d4f3430c34699638">More...</a><br/></td></tr> +<tr class="separator:gad3dd82fe9a649d70d4f3430c34699638"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga404728c55cb6984dbb51956d764265a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga404728c55cb6984dbb51956d764265a0">pn_delivery_local</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga404728c55cb6984dbb51956d764265a0"><td class="mdescLeft"> </td><td class="mdescRight">Get the local disposition for a delivery. <a href="#ga404728c55cb6984dbb51956d764265a0">More...</a><br/></td></tr> +<tr class="separator:ga404728c55cb6984dbb51956d764265a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaee6fa7698d4b7cf335c2d7a4c7622898"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gaee6fa7698d4b7cf335c2d7a4c7622898">pn_delivery_local_state</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:gaee6fa7698d4b7cf335c2d7a4c7622898"><td class="mdescLeft"> </td><td class="mdescRight">Get the local disposition state for a delivery. <a href="#gaee6fa7698d4b7cf335c2d7a4c7622898">More...</a><br/></td></tr> +<tr class="separator:gaee6fa7698d4b7cf335c2d7a4c7622898"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2a666cb1a4cec190f0c9d20a7bcfae3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga2a666cb1a4cec190f0c9d20a7bcfae3f">pn_delivery_remote</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga2a666cb1a4cec190f0c9d20a7bcfae3f"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote disposition for a delivery. <a href="#ga2a666cb1a4cec190f0c9d20a7bcfae3f">More...</a><br/></td></tr> +<tr class="separator:ga2a666cb1a4cec190f0c9d20a7bcfae3f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac1c3f2e7217b51f0e2f8c4264b0689d1"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gac1c3f2e7217b51f0e2f8c4264b0689d1">pn_delivery_remote_state</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:gac1c3f2e7217b51f0e2f8c4264b0689d1"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote disposition state for a delivery. <a href="#gac1c3f2e7217b51f0e2f8c4264b0689d1">More...</a><br/></td></tr> +<tr class="separator:gac1c3f2e7217b51f0e2f8c4264b0689d1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga516aee25357ac7cfde863bbceef02529"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga516aee25357ac7cfde863bbceef02529">pn_delivery_settled</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga516aee25357ac7cfde863bbceef02529"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is remotely settled. <a href="#ga516aee25357ac7cfde863bbceef02529">More...</a><br/></td></tr> +<tr class="separator:ga516aee25357ac7cfde863bbceef02529"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga17523835dbc8d1906bd71df69d09cc40"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga17523835dbc8d1906bd71df69d09cc40">pn_delivery_pending</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga17523835dbc8d1906bd71df69d09cc40"><td class="mdescLeft"> </td><td class="mdescRight">Get the amount of pending message data for a delivery. <a href="#ga17523835dbc8d1906bd71df69d09cc40">More...</a><br/></td></tr> +<tr class="separator:ga17523835dbc8d1906bd71df69d09cc40"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga23c7b3c678228ccb21378e7c8ec9a72d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga23c7b3c678228ccb21378e7c8ec9a72d">pn_delivery_partial</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga23c7b3c678228ccb21378e7c8ec9a72d"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery only has partial message data. <a href="#ga23c7b3c678228ccb21378e7c8ec9a72d">More...</a><br/></td></tr> +<tr class="separator:ga23c7b3c678228ccb21378e7c8ec9a72d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga533bd8dd766786695b6e71f8505252f1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga533bd8dd766786695b6e71f8505252f1">pn_delivery_writable</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga533bd8dd766786695b6e71f8505252f1"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is writable. <a href="#ga533bd8dd766786695b6e71f8505252f1">More...</a><br/></td></tr> +<tr class="separator:ga533bd8dd766786695b6e71f8505252f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga13364206124b653b90f5ee3ddae9ff35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga13364206124b653b90f5ee3ddae9ff35">pn_delivery_readable</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga13364206124b653b90f5ee3ddae9ff35"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is readable. <a href="#ga13364206124b653b90f5ee3ddae9ff35">More...</a><br/></td></tr> +<tr class="separator:ga13364206124b653b90f5ee3ddae9ff35"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga56d7f16a93e5dd16147a2ecd4896fcb9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga56d7f16a93e5dd16147a2ecd4896fcb9">pn_delivery_updated</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga56d7f16a93e5dd16147a2ecd4896fcb9"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is updated. <a href="#ga56d7f16a93e5dd16147a2ecd4896fcb9">More...</a><br/></td></tr> +<tr class="separator:ga56d7f16a93e5dd16147a2ecd4896fcb9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga570c54003c2ba18b84405737925e5176"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga570c54003c2ba18b84405737925e5176">pn_delivery_update</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, uint64_t state)</td></tr> +<tr class="memdesc:ga570c54003c2ba18b84405737925e5176"><td class="mdescLeft"> </td><td class="mdescRight">Update the disposition of a delivery. <a href="#ga570c54003c2ba18b84405737925e5176">More...</a><br/></td></tr> +<tr class="separator:ga570c54003c2ba18b84405737925e5176"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2e5da4adf0738458ba8568d894e6ea5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga2e5da4adf0738458ba8568d894e6ea5b">pn_delivery_clear</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga2e5da4adf0738458ba8568d894e6ea5b"><td class="mdescLeft"> </td><td class="mdescRight">Clear the updated flag for a delivery. <a href="#ga2e5da4adf0738458ba8568d894e6ea5b">More...</a><br/></td></tr> +<tr class="separator:ga2e5da4adf0738458ba8568d894e6ea5b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga365b3efbdd225a239dcf4746127c5f33"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga365b3efbdd225a239dcf4746127c5f33">pn_delivery_current</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga365b3efbdd225a239dcf4746127c5f33"><td class="mdescLeft"> </td><td class="mdescRight">Return true if delivery is the current delivery for its link. <a href="#ga365b3efbdd225a239dcf4746127c5f33">More...</a><br/></td></tr> +<tr class="separator:ga365b3efbdd225a239dcf4746127c5f33"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga98c275fd7158e8b9d7d48d70503d68df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df">pn_delivery_settle</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga98c275fd7158e8b9d7d48d70503d68df"><td class="mdescLeft"> </td><td class="mdescRight">Settle a delivery. <a href="#ga98c275fd7158e8b9d7d48d70503d68df">More...</a><br/></td></tr> +<tr class="separator:ga98c275fd7158e8b9d7d48d70503d68df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0dbbc51564aea5b181d161ee7add1ddb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga0dbbc51564aea5b181d161ee7add1ddb">pn_delivery_dump</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga0dbbc51564aea5b181d161ee7add1ddb"><td class="mdescLeft"> </td><td class="mdescRight">Utility function for printing details of a delivery. <a href="#ga0dbbc51564aea5b181d161ee7add1ddb">More...</a><br/></td></tr> +<tr class="separator:ga0dbbc51564aea5b181d161ee7add1ddb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1b7d56bd985e12a524c5cc5bc969bbdf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga1b7d56bd985e12a524c5cc5bc969bbdf">pn_delivery_buffered</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:ga1b7d56bd985e12a524c5cc5bc969bbdf"><td class="mdescLeft"> </td><td class="mdescRight">Check if a delivery is buffered. <a href="#ga1b7d56bd985e12a524c5cc5bc969bbdf">More...</a><br/></td></tr> +<tr class="separator:ga1b7d56bd985e12a524c5cc5bc969bbdf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5cb4f352dafe1b4866b68f27c37cbeac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga5cb4f352dafe1b4866b68f27c37cbeac">pn_work_head</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> +<tr class="memdesc:ga5cb4f352dafe1b4866b68f27c37cbeac"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the first delivery on the connection that has pending operations. <a href="#ga5cb4f352dafe1b4866b68f27c37cbeac">More...</a><br/></td></tr> +<tr class="separator:ga5cb4f352dafe1b4866b68f27c37cbeac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad7b9248f26e4787983378e5310e4ffdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gad7b9248f26e4787983378e5310e4ffdd">pn_work_next</a> (<a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery)</td></tr> +<tr class="memdesc:gad7b9248f26e4787983378e5310e4ffdd"><td class="mdescLeft"> </td><td class="mdescRight">Get the next delivery on the connection that needs has pending operations. <a href="#gad7b9248f26e4787983378e5310e4ffdd">More...</a><br/></td></tr> +<tr class="separator:gad7b9248f26e4787983378e5310e4ffdd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga42387f728f4817fdd393cc98315db332"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga42387f728f4817fdd393cc98315db332">pn_disposition_type</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga42387f728f4817fdd393cc98315db332"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of a disposition. <a href="#ga42387f728f4817fdd393cc98315db332">More...</a><br/></td></tr> +<tr class="separator:ga42387f728f4817fdd393cc98315db332"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8989de9cdcbbc7d0fadc1bba1f71d991"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga8989de9cdcbbc7d0fadc1bba1f71d991">pn_disposition_condition</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga8989de9cdcbbc7d0fadc1bba1f71d991"><td class="mdescLeft"> </td><td class="mdescRight">Access the condition object associated with a disposition. <a href="#ga8989de9cdcbbc7d0fadc1bba1f71d991">More...</a><br/></td></tr> +<tr class="separator:ga8989de9cdcbbc7d0fadc1bba1f71d991"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9c168eb2b16c68d20b1e46ab904963cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga9c168eb2b16c68d20b1e46ab904963cb">pn_disposition_data</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga9c168eb2b16c68d20b1e46ab904963cb"><td class="mdescLeft"> </td><td class="mdescRight">Access the disposition as a raw pn_data_t. <a href="#ga9c168eb2b16c68d20b1e46ab904963cb">More...</a><br/></td></tr> +<tr class="separator:ga9c168eb2b16c68d20b1e46ab904963cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5d0a4239487a90010403007f6cb268f0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga5d0a4239487a90010403007f6cb268f0">pn_disposition_get_section_number</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga5d0a4239487a90010403007f6cb268f0"><td class="mdescLeft"> </td><td class="mdescRight">Get the section number associated with a disposition. <a href="#ga5d0a4239487a90010403007f6cb268f0">More...</a><br/></td></tr> +<tr class="separator:ga5d0a4239487a90010403007f6cb268f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga102eb1d46ff8fbed816d5c619e5fa52f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga102eb1d46ff8fbed816d5c619e5fa52f">pn_disposition_set_section_number</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, uint32_t section_number)</td></tr> +<tr class="memdesc:ga102eb1d46ff8fbed816d5c619e5fa52f"><td class="mdescLeft"> </td><td class="mdescRight">Set the section number associated with a disposition. <a href="#ga102eb1d46ff8fbed816d5c619e5fa52f">More...</a><br/></td></tr> +<tr class="separator:ga102eb1d46ff8fbed816d5c619e5fa52f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7c5a14c31891750fcd211d90770a96d7"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga7c5a14c31891750fcd211d90770a96d7">pn_disposition_get_section_offset</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga7c5a14c31891750fcd211d90770a96d7"><td class="mdescLeft"> </td><td class="mdescRight">Get the section offset associated with a disposition. <a href="#ga7c5a14c31891750fcd211d90770a96d7">More...</a><br/></td></tr> +<tr class="separator:ga7c5a14c31891750fcd211d90770a96d7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5940110912277fbd543f8be3066be98b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga5940110912277fbd543f8be3066be98b">pn_disposition_set_section_offset</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, uint64_t section_offset)</td></tr> +<tr class="memdesc:ga5940110912277fbd543f8be3066be98b"><td class="mdescLeft"> </td><td class="mdescRight">Set the section offset associated with a disposition. <a href="#ga5940110912277fbd543f8be3066be98b">More...</a><br/></td></tr> +<tr class="separator:ga5940110912277fbd543f8be3066be98b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga62d917e8a18288fdb1719bf5488c3f53"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga62d917e8a18288fdb1719bf5488c3f53">pn_disposition_is_failed</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga62d917e8a18288fdb1719bf5488c3f53"><td class="mdescLeft"> </td><td class="mdescRight">Check if a disposition has the failed flag set. <a href="#ga62d917e8a18288fdb1719bf5488c3f53">More...</a><br/></td></tr> +<tr class="separator:ga62d917e8a18288fdb1719bf5488c3f53"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8001f9574b5f37dff71ccfbc0524672e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga8001f9574b5f37dff71ccfbc0524672e">pn_disposition_set_failed</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, bool failed)</td></tr> +<tr class="memdesc:ga8001f9574b5f37dff71ccfbc0524672e"><td class="mdescLeft"> </td><td class="mdescRight">Set the failed flag on a disposition. <a href="#ga8001f9574b5f37dff71ccfbc0524672e">More...</a><br/></td></tr> +<tr class="separator:ga8001f9574b5f37dff71ccfbc0524672e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae4d5ce97c27e18d3dd843b829b81c585"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#gae4d5ce97c27e18d3dd843b829b81c585">pn_disposition_is_undeliverable</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:gae4d5ce97c27e18d3dd843b829b81c585"><td class="mdescLeft"> </td><td class="mdescRight">Check if a disposition has the undeliverable flag set. <a href="#gae4d5ce97c27e18d3dd843b829b81c585">More...</a><br/></td></tr> +<tr class="separator:gae4d5ce97c27e18d3dd843b829b81c585"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga805e6f4953eb559d5acfcfd7084fc4b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga805e6f4953eb559d5acfcfd7084fc4b3">pn_disposition_set_undeliverable</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition, bool undeliverable)</td></tr> +<tr class="memdesc:ga805e6f4953eb559d5acfcfd7084fc4b3"><td class="mdescLeft"> </td><td class="mdescRight">Set the undeliverable flag on a disposition. <a href="#ga805e6f4953eb559d5acfcfd7084fc4b3">More...</a><br/></td></tr> +<tr class="separator:ga805e6f4953eb559d5acfcfd7084fc4b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6ffa5f235cb616c823746a592a191fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga6ffa5f235cb616c823746a592a191fdb">pn_disposition_annotations</a> (<a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *disposition)</td></tr> +<tr class="memdesc:ga6ffa5f235cb616c823746a592a191fdb"><td class="mdescLeft"> </td><td class="mdescRight">Access the annotations associated with a disposition. <a href="#ga6ffa5f235cb616c823746a592a191fdb">More...</a><br/></td></tr> +<tr class="separator:ga6ffa5f235cb616c823746a592a191fdb"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>A message transfer. </p> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="gac64952b813a707586c6b3898e09552e4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_ACCEPTED</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed. </p> +<p>Once in this state there will be no further state changes prior to the delivery being settled. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a66">broker.c</a>, <a class="el" href="receive_8c-example.html#a30">receive.c</a>, and <a class="el" href="send_8c-example.html#a52">send.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga247e3d1ac7c9096cdd28424353582962"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_MODIFIED</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to the sender and should be annotated by the sender prior to further delivery attempts. </p> +<p>Once in this state there will be no further state changes prior to the delivery being settled. </p> + +</div> +</div> +<a class="anchor" id="ga44a2635392fe2e6f8869a7e1cd64db2f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_REJECTED</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition. </p> +<p>Once in this state there will be no further state changes prior to the delivery being settled. </p> + +</div> +</div> +<a class="anchor" id="ga628179c16c4a5f5fd7734bc1bfc6edc3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PN_RELEASED</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender. </p> +<p>Once in this state there will be no further state changes prior to the delivery being settled. </p> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="gacdfce854066c0a4ff4db9f9a0478f340"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> <a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>An AMQP Delivery object. </p> +<p>A pn_delivery_t object encapsulates all of the endpoint state associated with an AMQP Delivery. Every delivery exists within the context of a <a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0" title="An AMQP Link object.">pn_link_t</a> object.</p> +<p>The AMQP model for settlement is based on the lifecycle of a delivery at an endpoint. At each end of a link, a delivery is created, it exists for some period of time, and finally it is forgotten, aka settled. Note that because this lifecycle happens independently at both the sender and the receiver, there are actually four events of interest in the combined lifecycle of a given delivery:</p> +<ul> +<li>created at sender</li> +<li>created at receiver</li> +<li>settled at sender</li> +<li>settled at receiver</li> +</ul> +<p>Because the sender and receiver are operating concurrently, these events can occur in a variety of different orders, and the order of these events impacts the types of failures that may occur when transferring a delivery. Eliminating scenarios where the receiver creates the delivery first, we have the following possible sequences of interest:</p> +<h2>Sender presettles (aka at-most-once):</h2> +<ol type="1"> +<li>created at sender</li> +<li>settled at sender</li> +<li>created at receiver</li> +<li>settled at receiver</li> +</ol> +<p>In this configuration the sender settles (i.e. forgets about) the delivery before it even reaches the receiver, and if anything should happen to the delivery in-flight, there is no way to recover, hence the "at most once" semantics.</p> +<h2>Receiver settles first (aka at-least-once):</h2> +<ol type="1"> +<li>created at sender</li> +<li>created at receiver</li> +<li>settled at receiver</li> +<li>settled at sender</li> +</ol> +<p>In this configuration the receiver settles the delivery first, and the sender settles once it sees the receiver has settled. Should anything happen to the delivery in-flight, the sender can resend, however the receiver may have already forgotten the delivery and so it could interpret the resend as a new delivery, hence the "at +least once" semantics.</p> +<h2>Receiver settles second (aka exactly-once):</h2> +<ol type="1"> +<li>created at sender</li> +<li>created at receiver</li> +<li>settled at sender</li> +<li>settled at receiver</li> +</ol> +<p>In this configuration the receiver settles only once it has seen that the sender has settled. This provides the sender the option to retransmit, and the receiver has the option to recognize (and discard) duplicates, allowing for exactly once semantics.</p> +<p>Note that in the last scenario the sender needs some way to know when it is safe to settle. This is where delivery state comes in. In addition to these lifecycle related events surrounding deliveries there is also the notion of a delivery state that can change over the lifetime of a delivery, e.g. it might start out as nothing, transition to <a class="el" href="group__delivery.html#gaae349c977b37b584aa62fff6515802ca" title="The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has ...">PN_RECEIVED</a> and then transition to <a class="el" href="group__delivery.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a>. In the first two scenarios the delivery state isn't required, however in final scenario the sender would typically trigger settlement based on seeing the delivery state transition to a terminal state like <a class= "el" href="group__delivery.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a> or <a class="el" href="group__delivery.html#ga44a2635392fe2e6f8869a7e1cd64db2f" title="The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processe...">PN_REJECTED</a>.</p> +<p>In practice settlement is controlled by application policy, so there may well be more options here, e.g. a sender might not settle strictly based on what has happened at the receiver, it might also choose to impose some time limit and settle after that period has expired, or it could simply have a sliding window of the last N deliveries and settle the oldest whenever a new one comes along. </p> + +</div> +</div> +<a class="anchor" id="ga4b28f6cd033babd8a7595fc5d292dca1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> <a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Dispositions record the current state and/or final outcome of a transfer. </p> +<p>Every delivery contains both a local and remote disposition. The local disposition holds the local state of the delivery, and the remote disposition holds the last known remote state of the delivery. </p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga6a7ef2e317b4ed292cafbb358f0ba6ad"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_delivery </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td> + <td class="paramname"><em>link</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> </td> + <td class="paramname"><em>tag</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a delivery on a link. </p> +<p>Every delivery object within a link must be supplied with a unique tag. Links maintain a sequence of delivery object in the order that they are created.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">link</td><td>a link object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>the delivery tag </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a newly created delivery, or NULL if there was an error </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a5">broker.c</a>, and <a class="el" href="send_8c-example.html#a25">send.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga3e014fc1759a212bc3ee9e513a274331"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">pn_record_t* pn_delivery_attachments </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the attachments that are associated with a delivery object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery whose attachments are to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the attachments for the delivery object </dd></dl> + +</div> +</div> +<a class="anchor" id="ga1b7d56bd985e12a524c5cc5bc969bbdf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_buffered </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery is buffered. </p> +<p>A delivery that is buffered has not yet been written to the wire.</p> +<p>Note that returning false does not imply that a delivery was definitely written to the wire. If false is returned, it is not known whether the delivery was actually written to the wire or not.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery is buffered </dd></dl> + +</div> +</div> +<a class="anchor" id="ga2e5da4adf0738458ba8568d894e6ea5b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_delivery_clear </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Clear the updated flag for a delivery. </p> +<p>See <a class="el" href="group__delivery.html#ga56d7f16a93e5dd16147a2ecd4896fcb9" title="Check if a delivery is updated.">pn_delivery_updated</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga365b3efbdd225a239dcf4746127c5f33"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_current </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return true if delivery is the current delivery for its link. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if delivery is the current delivery for its link. </dd></dl> + +</div> +</div> +<a class="anchor" id="ga0dbbc51564aea5b181d161ee7add1ddb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_delivery_dump </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Utility function for printing details of a delivery. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga17c16f34252597f9e737efae1e2ebb81"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* pn_delivery_get_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd></dd></dl> +<p>Get the application context that is associated with a delivery object.</p> +<p>The application context for a delivery may be set using <a class="el" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery whose context is to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the application context for the delivery object </dd></dl> + +</div> +</div> +<a class="anchor" id="gad3dd82fe9a649d70d4f3430c34699638"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_delivery_link </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the parent link for a delivery object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the parent link </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a59">broker.c</a>, and <a class="el" href="receive_8c-example.html#a8">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga404728c55cb6984dbb51956d764265a0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a>* pn_delivery_local </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the local disposition for a delivery. </p> +<p>The pointer returned by this object is valid until the delivery is settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the local disposition </dd></dl> + +</div> +</div> +<a class="anchor" id="gaee6fa7698d4b7cf335c2d7a4c7622898"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint64_t pn_delivery_local_state </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the local disposition state for a delivery. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the local disposition state </dd></dl> + +</div> +</div> +<a class="anchor" id="ga23c7b3c678228ccb21378e7c8ec9a72d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_partial </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery only has partial message data. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery only contains part of a message, false otherwise </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a62">broker.c</a>, and <a class="el" href="receive_8c-example.html#a28">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga17523835dbc8d1906bd71df69d09cc40"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">size_t pn_delivery_pending </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the amount of pending message data for a delivery. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the amount of pending message data in bytes </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a63">broker.c</a>, and <a class="el" href="receive_8c-example.html#a6">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga13364206124b653b90f5ee3ddae9ff35"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_readable </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery is readable. </p> +<p>A delivery is considered readable if it is the current delivery on an incoming link.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery is readable, false otherwise </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a61">broker.c</a>, and <a class="el" href="receive_8c-example.html#a27">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga2a666cb1a4cec190f0c9d20a7bcfae3f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a>* pn_delivery_remote </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the remote disposition for a delivery. </p> +<p>The pointer returned by this object is valid until the delivery is settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the remote disposition </dd></dl> + +</div> +</div> +<a class="anchor" id="gac1c3f2e7217b51f0e2f8c4264b0689d1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint64_t pn_delivery_remote_state </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the remote disposition state for a delivery. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the remote disposition state </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="send_8c-example.html#a51">send.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga91519d3e4568ee8b622d3653e20f60a6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_delivery_set_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</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"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd></dd></dl> +<p>Set a new application context for a delivery object.</p> +<p>The application context for a delivery object may be retrieved using <a class="el" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>the delivery object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application context </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga98c275fd7158e8b9d7d48d70503d68df"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_delivery_settle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Settle a delivery. </p> +<p>A settled delivery can never be used again.</p> +<dl class="section note"><dt>Note</dt><dd>If pn_delivery_current(delivery) is true before the call then pn_link_advance(pn_delivery_link(deliver)) is called automatically.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a10">broker.c</a>, and <a class="el" href="receive_8c-example.html#a32">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga516aee25357ac7cfde863bbceef02529"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_settled </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery is remotely settled. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery is settled at the remote endpoint, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga6b4029fa3c5a04c3e2320b9fdd0a76c5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> pn_delivery_tag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the tag for a delivery object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the delivery tag </dd></dl> + +</div> +</div> +<a class="anchor" id="ga570c54003c2ba18b84405737925e5176"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_delivery_update </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint64_t </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update the disposition of a delivery. </p> +<p>When update is invoked the updated disposition of the delivery will be communicated to the peer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>the updated delivery state </td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8c-example.html#a65">broker.c</a>, and <a class="el" href="receive_8c-example.html#a29">receive.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ga56d7f16a93e5dd16147a2ecd4896fcb9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_updated </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery is updated. </p> +<p>A delivery is considered updated whenever the peer communicates a new disposition for the delivery. Once a delivery becomes updated, it will remain so until <a class="el" href="group__delivery.html#ga2e5da4adf0738458ba8568d894e6ea5b" title="Clear the updated flag for a delivery.">pn_delivery_clear</a> is called.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery is updated, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga533bd8dd766786695b6e71f8505252f1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_delivery_writable </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td> + <td class="paramname"><em>delivery</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a delivery is writable. </p> +<p>A delivery is considered writable if it is the current delivery on an outgoing link, and the link has positive credit.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">delivery</td><td>a delivery object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the delivery is writable, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga6ffa5f235cb616c823746a592a191fdb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_disposition_annotations </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Access the annotations associated with a disposition. </p> +<p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object.">pn_data_t</a> object retrieved by this operation may be modified prior to updating a delivery. When a delivery is updated, the annotations described by the <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object.">pn_data_t</a> are reported to the peer if applicable to the current delivery state, e.g. states such as <a class="el" href="group__delivery.html#ga247e3d1ac7c9096cdd28424353582962" title="The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_MODIFIED</a>. The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object.">pn_data_t</a> must be empty or contain a symbol keyed map.</p> +<p>The pointer returned by this operation is valid until the parent delivery is settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the annotations associated with the disposition </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8989de9cdcbbc7d0fadc1bba1f71d991"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* pn_disposition_condition </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Access the condition object associated with a disposition. </p> +<p>The <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5" title="An AMQP Condition object.">pn_condition_t</a> object retrieved by this operation may be modified prior to updating a delivery. When a delivery is updated, the condition described by the disposition is reported to the peer if applicable to the current delivery state, e.g. states such as <a class="el" href="group__delivery.html#ga44a2635392fe2e6f8869a7e1cd64db2f" title="The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processe...">PN_REJECTED</a>.</p> +<p>The pointer returned by this operation is valid until the parent delivery is settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the disposition condition </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9c168eb2b16c68d20b1e46ab904963cb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_disposition_data </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Access the disposition as a raw pn_data_t. </p> +<p>Dispositions are an extension point in the AMQP protocol. The disposition interface provides setters/getters for those dispositions that are predefined by the specification, however access to the raw disposition data is provided so that other dispositions can be used.</p> +<p>The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object.">pn_data_t</a> pointer returned by this operation is valid until the parent delivery is settled.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a pointer to the raw disposition data </dd></dl> + +</div> +</div> +<a class="anchor" id="ga5d0a4239487a90010403007f6cb268f0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pn_disposition_get_section_number </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the section number associated with a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a section number </dd></dl> + +</div> +</div> +<a class="anchor" id="ga7c5a14c31891750fcd211d90770a96d7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint64_t pn_disposition_get_section_offset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the section offset associated with a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a section offset </dd></dl> + +</div> +</div> +<a class="anchor" id="ga62d917e8a18288fdb1719bf5488c3f53"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_disposition_is_failed </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a disposition has the failed flag set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the disposition has the failed flag set, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="gae4d5ce97c27e18d3dd843b829b81c585"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool pn_disposition_is_undeliverable </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if a disposition has the undeliverable flag set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the disposition has the undeliverable flag set, false otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8001f9574b5f37dff71ccfbc0524672e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_disposition_set_failed </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>failed</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the failed flag on a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">failed</td><td>the value of the failed flag </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga102eb1d46ff8fbed816d5c619e5fa52f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_disposition_set_section_number </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>section_number</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the section number associated with a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">section_number</td><td>a section number </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga5940110912277fbd543f8be3066be98b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_disposition_set_section_offset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint64_t </td> + <td class="paramname"><em>section_offset</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the section offset associated with a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">section_offset</td><td>a section offset </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga805e6f4953eb559d5acfcfd7084fc4b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pn_disposition_set_undeliverable </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>undeliverable</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the undeliverable flag on a disposition. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">undeliverable</td><td>the value of the undeliverable flag </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ga42387f728f4817fdd393cc98315db332"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint64_t pn_disposition_type </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> * </td> + <td class="paramname"><em>disposition</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the type of a disposition. </p> +<p>Defined values are:</p> +<ul> +<li><a class="el" href="group__delivery.html#gaae349c977b37b584aa62fff6515802ca" title="The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has ...">PN_RECEIVED</a></li> +<li><a class="el" href="group__delivery.html#gac64952b813a707586c6b3898e09552e4" title="The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully proc...">PN_ACCEPTED</a></li> +<li><a class="el" href="group__delivery.html#ga44a2635392fe2e6f8869a7e1cd64db2f" title="The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processe...">PN_REJECTED</a></li> +<li><a class="el" href="group__delivery.html#ga628179c16c4a5f5fd7734bc1bfc6edc3" title="The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_RELEASED</a></li> +<li><a class="el" href="group__delivery.html#ga247e3d1ac7c9096cdd28424353582962" title="The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to ...">PN_MODIFIED</a></li> +</ul> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">disposition</td><td>a disposition object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the type of the disposition </dd></dl> + +</div> +</div> +<a class="anchor" id="gaea4522ac1fef9228fb6c743d2a36fd27"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a> pn_dtag </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>bytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Construct a delivery tag. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">bytes
<TRUNCATED> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
