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_1Client_1_1ClientOptions.html
blob: 3aa8b52d55f647014eb67eb9b09f15b880bb9a7d [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.ClientOptions 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_1ClientOptions.html">ClientOptions</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_1Client_1_1ClientOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.ClientOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.ClientOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.png" alt=""/>
</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:a7806a6ac494ede06d14fca7d1515f56a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#a7806a6ac494ede06d14fca7d1515f56a">ClientOptions</a> ()</td></tr>
<tr class="memdesc:a7806a6ac494ede06d14fca7d1515f56a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#a7806a6ac494ede06d14fca7d1515f56a">More...</a><br /></td></tr>
<tr class="separator:a7806a6ac494ede06d14fca7d1515f56a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad56ab19cdf962b8da188f572481eb561"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#ad56ab19cdf962b8da188f572481eb561">ClientOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html">ClientOptions</a> other)</td></tr>
<tr class="memdesc:ad56ab19cdf962b8da188f572481eb561"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#ad56ab19cdf962b8da188f572481eb561">More...</a><br /></td></tr>
<tr class="separator:ad56ab19cdf962b8da188f572481eb561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87fc8da655e287a16515e16e779b532a"><td class="memItemLeft" align="right" valign="top">object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#a87fc8da655e287a16515e16e779b532a">Clone</a> ()</td></tr>
<tr class="memdesc:a87fc8da655e287a16515e16e779b532a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone this options instance, changes to the cloned options are not reflected in this options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#a87fc8da655e287a16515e16e779b532a">More...</a><br /></td></tr>
<tr class="separator:a87fc8da655e287a16515e16e779b532a"><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:af5cd065a359a9eb5b7de2cb87f77d35b"><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_1ClientOptions.html#af5cd065a359a9eb5b7de2cb87f77d35b">Id</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af5cd065a359a9eb5b7de2cb87f77d35b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the Container Id that is set on new Connections created from a <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> instance that was created with these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html#af5cd065a359a9eb5b7de2cb87f77d35b">More...</a><br /></td></tr>
<tr class="separator:af5cd065a359a9eb5b7de2cb87f77d35b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7806a6ac494ede06d14fca7d1515f56a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7806a6ac494ede06d14fca7d1515f56a">&#9670;&nbsp;</a></span>ClientOptions() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.ClientOptions.ClientOptions </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>Creates a default <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> options instance. </p>
</div>
</div>
<a id="ad56ab19cdf962b8da188f572481eb561"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad56ab19cdf962b8da188f572481eb561">&#9670;&nbsp;</a></span>ClientOptions() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.ClientOptions.ClientOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html">ClientOptions</a>&#160;</td>
<td class="paramname"><em>other</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>Create a new <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> options instance whose settings are copied from the instance provided. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> options instance to copy</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a87fc8da655e287a16515e16e779b532a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87fc8da655e287a16515e16e779b532a">&#9670;&nbsp;</a></span>Clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">object Apache.Qpid.Proton.Client.ClientOptions.Clone </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>Clone this options instance, changes to the cloned options are not reflected in this options instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A deep copy of this options instance.</dd></dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="af5cd065a359a9eb5b7de2cb87f77d35b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5cd065a359a9eb5b7de2cb87f77d35b">&#9670;&nbsp;</a></span>Id</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.ClientOptions.Id</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>Configure the Container Id that is set on new Connections created from a <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> instance that was created with these options. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/ClientOptions.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>