| <!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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Types.IDeliveryTag Interface 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="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> |
| <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">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <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','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- 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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types.html">Types</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Types.IDeliveryTag Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A representation of the byte value that comprises the delivery tag that is assigned to the first transfer frame of each new delivery. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Types.IDeliveryTag:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.png" usemap="#Apache.Qpid.Proton.Types.IDeliveryTag_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Types.IDeliveryTag_map" name="Apache.Qpid.Proton.Types.IDeliveryTag_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html" title="A representation of the byte value that comprises the delivery tag that is assigned to the first tran..." alt="Apache.Qpid.Proton.Types.DeliveryTag" shape="rect" coords="126,112,368,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:a9f53a355a378332075c0c26282238e64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a9f53a355a378332075c0c26282238e64">Release</a> ()</td></tr> |
| <tr class="memdesc:a9f53a355a378332075c0c26282238e64"><td class="mdescLeft"> </td><td class="mdescRight">Optional method used by tag implementations that provide pooling of tags. Implementations can do nothing here if no release mechanics are needed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a9f53a355a378332075c0c26282238e64">More...</a><br /></td></tr> |
| <tr class="separator:a9f53a355a378332075c0c26282238e64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae92289b631ed88d80705c723ead177d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#ae92289b631ed88d80705c723ead177d2">WriteTo</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr> |
| <tr class="memdesc:ae92289b631ed88d80705c723ead177d2"><td class="mdescLeft"> </td><td class="mdescRight">Writes the tag as a sequence of bytes into the given buffer in the manner most efficient for the underlying <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html" title="A representation of the byte value that comprises the delivery tag that is assigned to the first tran...">IDeliveryTag</a> implementation. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#ae92289b631ed88d80705c723ead177d2">More...</a><br /></td></tr> |
| <tr class="separator:ae92289b631ed88d80705c723ead177d2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a7c7cb923e8dd67240454918f3995eb3a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a7c7cb923e8dd67240454918f3995eb3a">Length</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7c7cb923e8dd67240454918f3995eb3a"><td class="mdescLeft"> </td><td class="mdescRight">The number of bytes that comprise the delivery tag body <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a7c7cb923e8dd67240454918f3995eb3a">More...</a><br /></td></tr> |
| <tr class="separator:a7c7cb923e8dd67240454918f3995eb3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54a1179c018ade2a4edf3335ea05601c"><td class="memItemLeft" align="right" valign="top">byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a54a1179c018ade2a4edf3335ea05601c">TagBytes</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a54a1179c018ade2a4edf3335ea05601c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of this <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html">DeliveryTag</a> object as a byte array. The returned array may be the actual underlying tag bytes or a synthetic view based on the value used to generate the tag. It is advised not to modify the returned value and copy if such modification are necessary to the caller. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a54a1179c018ade2a4edf3335ea05601c">More...</a><br /></td></tr> |
| <tr class="separator:a54a1179c018ade2a4edf3335ea05601c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeae174d2c484b269b307f4953abed375"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#aeae174d2c484b269b307f4953abed375">TagBuffer</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aeae174d2c484b269b307f4953abed375"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of this <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html" title="A representation of the byte value that comprises the delivery tag that is assigned to the first tran...">IDeliveryTag</a>} object as a IProtonBuffer. The returned array may be the actual underlying tag bytes or a synthetic view based on the value used to generate the tag. It is advised not to modify the returned value and copy if such modification are necessary to the caller. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#aeae174d2c484b269b307f4953abed375">More...</a><br /></td></tr> |
| <tr class="separator:aeae174d2c484b269b307f4953abed375"><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 representation of the byte value that comprises the delivery tag that is assigned to the first transfer frame of each new delivery. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9f53a355a378332075c0c26282238e64"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9f53a355a378332075c0c26282238e64">◆ </a></span>Release()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Types.IDeliveryTag.Release </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Optional method used by tag implementations that provide pooling of tags. Implementations can do nothing here if no release mechanics are needed. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#ab2658d93b472e7159602e80eb315ed70">Apache.Qpid.Proton.Types.DeliveryTag</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae92289b631ed88d80705c723ead177d2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae92289b631ed88d80705c723ead177d2">◆ </a></span>WriteTo()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Types.IDeliveryTag.WriteTo </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Writes the tag as a sequence of bytes into the given buffer in the manner most efficient for the underlying <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html" title="A representation of the byte value that comprises the delivery tag that is assigned to the first tran...">IDeliveryTag</a> implementation. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#a6ff76791086570ed39cc88c3d49dab9e">Apache.Qpid.Proton.Types.DeliveryTag</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a7c7cb923e8dd67240454918f3995eb3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7c7cb923e8dd67240454918f3995eb3a">◆ </a></span>Length</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Types.IDeliveryTag.Length</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The number of bytes that comprise the delivery tag body </p> |
| |
| </div> |
| </div> |
| <a id="aeae174d2c484b269b307f4953abed375"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeae174d2c484b269b307f4953abed375">◆ </a></span>TagBuffer</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> Apache.Qpid.Proton.Types.IDeliveryTag.TagBuffer</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a view of this <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html" title="A representation of the byte value that comprises the delivery tag that is assigned to the first tran...">IDeliveryTag</a>} object as a IProtonBuffer. The returned array may be the actual underlying tag bytes or a synthetic view based on the value used to generate the tag. It is advised not to modify the returned value and copy if such modification are necessary to the caller. </p> |
| |
| </div> |
| </div> |
| <a id="a54a1179c018ade2a4edf3335ea05601c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a54a1179c018ade2a4edf3335ea05601c">◆ </a></span>TagBytes</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">byte [] Apache.Qpid.Proton.Types.IDeliveryTag.TagBytes</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a view of this <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html">DeliveryTag</a> object as a byte array. The returned array may be the actual underlying tag bytes or a synthetic view based on the value used to generate the tag. It is advised not to modify the returned value and copy if such modification are necessary to the caller. </p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Types/IDeliveryTag.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |