| <!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/disposition.h File Reference</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('disposition_8h.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="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">disposition.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A delivery state. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <proton/import_export.h></code><br /> |
| <code>#include <proton/type_compat.h></code><br /> |
| <code>#include <<a class="el" href="condition_8h_source.html">proton/condition.h</a>></code><br /> |
| <code>#include <stddef.h></code><br /> |
| </div> |
| <p><a href="disposition_8h_source.html">Go to the source code of this file.</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"> |
| #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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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: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">A delivery state. <a href="group__delivery.html#ga4b28f6cd033babd8a7595fc5d292dca1">More...</a><br /></td></tr> |
| <tr class="separator:ga4b28f6cd033babd8a7595fc5d292dca1"><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: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="group__delivery.html#ga42387f728f4817fdd393cc98315db332">More...</a><br /></td></tr> |
| <tr class="separator:ga42387f728f4817fdd393cc98315db332"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga73aa02fe7f66d07514d4e5e1f74f8947"><td class="memItemLeft" align="right" valign="top"> |
| const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__delivery.html#ga73aa02fe7f66d07514d4e5e1f74f8947">pn_disposition_type_name</a> (uint64_t disposition_type)</td></tr> |
| <tr class="memdesc:ga73aa02fe7f66d07514d4e5e1f74f8947"><td class="mdescLeft"> </td><td class="mdescRight">Name of a disposition type for logging and debugging: "received", "accepted" etc. <br /></td></tr> |
| <tr class="separator:ga73aa02fe7f66d07514d4e5e1f74f8947"><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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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="group__delivery.html#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> |
| <div class="textblock"><p>A delivery state. </p> |
| </div></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- 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="disposition_8h.html">disposition.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> |
