Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html
blob: ad0a639b8cdd59cc6d8297815f51a11e44b7cd11 [file] [log] [blame]
<!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.DeliveryTag Class 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&amp;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&amp;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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html">DeliveryTag</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Types.DeliveryTag Class 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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Types.DeliveryTag:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.png" usemap="#Apache.Qpid.Proton.Types.DeliveryTag_map" alt=""/>
<map id="Apache.Qpid.Proton.Types.DeliveryTag_map" name="Apache.Qpid.Proton.Types.DeliveryTag_map">
<area 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..." alt="Apache.Qpid.Proton.Types.IDeliveryTag" shape="rect" coords="126,56,368,80"/>
</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:abf4767493ae3d884979c5af4935c1b40"><td class="memItemLeft" align="right" valign="top"><a id="abf4767493ae3d884979c5af4935c1b40"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeliveryTag</b> (byte[] tagBytes)</td></tr>
<tr class="separator:abf4767493ae3d884979c5af4935c1b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca6448455f7e6770d232ba31fca5515b"><td class="memItemLeft" align="right" valign="top"><a id="aca6448455f7e6770d232ba31fca5515b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeliveryTag</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> tagBuffer)</td></tr>
<tr class="separator:aca6448455f7e6770d232ba31fca5515b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f2b0e7a3459bd9ec830833743e6ac9c"><td class="memItemLeft" align="right" valign="top"><a id="a5f2b0e7a3459bd9ec830833743e6ac9c"></a>
object&#160;</td><td class="memItemRight" valign="bottom"><b>Clone</b> ()</td></tr>
<tr class="separator:a5f2b0e7a3459bd9ec830833743e6ac9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4993f166b414c018da4bc8eeb0be23e"><td class="memItemLeft" align="right" valign="top"><a id="ac4993f166b414c018da4bc8eeb0be23e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Equals</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a> other)</td></tr>
<tr class="separator:ac4993f166b414c018da4bc8eeb0be23e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2658d93b472e7159602e80eb315ed70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#ab2658d93b472e7159602e80eb315ed70">Release</a> ()</td></tr>
<tr class="memdesc:ab2658d93b472e7159602e80eb315ed70"><td class="mdescLeft">&#160;</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#ab2658d93b472e7159602e80eb315ed70">More...</a><br /></td></tr>
<tr class="separator:ab2658d93b472e7159602e80eb315ed70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ff76791086570ed39cc88c3d49dab9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#a6ff76791086570ed39cc88c3d49dab9e">WriteTo</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr>
<tr class="memdesc:a6ff76791086570ed39cc88c3d49dab9e"><td class="mdescLeft">&#160;</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1DeliveryTag.html#a6ff76791086570ed39cc88c3d49dab9e">More...</a><br /></td></tr>
<tr class="separator:a6ff76791086570ed39cc88c3d49dab9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe6f4b41ab21a3ffb8cd2c562ad5a559"><td class="memItemLeft" align="right" valign="top"><a id="afe6f4b41ab21a3ffb8cd2c562ad5a559"></a>
override string&#160;</td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr>
<tr class="separator:afe6f4b41ab21a3ffb8cd2c562ad5a559"><td class="memSeparator" colspan="2">&#160;</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:a47e10c9175cb1cf1bf033828b105f686"><td class="memItemLeft" align="right" valign="top"><a id="a47e10c9175cb1cf1bf033828b105f686"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Length</b><code> [get]</code></td></tr>
<tr class="separator:a47e10c9175cb1cf1bf033828b105f686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a21b1360ae2cc1e4a740db181ac259e"><td class="memItemLeft" align="right" valign="top"><a id="a5a21b1360ae2cc1e4a740db181ac259e"></a>
byte[]&#160;</td><td class="memItemRight" valign="bottom"><b>TagBytes</b><code> [get]</code></td></tr>
<tr class="separator:a5a21b1360ae2cc1e4a740db181ac259e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22f1235290821d2845d477263908a88b"><td class="memItemLeft" align="right" valign="top"><a id="a22f1235290821d2845d477263908a88b"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><b>TagBuffer</b><code> [get]</code></td></tr>
<tr class="separator:a22f1235290821d2845d477263908a88b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">Apache.Qpid.Proton.Types.IDeliveryTag</a></td></tr>
<tr class="memitem:a7c7cb923e8dd67240454918f3995eb3a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memItemLeft" align="right" valign="top">int&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="mdescLeft">&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54a1179c018ade2a4edf3335ea05601c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memItemLeft" align="right" valign="top">byte[]&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="mdescLeft">&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeae174d2c484b269b307f4953abed375 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="mdescLeft">&#160;</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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag"><td class="memSeparator" colspan="2">&#160;</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="ab2658d93b472e7159602e80eb315ed70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2658d93b472e7159602e80eb315ed70">&#9670;&nbsp;</a></span>Release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Apache.Qpid.Proton.Types.DeliveryTag.Release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#a9f53a355a378332075c0c26282238e64">Apache.Qpid.Proton.Types.IDeliveryTag</a>.</p>
</div>
</div>
<a id="a6ff76791086570ed39cc88c3d49dab9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ff76791086570ed39cc88c3d49dab9e">&#9670;&nbsp;</a></span>WriteTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Apache.Qpid.Proton.Types.DeliveryTag.WriteTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html#ae92289b631ed88d80705c723ead177d2">Apache.Qpid.Proton.Types.IDeliveryTag</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Types/DeliveryTag.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>