blob: 937c1935dfe0d49bfda690f8a1d6e02fd7f562a8 [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.TerminusOptions 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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html">TerminusOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.TerminusOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base options type for the terminus configuration for Source and Target types that configure the nodes for Sender and Receiver links.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.TerminusOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.png" usemap="#Apache.Qpid.Proton.Client.TerminusOptions_map" alt=""/>
<map id="Apache.Qpid.Proton.Client.TerminusOptions_map" name="Apache.Qpid.Proton.Client.TerminusOptions_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html" title="Options used to configure the source when a terminus is being created." alt="Apache.Qpid.Proton.Client.SourceOptions" shape="rect" coords="0,56,262,80"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html" alt="Apache.Qpid.Proton.Client.TargetOptions" shape="rect" coords="272,56,534,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a79b7ccce2983a13897344f65ce6f0ee7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#abf270817f0631ad896871638bee2b287">DurabilityMode</a>?&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#a79b7ccce2983a13897344f65ce6f0ee7">DurabilityMode</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a79b7ccce2983a13897344f65ce6f0ee7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the Terminus durability mode. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#a79b7ccce2983a13897344f65ce6f0ee7">More...</a><br /></td></tr>
<tr class="separator:a79b7ccce2983a13897344f65ce6f0ee7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a178a4ac54f101b5fded6445da1d63179"><td class="memItemLeft" align="right" valign="top">uint?&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#a178a4ac54f101b5fded6445da1d63179">Timeout</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a178a4ac54f101b5fded6445da1d63179"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminus timeout configuration. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#a178a4ac54f101b5fded6445da1d63179">More...</a><br /></td></tr>
<tr class="separator:a178a4ac54f101b5fded6445da1d63179"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1f11c96c152a3851141859dbb0ef1c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8c">ExpiryPolicy</a>?&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#ae1f11c96c152a3851141859dbb0ef1c2">ExpiryPolicy</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ae1f11c96c152a3851141859dbb0ef1c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the expiry policy for the Terminus. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#ae1f11c96c152a3851141859dbb0ef1c2">More...</a><br /></td></tr>
<tr class="separator:ae1f11c96c152a3851141859dbb0ef1c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb3f69d50b4adb6d543e2170c2589430"><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_1TerminusOptions.html#afb3f69d50b4adb6d543e2170c2589430">Capabilities</a><code> [get, set]</code></td></tr>
<tr class="memdesc:afb3f69d50b4adb6d543e2170c2589430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capabilities that are assigned to the created Terminus <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#afb3f69d50b4adb6d543e2170c2589430">More...</a><br /></td></tr>
<tr class="separator:afb3f69d50b4adb6d543e2170c2589430"><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>Base options type for the terminus configuration for Source and Target types that configure the nodes for Sender and Receiver links. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="afb3f69d50b4adb6d543e2170c2589430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3f69d50b4adb6d543e2170c2589430">&#9670;&nbsp;</a></span>Capabilities</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.TerminusOptions.Capabilities</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>Capabilities that are assigned to the created Terminus </p>
</div>
</div>
<a id="a79b7ccce2983a13897344f65ce6f0ee7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79b7ccce2983a13897344f65ce6f0ee7">&#9670;&nbsp;</a></span>DurabilityMode</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="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#abf270817f0631ad896871638bee2b287">DurabilityMode</a>? Apache.Qpid.Proton.Client.TerminusOptions.DurabilityMode</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>Configures the Terminus durability mode. </p>
</div>
</div>
<a id="ae1f11c96c152a3851141859dbb0ef1c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1f11c96c152a3851141859dbb0ef1c2">&#9670;&nbsp;</a></span>ExpiryPolicy</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="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8c">ExpiryPolicy</a>? Apache.Qpid.Proton.Client.TerminusOptions.ExpiryPolicy</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>Configures the expiry policy for the Terminus. </p>
</div>
</div>
<a id="a178a4ac54f101b5fded6445da1d63179"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a178a4ac54f101b5fded6445da1d63179">&#9670;&nbsp;</a></span>Timeout</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint? Apache.Qpid.Proton.Client.TerminusOptions.Timeout</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>Terminus timeout configuration. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/TerminusOptions.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>