blob: 1208acdb83abc8b5d6c481c63e63eb60bda22db6 [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.Engine.IDeliveryTagGenerator 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&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_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.IDeliveryTagGenerator Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Delivery tag generators can be assigned to sender links in order to allow the link to automatically assign a transfer tag to each outbound delivery. Depending on the Sender different tag generators can operate in a fashion that is most efficient for that link such as caching tags for links that will produce a large number of messages to avoid GC overhead, while for other links simpler generator types could be used.
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.IDeliveryTagGenerator:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.png" usemap="#Apache.Qpid.Proton.Engine.IDeliveryTagGenerator_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.IDeliveryTagGenerator_map" name="Apache.Qpid.Proton.Engine.IDeliveryTagGenerator_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEmptyTagGenerator.html" title="Creates instance of delivery tags that have an empty byte buffer body" alt="Apache.Qpid.Proton.Engine.Implementation.ProtonEmptyTagGenerator" shape="rect" coords="0,56,434,80"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSequentialTagGenerator.html" title="A builtin proton delivery tag generator that creates tag values from an ever increasing sequence id v..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonSequentialTagGenerator" shape="rect" coords="444,56,878,80"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonUuidTagGenerator.html" title="A builtin proton delivery tag generator that creates tag value backed by a generated Uuid (Guid) inst..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonUuidTagGenerator" shape="rect" coords="888,56,1322,80"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonPooledTagGenerator.html" title="A builtin proton delivery tag generator that creates tag values from an ever increasing sequence id v..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonPooledTagGenerator" shape="rect" coords="444,112,878,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:a2a624daa6d4d5c4347caec21cbc9bbc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html#a2a624daa6d4d5c4347caec21cbc9bbc6">NextTag</a> ()</td></tr>
<tr class="memdesc:a2a624daa6d4d5c4347caec21cbc9bbc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns the next Delivery Tag that should be used when populating an outgoing delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html#a2a624daa6d4d5c4347caec21cbc9bbc6">More...</a><br /></td></tr>
<tr class="separator:a2a624daa6d4d5c4347caec21cbc9bbc6"><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>Delivery tag generators can be assigned to sender links in order to allow the link to automatically assign a transfer tag to each outbound delivery. Depending on the Sender different tag generators can operate in a fashion that is most efficient for that link such as caching tags for links that will produce a large number of messages to avoid GC overhead, while for other links simpler generator types could be used. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2a624daa6d4d5c4347caec21cbc9bbc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a624daa6d4d5c4347caec21cbc9bbc6">&#9670;&nbsp;</a></span>NextTag()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a> Apache.Qpid.Proton.Engine.IDeliveryTagGenerator.NextTag </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and returns the next Delivery Tag that should be used when populating an outgoing delivery. </p>
<dl class="section return"><dt>Returns</dt><dd>The next delivery tag for use when sending a delivery</dd></dl>
<p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonUuidTagGenerator.html#a485ee997c9ba983d80ad3a3df2962e69">Apache.Qpid.Proton.Engine.Implementation.ProtonUuidTagGenerator</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSequentialTagGenerator.html#a10c4ebcbf0124378562d2bf6596984e2">Apache.Qpid.Proton.Engine.Implementation.ProtonSequentialTagGenerator</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonPooledTagGenerator.html#aeaab62b22c3bf01e7b669ba48d58eadc">Apache.Qpid.Proton.Engine.Implementation.ProtonPooledTagGenerator</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEmptyTagGenerator.html#ac6d2a93757fe123cb358765c5002dc71">Apache.Qpid.Proton.Engine.Implementation.ProtonEmptyTagGenerator</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Engine/IDeliveryTagGenerator.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>