blob: 47c2e11603e56efd9b1e5b54b1c33a3b30896f6a [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.Client.Utilities.IdGenerator 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_1Client.html">Client</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities.html">Utilities</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator.html">IdGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.Utilities.IdGenerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a1688dff1faefbc5cf25e74c6664626cb"><td class="memItemLeft" align="right" valign="top"><a id="a1688dff1faefbc5cf25e74c6664626cb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>IdGenerator</b> (string prefix)</td></tr>
<tr class="separator:a1688dff1faefbc5cf25e74c6664626cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386884a32e5eb013e0506cabb50b7cb9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator.html#a386884a32e5eb013e0506cabb50b7cb9">GenerateId</a> ()</td></tr>
<tr class="memdesc:a386884a32e5eb013e0506cabb50b7cb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and returns a new unique Id value from this generator using the configure prefix value for the returned Id. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator.html#a386884a32e5eb013e0506cabb50b7cb9">More...</a><br /></td></tr>
<tr class="separator:a386884a32e5eb013e0506cabb50b7cb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a74d029364148df939b362aeaecc8456d"><td class="memItemLeft" align="right" valign="top"><a id="a74d029364148df939b362aeaecc8456d"></a>
static readonly string&#160;</td><td class="memItemRight" valign="bottom"><b>DefaultPrefix</b> = &quot;ID:&quot;</td></tr>
<tr class="separator:a74d029364148df939b362aeaecc8456d"><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:adb42f1d27baef637ca3761240df7fa93"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator.html#adb42f1d27baef637ca3761240df7fa93">Prefix</a> = DefaultPrefix<code> [get, set]</code></td></tr>
<tr class="memdesc:adb42f1d27baef637ca3761240df7fa93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the Prefix value that is used when creating new Ids from this generator <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IdGenerator.html#adb42f1d27baef637ca3761240df7fa93">More...</a><br /></td></tr>
<tr class="separator:adb42f1d27baef637ca3761240df7fa93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a386884a32e5eb013e0506cabb50b7cb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a386884a32e5eb013e0506cabb50b7cb9">&#9670;&nbsp;</a></span>GenerateId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Client.Utilities.IdGenerator.GenerateId </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>Create and returns a new unique Id value from this generator using the configure prefix value for the returned Id. </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="adb42f1d27baef637ca3761240df7fa93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb42f1d27baef637ca3761240df7fa93">&#9670;&nbsp;</a></span>Prefix</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Client.Utilities.IdGenerator.Prefix = DefaultPrefix</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the Prefix value that is used when creating new Ids from this generator </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/Utilities/IdGenerator.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>