| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C API: proton/delivery.h Source File</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="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| 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.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('delivery_8h_source.html',''); initResizable(); }); |
| /* @license-end */ |
| </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)"> |
| </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">delivery.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="delivery_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_DELIVERY_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_DELIVERY_H 1</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="disposition_8h.html">proton/disposition.h</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <proton/type_compat.h></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stddef.h></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3"> 46</a></span> <span class="keyword">typedef</span> <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> <a class="code" href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a>;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__delivery.html#gaea4522ac1fef9228fb6c743d2a36fd27"> 55</a></span> PN_EXTERN <a class="code" href="group__api__types.html#structpn__bytes__t">pn_delivery_tag_t</a> <a class="code" href="group__delivery.html#gaea4522ac1fef9228fb6c743d2a36fd27">pn_dtag</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *bytes, <span class="keywordtype">size_t</span> size);</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="group__delivery.html#ga6a7ef2e317b4ed292cafbb358f0ba6ad"> 68</a></span> PN_EXTERN <a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *<a class="code" href="group__delivery.html#ga6a7ef2e317b4ed292cafbb358f0ba6ad">pn_delivery</a>(<a class="code" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *link, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_delivery_tag_t</a> tag);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81"> 79</a></span> PN_EXTERN <span class="keywordtype">void</span> *<a class="code" href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6"> 90</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, <span class="keywordtype">void</span> *context);</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331"> 98</a></span> PN_EXTERN pn_record_t *<a class="code" href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331">pn_delivery_attachments</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__delivery.html#ga6b4029fa3c5a04c3e2320b9fdd0a76c5"> 106</a></span> PN_EXTERN <a class="code" href="group__api__types.html#structpn__bytes__t">pn_delivery_tag_t</a> <a class="code" href="group__delivery.html#ga6b4029fa3c5a04c3e2320b9fdd0a76c5">pn_delivery_tag</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> |
| <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="group__delivery.html#gad3dd82fe9a649d70d4f3430c34699638"> 114</a></span> PN_EXTERN <a class="code" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *<a class="code" href="group__delivery.html#gad3dd82fe9a649d70d4f3430c34699638">pn_delivery_link</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="group__delivery.html#ga404728c55cb6984dbb51956d764265a0"> 125</a></span> PN_EXTERN <a class="code" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *<a class="code" href="group__delivery.html#ga404728c55cb6984dbb51956d764265a0">pn_delivery_local</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="group__delivery.html#gaee6fa7698d4b7cf335c2d7a4c7622898"> 133</a></span> PN_EXTERN uint64_t <a class="code" href="group__delivery.html#gaee6fa7698d4b7cf335c2d7a4c7622898">pn_delivery_local_state</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div> |
| <div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="group__delivery.html#ga2a666cb1a4cec190f0c9d20a7bcfae3f"> 144</a></span> PN_EXTERN <a class="code" href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a> *<a class="code" href="group__delivery.html#ga2a666cb1a4cec190f0c9d20a7bcfae3f">pn_delivery_remote</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div> |
| <div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="group__delivery.html#gac1c3f2e7217b51f0e2f8c4264b0689d1"> 152</a></span> PN_EXTERN uint64_t <a class="code" href="group__delivery.html#gac1c3f2e7217b51f0e2f8c4264b0689d1">pn_delivery_remote_state</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div> |
| <div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="group__delivery.html#ga516aee25357ac7cfde863bbceef02529"> 160</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga516aee25357ac7cfde863bbceef02529">pn_delivery_settled</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div> |
| <div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="group__delivery.html#ga17523835dbc8d1906bd71df69d09cc40"> 168</a></span> PN_EXTERN <span class="keywordtype">size_t</span> <a class="code" href="group__delivery.html#ga17523835dbc8d1906bd71df69d09cc40">pn_delivery_pending</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  </div> |
| <div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="group__delivery.html#ga23c7b3c678228ccb21378e7c8ec9a72d"> 179</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga23c7b3c678228ccb21378e7c8ec9a72d">pn_delivery_partial</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  </div> |
| <div class="line"><a name="l00199"></a><span class="lineno"><a class="line" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776"> 199</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776">pn_delivery_aborted</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div> |
| <div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="group__delivery.html#ga533bd8dd766786695b6e71f8505252f1"> 210</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga533bd8dd766786695b6e71f8505252f1">pn_delivery_writable</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  </div> |
| <div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="group__delivery.html#ga13364206124b653b90f5ee3ddae9ff35"> 221</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga13364206124b653b90f5ee3ddae9ff35">pn_delivery_readable</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  </div> |
| <div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="group__delivery.html#ga56d7f16a93e5dd16147a2ecd4896fcb9"> 233</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga56d7f16a93e5dd16147a2ecd4896fcb9">pn_delivery_updated</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  </div> |
| <div class="line"><a name="l00244"></a><span class="lineno"><a class="line" href="group__delivery.html#ga570c54003c2ba18b84405737925e5176"> 244</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga570c54003c2ba18b84405737925e5176">pn_delivery_update</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery, uint64_t state);</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div> |
| <div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="group__delivery.html#ga2e5da4adf0738458ba8568d894e6ea5b"> 253</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga2e5da4adf0738458ba8568d894e6ea5b">pn_delivery_clear</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  </div> |
| <div class="line"><a name="l00261"></a><span class="lineno"><a class="line" href="group__delivery.html#ga365b3efbdd225a239dcf4746127c5f33"> 261</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga365b3efbdd225a239dcf4746127c5f33">pn_delivery_current</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  </div> |
| <div class="line"><a name="l00280"></a><span class="lineno"><a class="line" href="group__delivery.html#ga407e51ff91368568d15f938b1771357c"> 280</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga407e51ff91368568d15f938b1771357c">pn_delivery_abort</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  </div> |
| <div class="line"><a name="l00292"></a><span class="lineno"><a class="line" href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df"> 292</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df">pn_delivery_settle</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  </div> |
| <div class="line"><a name="l00299"></a><span class="lineno"><a class="line" href="group__delivery.html#ga0dbbc51564aea5b181d161ee7add1ddb"> 299</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__delivery.html#ga0dbbc51564aea5b181d161ee7add1ddb">pn_delivery_dump</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  </div> |
| <div class="line"><a name="l00313"></a><span class="lineno"><a class="line" href="group__delivery.html#ga1b7d56bd985e12a524c5cc5bc969bbdf"> 313</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__delivery.html#ga1b7d56bd985e12a524c5cc5bc969bbdf">pn_delivery_buffered</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  </div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> PN_DEPRECATED(<span class="stringliteral">"Use the PN_DELIVERY event to track deliveries with pending operations"</span>)</div> |
| <div class="line"><a name="l00332"></a><span class="lineno"><a class="line" href="group__delivery.html#ga5cb4f352dafe1b4866b68f27c37cbeac"> 332</a></span> PN_EXTERN <a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *<a class="code" href="group__delivery.html#ga5cb4f352dafe1b4866b68f27c37cbeac">pn_work_head</a>(<a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection);</div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  </div> |
| <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> PN_DEPRECATED("Use the <a class="code" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe">PN_DELIVERY</a> event to track deliveries with pending operations")</div> |
| <div class="line"><a name="l00344"></a><span class="lineno"><a class="line" href="group__delivery.html#gad7b9248f26e4787983378e5310e4ffdd"> 344</a></span> PN_EXTERN <a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *<a class="code" href="group__delivery.html#gad7b9248f26e4787983378e5310e4ffdd">pn_work_next</a>(<a class="code" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> *delivery);</div> |
| <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  </div> |
| <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> }</div> |
| <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  </div> |
| <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor">#endif </span><span class="comment">/* delivery.h */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="agroup__delivery_html_ga5cb4f352dafe1b4866b68f27c37cbeac"><div class="ttname"><a href="group__delivery.html#ga5cb4f352dafe1b4866b68f27c37cbeac">pn_work_head</a></div><div class="ttdeci">pn_delivery_t * pn_work_head(pn_connection_t *connection)</div><div class="ttdoc">Extracts the first delivery on the connection that has pending operations.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga56d7f16a93e5dd16147a2ecd4896fcb9"><div class="ttname"><a href="group__delivery.html#ga56d7f16a93e5dd16147a2ecd4896fcb9">pn_delivery_updated</a></div><div class="ttdeci">bool pn_delivery_updated(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery is updated.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga98c275fd7158e8b9d7d48d70503d68df"><div class="ttname"><a href="group__delivery.html#ga98c275fd7158e8b9d7d48d70503d68df">pn_delivery_settle</a></div><div class="ttdeci">void pn_delivery_settle(pn_delivery_t *delivery)</div><div class="ttdoc">Settle a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga533bd8dd766786695b6e71f8505252f1"><div class="ttname"><a href="group__delivery.html#ga533bd8dd766786695b6e71f8505252f1">pn_delivery_writable</a></div><div class="ttdeci">bool pn_delivery_writable(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery is writable.</div></div> |
| <div class="ttc" id="agroup__delivery_html_gaee6fa7698d4b7cf335c2d7a4c7622898"><div class="ttname"><a href="group__delivery.html#gaee6fa7698d4b7cf335c2d7a4c7622898">pn_delivery_local_state</a></div><div class="ttdeci">uint64_t pn_delivery_local_state(pn_delivery_t *delivery)</div><div class="ttdoc">Get the local disposition state for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga712690e0cc84419d7b7ca7c49a10b776"><div class="ttname"><a href="group__delivery.html#ga712690e0cc84419d7b7ca7c49a10b776">pn_delivery_aborted</a></div><div class="ttdeci">bool pn_delivery_aborted(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a received delivery has been aborted.</div></div> |
| <div class="ttc" id="agroup__event_html_gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe"><div class="ttname"><a href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa70bbfc163d85732b5652dc70fb3330fe">PN_DELIVERY</a></div><div class="ttdeci">@ PN_DELIVERY</div><div class="ttdoc">A delivery has been created or updated.</div><div class="ttdef"><b>Definition:</b> event.h:254</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga1b7d56bd985e12a524c5cc5bc969bbdf"><div class="ttname"><a href="group__delivery.html#ga1b7d56bd985e12a524c5cc5bc969bbdf">pn_delivery_buffered</a></div><div class="ttdeci">bool pn_delivery_buffered(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery is buffered.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga404728c55cb6984dbb51956d764265a0"><div class="ttname"><a href="group__delivery.html#ga404728c55cb6984dbb51956d764265a0">pn_delivery_local</a></div><div class="ttdeci">pn_disposition_t * pn_delivery_local(pn_delivery_t *delivery)</div><div class="ttdoc">Get the local disposition for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga365b3efbdd225a239dcf4746127c5f33"><div class="ttname"><a href="group__delivery.html#ga365b3efbdd225a239dcf4746127c5f33">pn_delivery_current</a></div><div class="ttdeci">bool pn_delivery_current(pn_delivery_t *delivery)</div><div class="ttdoc">Return true if delivery is the current delivery for its link.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga6b4029fa3c5a04c3e2320b9fdd0a76c5"><div class="ttname"><a href="group__delivery.html#ga6b4029fa3c5a04c3e2320b9fdd0a76c5">pn_delivery_tag</a></div><div class="ttdeci">pn_delivery_tag_t pn_delivery_tag(pn_delivery_t *delivery)</div><div class="ttdoc">Get the tag for a delivery object.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga516aee25357ac7cfde863bbceef02529"><div class="ttname"><a href="group__delivery.html#ga516aee25357ac7cfde863bbceef02529">pn_delivery_settled</a></div><div class="ttdeci">bool pn_delivery_settled(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery is remotely settled.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga570c54003c2ba18b84405737925e5176"><div class="ttname"><a href="group__delivery.html#ga570c54003c2ba18b84405737925e5176">pn_delivery_update</a></div><div class="ttdeci">void pn_delivery_update(pn_delivery_t *delivery, uint64_t state)</div><div class="ttdoc">Update the disposition of a delivery.</div></div> |
| <div class="ttc" id="agroup__api__types_html_structpn__bytes__t"><div class="ttname"><a href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a></div><div class="ttdoc">A const byte buffer.</div><div class="ttdef"><b>Definition:</b> types.h:216</div></div> |
| <div class="ttc" id="agroup__delivery_html_gacdfce854066c0a4ff4db9f9a0478f340"><div class="ttname"><a href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a></div><div class="ttdeci">struct pn_delivery_t pn_delivery_t</div><div class="ttdoc">An AMQP Delivery object.</div><div class="ttdef"><b>Definition:</b> types.h:405</div></div> |
| <div class="ttc" id="agroup__delivery_html_gac1c3f2e7217b51f0e2f8c4264b0689d1"><div class="ttname"><a href="group__delivery.html#gac1c3f2e7217b51f0e2f8c4264b0689d1">pn_delivery_remote_state</a></div><div class="ttdeci">uint64_t pn_delivery_remote_state(pn_delivery_t *delivery)</div><div class="ttdoc">Get the remote disposition state for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga0dbbc51564aea5b181d161ee7add1ddb"><div class="ttname"><a href="group__delivery.html#ga0dbbc51564aea5b181d161ee7add1ddb">pn_delivery_dump</a></div><div class="ttdeci">void pn_delivery_dump(pn_delivery_t *delivery)</div><div class="ttdoc">Utility function for printing details of a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga407e51ff91368568d15f938b1771357c"><div class="ttname"><a href="group__delivery.html#ga407e51ff91368568d15f938b1771357c">pn_delivery_abort</a></div><div class="ttdeci">void pn_delivery_abort(pn_delivery_t *delivery)</div><div class="ttdoc">Abort a delivery being sent.</div></div> |
| <div class="ttc" id="agroup__connection_html_ga886351d81ff3a977a284a206526c5aff"><div class="ttname"><a href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></div><div class="ttdeci">struct pn_connection_t pn_connection_t</div><div class="ttdoc">An AMQP Connection object.</div><div class="ttdef"><b>Definition:</b> types.h:285</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga4b28f6cd033babd8a7595fc5d292dca1"><div class="ttname"><a href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">pn_disposition_t</a></div><div class="ttdeci">struct pn_disposition_t pn_disposition_t</div><div class="ttdoc">A delivery state.</div><div class="ttdef"><b>Definition:</b> disposition.h:52</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga2e5da4adf0738458ba8568d894e6ea5b"><div class="ttname"><a href="group__delivery.html#ga2e5da4adf0738458ba8568d894e6ea5b">pn_delivery_clear</a></div><div class="ttdeci">void pn_delivery_clear(pn_delivery_t *delivery)</div><div class="ttdoc">Clear the updated flag for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga17c16f34252597f9e737efae1e2ebb81"><div class="ttname"><a href="group__delivery.html#ga17c16f34252597f9e737efae1e2ebb81">pn_delivery_get_context</a></div><div class="ttdeci">void * pn_delivery_get_context(pn_delivery_t *delivery)</div><div class="ttdoc">Get the application context that is associated with a delivery object.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga23c7b3c678228ccb21378e7c8ec9a72d"><div class="ttname"><a href="group__delivery.html#ga23c7b3c678228ccb21378e7c8ec9a72d">pn_delivery_partial</a></div><div class="ttdeci">bool pn_delivery_partial(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery only has partial message data.</div></div> |
| <div class="ttc" id="agroup__link_html_ga89dad3aa7934329a7ff467c636687bc0"><div class="ttname"><a href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a></div><div class="ttdeci">struct pn_link_t pn_link_t</div><div class="ttdoc">An AMQP Link object.</div><div class="ttdef"><b>Definition:</b> types.h:315</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga2a666cb1a4cec190f0c9d20a7bcfae3f"><div class="ttname"><a href="group__delivery.html#ga2a666cb1a4cec190f0c9d20a7bcfae3f">pn_delivery_remote</a></div><div class="ttdeci">pn_disposition_t * pn_delivery_remote(pn_delivery_t *delivery)</div><div class="ttdoc">Get the remote disposition for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga6a7ef2e317b4ed292cafbb358f0ba6ad"><div class="ttname"><a href="group__delivery.html#ga6a7ef2e317b4ed292cafbb358f0ba6ad">pn_delivery</a></div><div class="ttdeci">pn_delivery_t * pn_delivery(pn_link_t *link, pn_delivery_tag_t tag)</div><div class="ttdoc">Create a delivery on a link.</div></div> |
| <div class="ttc" id="agroup__delivery_html_gad3dd82fe9a649d70d4f3430c34699638"><div class="ttname"><a href="group__delivery.html#gad3dd82fe9a649d70d4f3430c34699638">pn_delivery_link</a></div><div class="ttdeci">pn_link_t * pn_delivery_link(pn_delivery_t *delivery)</div><div class="ttdoc">Get the parent link for a delivery object.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga13364206124b653b90f5ee3ddae9ff35"><div class="ttname"><a href="group__delivery.html#ga13364206124b653b90f5ee3ddae9ff35">pn_delivery_readable</a></div><div class="ttdeci">bool pn_delivery_readable(pn_delivery_t *delivery)</div><div class="ttdoc">Check if a delivery is readable.</div></div> |
| <div class="ttc" id="agroup__delivery_html_gad7b9248f26e4787983378e5310e4ffdd"><div class="ttname"><a href="group__delivery.html#gad7b9248f26e4787983378e5310e4ffdd">pn_work_next</a></div><div class="ttdeci">pn_delivery_t * pn_work_next(pn_delivery_t *delivery)</div><div class="ttdoc">Get the next delivery on the connection that needs has pending operations.</div></div> |
| <div class="ttc" id="agroup__delivery_html_gaea4522ac1fef9228fb6c743d2a36fd27"><div class="ttname"><a href="group__delivery.html#gaea4522ac1fef9228fb6c743d2a36fd27">pn_dtag</a></div><div class="ttdeci">pn_delivery_tag_t pn_dtag(const char *bytes, size_t size)</div><div class="ttdoc">Construct a delivery tag.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga17523835dbc8d1906bd71df69d09cc40"><div class="ttname"><a href="group__delivery.html#ga17523835dbc8d1906bd71df69d09cc40">pn_delivery_pending</a></div><div class="ttdeci">size_t pn_delivery_pending(pn_delivery_t *delivery)</div><div class="ttdoc">Get the amount of pending message data for a delivery.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga085159cb4136f84a02777bcc72c73fa3"><div class="ttname"><a href="group__delivery.html#ga085159cb4136f84a02777bcc72c73fa3">pn_delivery_tag_t</a></div><div class="ttdeci">pn_bytes_t pn_delivery_tag_t</div><div class="ttdoc">An AMQP delivery tag.</div><div class="ttdef"><b>Definition:</b> delivery.h:46</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga3e014fc1759a212bc3ee9e513a274331"><div class="ttname"><a href="group__delivery.html#ga3e014fc1759a212bc3ee9e513a274331">pn_delivery_attachments</a></div><div class="ttdeci">pn_record_t * pn_delivery_attachments(pn_delivery_t *delivery)</div><div class="ttdoc">Get the attachments that are associated with a delivery object.</div></div> |
| <div class="ttc" id="adisposition_8h_html"><div class="ttname"><a href="disposition_8h.html">disposition.h</a></div><div class="ttdoc">A delivery state.</div></div> |
| <div class="ttc" id="agroup__delivery_html_ga91519d3e4568ee8b622d3653e20f60a6"><div class="ttname"><a href="group__delivery.html#ga91519d3e4568ee8b622d3653e20f60a6">pn_delivery_set_context</a></div><div class="ttdeci">void pn_delivery_set_context(pn_delivery_t *delivery, void *context)</div><div class="ttdoc">Set a new application context for a delivery object.</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="delivery_8h.html">delivery.h</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
