blob: 5bf7d7d1124ccb4329a02d406be1a5042d884b81 [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.TransportOptions 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_1TransportOptions.html">TransportOptions</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_1TransportOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.TransportOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options that control the I/O level transport configuration.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#details">More...</a></p>
<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:a98a8c0eccfdf156a8c7928277a3de83e"><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_1TransportOptions.html#a98a8c0eccfdf156a8c7928277a3de83e">TransportOptions</a> ()</td></tr>
<tr class="memdesc:a98a8c0eccfdf156a8c7928277a3de83e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default transport options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a98a8c0eccfdf156a8c7928277a3de83e">More...</a><br /></td></tr>
<tr class="separator:a98a8c0eccfdf156a8c7928277a3de83e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace3774df855f60bc921f5dd85de81ec7"><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_1TransportOptions.html#ace3774df855f60bc921f5dd85de81ec7">TransportOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html">TransportOptions</a> other)</td></tr>
<tr class="memdesc:ace3774df855f60bc921f5dd85de81ec7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a transport options instance that copies the configuration from the given instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#ace3774df855f60bc921f5dd85de81ec7">More...</a><br /></td></tr>
<tr class="separator:ace3774df855f60bc921f5dd85de81ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3483cb8cd947f150a99882c9c5e630f"><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_1TransportOptions.html#af3483cb8cd947f150a99882c9c5e630f">Clone</a> ()</td></tr>
<tr class="memdesc:af3483cb8cd947f150a99882c9c5e630f"><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_1TransportOptions.html#af3483cb8cd947f150a99882c9c5e630f">More...</a><br /></td></tr>
<tr class="separator:af3483cb8cd947f150a99882c9c5e630f"><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:a944175daf14d06f2b43201efd09ad67a"><td class="memItemLeft" align="right" valign="top"><a id="a944175daf14d06f2b43201efd09ad67a"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_SEND_BUFFER_SIZE</b> = 64 * 1024</td></tr>
<tr class="separator:a944175daf14d06f2b43201efd09ad67a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae313a0bfcbf585a2b1761d207def2887"><td class="memItemLeft" align="right" valign="top"><a id="ae313a0bfcbf585a2b1761d207def2887"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_RECEIVE_BUFFER_SIZE</b> = DEFAULT_SEND_BUFFER_SIZE</td></tr>
<tr class="separator:ae313a0bfcbf585a2b1761d207def2887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e06f7d2f877950db0bfbda4967aba1d"><td class="memItemLeft" align="right" valign="top"><a id="a3e06f7d2f877950db0bfbda4967aba1d"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_TCP_NO_DELAY</b> = true</td></tr>
<tr class="separator:a3e06f7d2f877950db0bfbda4967aba1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe3635b0bb72eca1e49a73c2ff45ae62"><td class="memItemLeft" align="right" valign="top"><a id="abe3635b0bb72eca1e49a73c2ff45ae62"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_TCP_KEEP_ALIVE</b> = false</td></tr>
<tr class="separator:abe3635b0bb72eca1e49a73c2ff45ae62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae918cb0362a9fd4e582b56c6c85b8586"><td class="memItemLeft" align="right" valign="top"><a id="ae918cb0362a9fd4e582b56c6c85b8586"></a>
static readonly uint&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_SO_LINGER</b> = uint.MinValue</td></tr>
<tr class="separator:ae918cb0362a9fd4e582b56c6c85b8586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2459dff6ffdae038c3cb32865cafb383"><td class="memItemLeft" align="right" valign="top"><a id="a2459dff6ffdae038c3cb32865cafb383"></a>
static readonly uint&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_SO_TIMEOUT</b> = 0</td></tr>
<tr class="separator:a2459dff6ffdae038c3cb32865cafb383"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62c992680078538946f14eabec23196"><td class="memItemLeft" align="right" valign="top"><a id="ab62c992680078538946f14eabec23196"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_TCP_PORT</b> = 5672</td></tr>
<tr class="separator:ab62c992680078538946f14eabec23196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a365b93fdccce7e78135ad5d0fb4e529c"><td class="memItemLeft" align="right" valign="top"><a id="a365b93fdccce7e78135ad5d0fb4e529c"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_LOCAL_PORT</b> = 0</td></tr>
<tr class="separator:a365b93fdccce7e78135ad5d0fb4e529c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb4f7c138473d287f4840fbc207c2728"><td class="memItemLeft" align="right" valign="top"><a id="afb4f7c138473d287f4840fbc207c2728"></a>
static readonly int&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_WEBSOCKET_MAX_FRAME_SIZE</b> = 65535</td></tr>
<tr class="separator:afb4f7c138473d287f4840fbc207c2728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa794828cd292496771385636183b1f26"><td class="memItemLeft" align="right" valign="top"><a id="aa794828cd292496771385636183b1f26"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_TRACE_BYTES</b> = false</td></tr>
<tr class="separator:aa794828cd292496771385636183b1f26"><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:a082820c5ae43c4114f7e237c0127fff0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a082820c5ae43c4114f7e237c0127fff0">DefaultTcpPort</a> = DEFAULT_TCP_PORT<code> [get, set]</code></td></tr>
<tr class="memdesc:a082820c5ae43c4114f7e237c0127fff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the default TCP port that all client connections should use if none is provided in the connect call. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a082820c5ae43c4114f7e237c0127fff0">More...</a><br /></td></tr>
<tr class="separator:a082820c5ae43c4114f7e237c0127fff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeeaf01c243b545b5f16c4d38eab9b606"><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_1TransportOptions.html#aeeaf01c243b545b5f16c4d38eab9b606">LocalAddress</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aeeaf01c243b545b5f16c4d38eab9b606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigned local address that the client should bind to when creating a connection to the remote. The user is responsible for ensuring this local address is free and can be bound to otherwise an error will be thrown on connect. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#aeeaf01c243b545b5f16c4d38eab9b606">More...</a><br /></td></tr>
<tr class="separator:aeeaf01c243b545b5f16c4d38eab9b606"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2146ad8a376ce4bbe64398907f860f1f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a2146ad8a376ce4bbe64398907f860f1f">LocalPort</a> = DEFAULT_LOCAL_PORT<code> [get, set]</code></td></tr>
<tr class="memdesc:a2146ad8a376ce4bbe64398907f860f1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigned local port that the connection should bind to when attempting to connect to the remote. The user is responsible for ensuring this local port is free otherwise an error will be thrown on connect. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a2146ad8a376ce4bbe64398907f860f1f">More...</a><br /></td></tr>
<tr class="separator:a2146ad8a376ce4bbe64398907f860f1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72f6933500f258d337f0ce6789f49041"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a72f6933500f258d337f0ce6789f49041">TraceBytes</a> = DEFAULT_TRACE_BYTES<code> [get, set]</code></td></tr>
<tr class="memdesc:a72f6933500f258d337f0ce6789f49041"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures whether the IO layer should write the incoming and outgoing bytes to the logging framework. By default this option is configured to not trace the bytes as this is a high impact operation and will result in a large amount of additional logging noise. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a72f6933500f258d337f0ce6789f49041">More...</a><br /></td></tr>
<tr class="separator:a72f6933500f258d337f0ce6789f49041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2142e866a8bb1324b9c4acc407545c61"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a2142e866a8bb1324b9c4acc407545c61">TcpNoDelay</a> = DEFAULT_TCP_NO_DELAY<code> [get, set]</code></td></tr>
<tr class="memdesc:a2142e866a8bb1324b9c4acc407545c61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures whether the TCP_NO_DELAY options is set on the created TCP connection (defaults to true). <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a2142e866a8bb1324b9c4acc407545c61">More...</a><br /></td></tr>
<tr class="separator:a2142e866a8bb1324b9c4acc407545c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa64b56b20460ee0492bb972fc98ef25e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#aa64b56b20460ee0492bb972fc98ef25e">SendBufferSize</a> = DEFAULT_SEND_BUFFER_SIZE<code> [get, set]</code></td></tr>
<tr class="memdesc:aa64b56b20460ee0492bb972fc98ef25e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the send buffer size for the underlying transport. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#aa64b56b20460ee0492bb972fc98ef25e">More...</a><br /></td></tr>
<tr class="separator:aa64b56b20460ee0492bb972fc98ef25e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4071435c387206afca2cf7d1435cccf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#ac4071435c387206afca2cf7d1435cccf">ReceiveBufferSize</a> = DEFAULT_RECEIVE_BUFFER_SIZE<code> [get, set]</code></td></tr>
<tr class="memdesc:ac4071435c387206afca2cf7d1435cccf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the receive buffer size for the underlying transport. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#ac4071435c387206afca2cf7d1435cccf">More...</a><br /></td></tr>
<tr class="separator:ac4071435c387206afca2cf7d1435cccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ea0672e523301de6a68fc4ed187cc00"><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_1TransportOptions.html#a1ea0672e523301de6a68fc4ed187cc00">SoLinger</a> = DEFAULT_SO_LINGER<code> [get, set]</code></td></tr>
<tr class="memdesc:a1ea0672e523301de6a68fc4ed187cc00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the linger value applied to the underlying transport which by default is disabled. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a1ea0672e523301de6a68fc4ed187cc00">More...</a><br /></td></tr>
<tr class="separator:a1ea0672e523301de6a68fc4ed187cc00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6bc0f49e388fecc98cf44e8b5a2773f"><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_1TransportOptions.html#ac6bc0f49e388fecc98cf44e8b5a2773f">SendTimeout</a> = DEFAULT_SO_TIMEOUT<code> [get, set]</code></td></tr>
<tr class="memdesc:ac6bc0f49e388fecc98cf44e8b5a2773f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the transport level send timeout value which by default is set to infinite wait. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#ac6bc0f49e388fecc98cf44e8b5a2773f">More...</a><br /></td></tr>
<tr class="separator:ac6bc0f49e388fecc98cf44e8b5a2773f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a900afcc627ff583a51a909c33c4b344a"><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_1TransportOptions.html#a900afcc627ff583a51a909c33c4b344a">ReceiveTimeout</a> = DEFAULT_SO_TIMEOUT<code> [get, set]</code></td></tr>
<tr class="memdesc:a900afcc627ff583a51a909c33c4b344a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the transport level receive timeout value which by default is set to infinite wait. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#a900afcc627ff583a51a909c33c4b344a">More...</a><br /></td></tr>
<tr class="separator:a900afcc627ff583a51a909c33c4b344a"><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>Options that control the I/O level transport configuration. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a98a8c0eccfdf156a8c7928277a3de83e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98a8c0eccfdf156a8c7928277a3de83e">&#9670;&nbsp;</a></span>TransportOptions() <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.TransportOptions.TransportOptions </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 transport options instance. </p>
</div>
</div>
<a id="ace3774df855f60bc921f5dd85de81ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace3774df855f60bc921f5dd85de81ec7">&#9670;&nbsp;</a></span>TransportOptions() <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.TransportOptions.TransportOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html">TransportOptions</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 transport options instance that copies the configuration from the given instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The target options instance to copy</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af3483cb8cd947f150a99882c9c5e630f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3483cb8cd947f150a99882c9c5e630f">&#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.TransportOptions.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="a082820c5ae43c4114f7e237c0127fff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a082820c5ae43c4114f7e237c0127fff0">&#9670;&nbsp;</a></span>DefaultTcpPort</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.TransportOptions.DefaultTcpPort = DEFAULT_TCP_PORT</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 default TCP port that all client connections should use if none is provided in the connect call. </p>
</div>
</div>
<a id="aeeaf01c243b545b5f16c4d38eab9b606"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeeaf01c243b545b5f16c4d38eab9b606">&#9670;&nbsp;</a></span>LocalAddress</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.TransportOptions.LocalAddress</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>Assigned local address that the client should bind to when creating a connection to the remote. The user is responsible for ensuring this local address is free and can be bound to otherwise an error will be thrown on connect. </p>
</div>
</div>
<a id="a2146ad8a376ce4bbe64398907f860f1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2146ad8a376ce4bbe64398907f860f1f">&#9670;&nbsp;</a></span>LocalPort</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.TransportOptions.LocalPort = DEFAULT_LOCAL_PORT</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>Assigned local port that the connection should bind to when attempting to connect to the remote. The user is responsible for ensuring this local port is free otherwise an error will be thrown on connect. </p>
</div>
</div>
<a id="ac4071435c387206afca2cf7d1435cccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4071435c387206afca2cf7d1435cccf">&#9670;&nbsp;</a></span>ReceiveBufferSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.TransportOptions.ReceiveBufferSize = DEFAULT_RECEIVE_BUFFER_SIZE</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 receive buffer size for the underlying transport. </p>
</div>
</div>
<a id="a900afcc627ff583a51a909c33c4b344a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a900afcc627ff583a51a909c33c4b344a">&#9670;&nbsp;</a></span>ReceiveTimeout</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.TransportOptions.ReceiveTimeout = DEFAULT_SO_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>Configures the transport level receive timeout value which by default is set to infinite wait. </p>
</div>
</div>
<a id="aa64b56b20460ee0492bb972fc98ef25e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa64b56b20460ee0492bb972fc98ef25e">&#9670;&nbsp;</a></span>SendBufferSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.TransportOptions.SendBufferSize = DEFAULT_SEND_BUFFER_SIZE</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 send buffer size for the underlying transport. </p>
</div>
</div>
<a id="ac6bc0f49e388fecc98cf44e8b5a2773f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6bc0f49e388fecc98cf44e8b5a2773f">&#9670;&nbsp;</a></span>SendTimeout</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.TransportOptions.SendTimeout = DEFAULT_SO_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>Configures the transport level send timeout value which by default is set to infinite wait. </p>
</div>
</div>
<a id="a1ea0672e523301de6a68fc4ed187cc00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ea0672e523301de6a68fc4ed187cc00">&#9670;&nbsp;</a></span>SoLinger</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.TransportOptions.SoLinger = DEFAULT_SO_LINGER</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 linger value applied to the underlying transport which by default is disabled. </p>
</div>
</div>
<a id="a2142e866a8bb1324b9c4acc407545c61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2142e866a8bb1324b9c4acc407545c61">&#9670;&nbsp;</a></span>TcpNoDelay</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Client.TransportOptions.TcpNoDelay = DEFAULT_TCP_NO_DELAY</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 whether the TCP_NO_DELAY options is set on the created TCP connection (defaults to true). </p>
</div>
</div>
<a id="a72f6933500f258d337f0ce6789f49041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72f6933500f258d337f0ce6789f49041">&#9670;&nbsp;</a></span>TraceBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Client.TransportOptions.TraceBytes = DEFAULT_TRACE_BYTES</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 whether the IO layer should write the incoming and outgoing bytes to the logging framework. By default this option is configured to not trace the bytes as this is a high impact operation and will result in a large amount of additional logging noise. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/TransportOptions.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>