| <!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: tracker</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('classproton_1_1tracker.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="#pub-methods">Public Member Functions</a> | |
| <a href="classproton_1_1tracker-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">tracker</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A tracker for a sent message. |
| <a href="classproton_1_1tracker.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="tracker_8hpp_source.html">tracker.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for tracker:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classproton_1_1tracker.png" usemap="#tracker_map" alt=""/> |
| <map id="tracker_map" name="tracker_map"> |
| <area href="classproton_1_1transfer.html" title="The base class for delivery and tracker." alt="transfer" shape="rect" coords="0,112,237,136"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0b9624867cb6a465a71ecf3bce1d64dd"><td class="memItemLeft" align="right" valign="top"><a id="a0b9624867cb6a465a71ecf3bce1d64dd"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1tracker.html#a0b9624867cb6a465a71ecf3bce1d64dd">tracker</a> ()</td></tr> |
| <tr class="memdesc:a0b9624867cb6a465a71ecf3bce1d64dd"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty tracker. <br /></td></tr> |
| <tr class="separator:a0b9624867cb6a465a71ecf3bce1d64dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6557049c84db2e028dce1b646d2e379"><td class="memItemLeft" align="right" valign="top"><a id="af6557049c84db2e028dce1b646d2e379"></a> |
| class <a class="el" href="classproton_1_1sender.html">sender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1tracker.html#af6557049c84db2e028dce1b646d2e379">sender</a> () const</td></tr> |
| <tr class="memdesc:af6557049c84db2e028dce1b646d2e379"><td class="mdescLeft"> </td><td class="mdescRight">Get the sender for this tracker. <br /></td></tr> |
| <tr class="separator:af6557049c84db2e028dce1b646d2e379"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classproton_1_1transfer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classproton_1_1transfer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classproton_1_1transfer.html">transfer</a></td></tr> |
| <tr class="memitem:a27689e22340a12302f25eec6072c5d22 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="a27689e22340a12302f25eec6072c5d22"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#a27689e22340a12302f25eec6072c5d22">transfer</a> ()</td></tr> |
| <tr class="memdesc:a27689e22340a12302f25eec6072c5d22 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty transfer. <br /></td></tr> |
| <tr class="separator:a27689e22340a12302f25eec6072c5d22 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8073c1382e7adf81536001a8007924a5 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="a8073c1382e7adf81536001a8007924a5"></a> |
| enum <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#a8073c1382e7adf81536001a8007924a5">state</a> () const</td></tr> |
| <tr class="memdesc:a8073c1382e7adf81536001a8007924a5 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote state for a delivery. <br /></td></tr> |
| <tr class="separator:a8073c1382e7adf81536001a8007924a5 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="ab55cf76248b8b6e571a869c407ba39e6"></a> |
| class <a class="el" href="classproton_1_1session.html">session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#ab55cf76248b8b6e571a869c407ba39e6">session</a> () const</td></tr> |
| <tr class="memdesc:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Return the session for this transfer. <br /></td></tr> |
| <tr class="separator:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="aff302bb6016f2ae29f01bb4e07389a52"></a> |
| class <a class="el" href="classproton_1_1connection.html">connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#aff302bb6016f2ae29f01bb4e07389a52">connection</a> () const</td></tr> |
| <tr class="memdesc:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Return the connection for this transfer. <br /></td></tr> |
| <tr class="separator:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="a7c755d6ac6385e007adb61966598ba63"></a> |
| class <a class="el" href="classproton_1_1work__queue.html">work_queue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#a7c755d6ac6385e007adb61966598ba63">work_queue</a> () const</td></tr> |
| <tr class="memdesc:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classproton_1_1work__queue.html" title="Unsettled API - A context for thread-safe execution of work.">work_queue</a> for the transfer. <br /></td></tr> |
| <tr class="separator:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="a2f632b80247e868b8264b8a025b84baf"></a> |
| class <a class="el" href="classproton_1_1container.html">container</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#a2f632b80247e868b8264b8a025b84baf">container</a> () const</td></tr> |
| <tr class="memdesc:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Return the container for this transfer. <br /></td></tr> |
| <tr class="separator:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a172df06404ec241cee5281536db603a7 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="a172df06404ec241cee5281536db603a7"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#a172df06404ec241cee5281536db603a7">settle</a> ()</td></tr> |
| <tr class="memdesc:a172df06404ec241cee5281536db603a7 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Settle the delivery; informs the remote end. <br /></td></tr> |
| <tr class="separator:a172df06404ec241cee5281536db603a7 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad72f81828cfabb957615d40cfdfed452 inherit pub_methods_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top"><a id="ad72f81828cfabb957615d40cfdfed452"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#ad72f81828cfabb957615d40cfdfed452">settled</a> () const</td></tr> |
| <tr class="memdesc:ad72f81828cfabb957615d40cfdfed452 inherit pub_methods_classproton_1_1transfer"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the transfer has been settled. <br /></td></tr> |
| <tr class="separator:ad72f81828cfabb957615d40cfdfed452 inherit pub_methods_classproton_1_1transfer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_types_classproton_1_1transfer"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classproton_1_1transfer')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classproton_1_1transfer.html">transfer</a></td></tr> |
| <tr class="memitem:adc6e5733fc3c22f0a7b2914188c49c90 inherit pub_types_classproton_1_1transfer"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90">state</a> { <br /> |
|   <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90ac157bdf0b85a40d2619cbc8bc1ae5fe2">NONE</a>, |
| <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90a1cf265da0334753368223d47f242a8df">RECEIVED</a>, |
| <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90a69c37229a15f9a89e188ad210f31c647">ACCEPTED</a>, |
| <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90adc7d25ac50cec5a18810f4e4f6614364">REJECTED</a>, |
| <br /> |
|   <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90aa38d18fe73a7fc82c112b6917d0b5cd0">RELEASED</a>, |
| <a class="el" href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90a26d303ed91d56d618217b9a038512754">MODIFIED</a> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:adc6e5733fc3c22f0a7b2914188c49c90"><td class="mdescLeft"> </td><td class="mdescRight">Delivery state values. <a href="classproton_1_1transfer.html#adc6e5733fc3c22f0a7b2914188c49c90">More...</a><br /></td></tr> |
| <tr class="separator:adc6e5733fc3c22f0a7b2914188c49c90 inherit pub_types_classproton_1_1transfer"><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 tracker for a sent message. </p> |
| <p>Every tracker exists within the context of a sender.</p> |
| <p>A delivery attempt can fail. As a result, a particular message may correspond to multiple trackers. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="direct_send_8cpp-example.html#_a15">direct_send.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a34">service_bus.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#_a18">simple_send.cpp</a>.</dd> |
| </dl> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="tracker_8hpp_source.html">tracker.hpp</a></li> |
| </ul> |
| </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="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1tracker.html">tracker</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> |
