blob: e75c755e5308b4dec5fc08c33552a0a4278d4d17 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>TransportOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TransportOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TransportOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
<h2 title="Class TransportOptions" class="title">Class TransportOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.TransportOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TransportOptions</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre>
<div class="block">Encapsulates all the Transport options in one configuration object.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_ALLOW_NATIVE_IO">DEFAULT_ALLOW_NATIVE_IO</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONNECT_TIMEOUT">DEFAULT_CONNECT_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_LOCAL_PORT">DEFAULT_LOCAL_PORT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_NATIVEIO_PREFERENCES">DEFAULT_NATIVEIO_PREFERENCES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_RECEIVE_BUFFER_SIZE">DEFAULT_RECEIVE_BUFFER_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SEND_BUFFER_SIZE">DEFAULT_SEND_BUFFER_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SO_LINGER">DEFAULT_SO_LINGER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SO_TIMEOUT">DEFAULT_SO_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TCP_KEEP_ALIVE">DEFAULT_TCP_KEEP_ALIVE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TCP_NO_DELAY">DEFAULT_TCP_NO_DELAY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TCP_PORT">DEFAULT_TCP_PORT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TRACE_BYTES">DEFAULT_TRACE_BYTES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TRAFFIC_CLASS">DEFAULT_TRAFFIC_CLASS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_USE_WEBSOCKETS">DEFAULT_USE_WEBSOCKETS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_WEBSOCKET_MAX_FRAME_SIZE">DEFAULT_WEBSOCKET_MAX_FRAME_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">TransportOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addWebSocketHeader(java.lang.String,java.lang.String)">addWebSocketHeader</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Additional headers to be passed along to the remote when performing a WebSocket based connect.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowNativeIO()">allowNativeIO</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowNativeIO(boolean)">allowNativeIO</a></span>&#8203;(boolean&nbsp;allowNativeIO)</code></th>
<td class="colLast">
<div class="block">Determines if the a native IO implementation is preferred to the JDK based IO.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectTimeout()">connectTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectTimeout(int)">connectTimeout</a></span>&#8203;(int&nbsp;connectTimeout)</code></th>
<td class="colLast">
<div class="block">A transport layer connection timeout value that controls how long a connection attempt can block
before giving up and throwing a connection error.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.TransportOptions)">copyInto</a></span>&#8203;(<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all configuration into the given <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> from this instance.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultTcpPort()">defaultTcpPort</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultTcpPort(int)">defaultTcpPort</a></span>&#8203;(int&nbsp;defaultTcpPort)</code></th>
<td class="colLast">
<div class="block">The default unsecured connection port to use when none has been specified by the user.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localAddress()">localAddress</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localAddress(java.lang.String)">localAddress</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;localAddress)</code></th>
<td class="colLast">
<div class="block">The local address to bind to when attempting a remote connection.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localPort()">localPort</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localPort(int)">localPort</a></span>&#8203;(int&nbsp;localPort)</code></th>
<td class="colLast">
<div class="block">Configures the local port value to bind to when connecting to the remote, if that port is
already in use this can lead to a connection error.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nativeIOPreference()">nativeIOPreference</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nativeIOPreference(java.lang.String...)">nativeIOPreference</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;nativeIOPreference)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBufferSize()">receiveBufferSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBufferSize(int)">receiveBufferSize</a></span>&#8203;(int&nbsp;receiveBufferSize)</code></th>
<td class="colLast">
<div class="block">Sets the receive buffer size in bytes, the value must be greater than zero
or an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalArgumentException</code></a> will be thrown.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBufferSize()">sendBufferSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBufferSize(int)">sendBufferSize</a></span>&#8203;(int&nbsp;sendBufferSize)</code></th>
<td class="colLast">
<div class="block">Sets the send buffer size in bytes, the value must be greater than zero
or an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalArgumentException</code></a> will be thrown.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#soLinger()">soLinger</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#soLinger(int)">soLinger</a></span>&#8203;(int&nbsp;soLinger)</code></th>
<td class="colLast">
<div class="block">Configures the soLinger value that should be configured on the connection socket.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#soTimeout()">soTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#soTimeout(int)">soTimeout</a></span>&#8203;(int&nbsp;soTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the value to use when configuring the socket level soTimeout option.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tcpKeepAlive()">tcpKeepAlive</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tcpKeepAlive(boolean)">tcpKeepAlive</a></span>&#8203;(boolean&nbsp;keepAlive)</code></th>
<td class="colLast">
<div class="block">Configures the TCP socket keep-alive value that should be used for a connection.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tcpNoDelay()">tcpNoDelay</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tcpNoDelay(boolean)">tcpNoDelay</a></span>&#8203;(boolean&nbsp;tcpNoDelay)</code></th>
<td class="colLast">
<div class="block">Configure the underlying connection to use the tcpNoDelay option.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceBytes()">traceBytes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceBytes(boolean)">traceBytes</a></span>&#8203;(boolean&nbsp;traceBytes)</code></th>
<td class="colLast">
<div class="block">Determines if the transport should add a logger for bytes in / out</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trafficClass()">trafficClass</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trafficClass(int)">trafficClass</a></span>&#8203;(int&nbsp;trafficClass)</code></th>
<td class="colLast">
<div class="block">Sets the traffic class value used by the TCP connection, valid
range is between 0 and 255.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useWebSockets()">useWebSockets</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useWebSockets(boolean)">useWebSockets</a></span>&#8203;(boolean&nbsp;webSockets)</code></th>
<td class="colLast">
<div class="block">Set to true to configure the transport layer as a WebSocket based connection.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webSocketHeaders()">webSocketHeaders</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webSocketMaxFrameSize()">webSocketMaxFrameSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webSocketMaxFrameSize(int)">webSocketMaxFrameSize</a></span>&#8203;(int&nbsp;maxFrameSize)</code></th>
<td class="colLast">
<div class="block">Configures the maximum size of each WebSocket frame, payloads larger than the max frame size are
split into multiple frames during transmission.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webSocketPath()">webSocketPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webSocketPath(java.lang.String)">webSocketPath</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;webSocketPath)</code></th>
<td class="colLast">
<div class="block">The optional path element to provide when connecting via a WebSocket.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_SEND_BUFFER_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SEND_BUFFER_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_SEND_BUFFER_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_SEND_BUFFER_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_RECEIVE_BUFFER_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_RECEIVE_BUFFER_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_RECEIVE_BUFFER_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_RECEIVE_BUFFER_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TRAFFIC_CLASS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TRAFFIC_CLASS</h4>
<pre>public static final&nbsp;int DEFAULT_TRAFFIC_CLASS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_TRAFFIC_CLASS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TCP_NO_DELAY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TCP_NO_DELAY</h4>
<pre>public static final&nbsp;boolean DEFAULT_TCP_NO_DELAY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_TCP_NO_DELAY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TCP_KEEP_ALIVE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TCP_KEEP_ALIVE</h4>
<pre>public static final&nbsp;boolean DEFAULT_TCP_KEEP_ALIVE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_TCP_KEEP_ALIVE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_SO_LINGER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SO_LINGER</h4>
<pre>public static final&nbsp;int DEFAULT_SO_LINGER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_SO_LINGER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_SO_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SO_TIMEOUT</h4>
<pre>public static final&nbsp;int DEFAULT_SO_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_SO_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_CONNECT_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONNECT_TIMEOUT</h4>
<pre>public static final&nbsp;int DEFAULT_CONNECT_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_CONNECT_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TCP_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TCP_PORT</h4>
<pre>public static final&nbsp;int DEFAULT_TCP_PORT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_TCP_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_ALLOW_NATIVE_IO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_ALLOW_NATIVE_IO</h4>
<pre>public static final&nbsp;boolean DEFAULT_ALLOW_NATIVE_IO</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_ALLOW_NATIVE_IO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TRACE_BYTES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TRACE_BYTES</h4>
<pre>public static final&nbsp;boolean DEFAULT_TRACE_BYTES</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_TRACE_BYTES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_LOCAL_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_LOCAL_PORT</h4>
<pre>public static final&nbsp;int DEFAULT_LOCAL_PORT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_LOCAL_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_USE_WEBSOCKETS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_USE_WEBSOCKETS</h4>
<pre>public static final&nbsp;boolean DEFAULT_USE_WEBSOCKETS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_USE_WEBSOCKETS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_WEBSOCKET_MAX_FRAME_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WEBSOCKET_MAX_FRAME_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_WEBSOCKET_MAX_FRAME_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.TransportOptions.DEFAULT_WEBSOCKET_MAX_FRAME_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_NATIVEIO_PREFERENCES">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_NATIVEIO_PREFERENCES</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt; DEFAULT_NATIVEIO_PREFERENCES</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TransportOptions</h4>
<pre>public&nbsp;TransportOptions()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="sendBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendBufferSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;sendBufferSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently set send buffer size in bytes.</dd>
</dl>
</li>
</ul>
<a id="sendBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendBufferSize</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;sendBufferSize&#8203;(int&nbsp;sendBufferSize)</pre>
<div class="block">Sets the send buffer size in bytes, the value must be greater than zero
or an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalArgumentException</code></a> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sendBufferSize</code> - the new send buffer size for the TCP Transport.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the value given is not in the valid range.</dd>
</dl>
</li>
</ul>
<a id="receiveBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiveBufferSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;receiveBufferSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently configured receive buffer size in bytes.</dd>
</dl>
</li>
</ul>
<a id="receiveBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiveBufferSize</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;receiveBufferSize&#8203;(int&nbsp;receiveBufferSize)</pre>
<div class="block">Sets the receive buffer size in bytes, the value must be greater than zero
or an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalArgumentException</code></a> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>receiveBufferSize</code> - the new receive buffer size for the TCP Transport.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the value given is not in the valid range.</dd>
</dl>
</li>
</ul>
<a id="trafficClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trafficClass</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;trafficClass()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently configured traffic class value.</dd>
</dl>
</li>
</ul>
<a id="trafficClass(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trafficClass</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;trafficClass&#8203;(int&nbsp;trafficClass)</pre>
<div class="block">Sets the traffic class value used by the TCP connection, valid
range is between 0 and 255.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trafficClass</code> - the new traffic class value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this options instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the value given is not in the valid range.</dd>
</dl>
</li>
</ul>
<a id="soTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>soTimeout</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;soTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level soTimeout option.</dd>
</dl>
</li>
</ul>
<a id="soTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>soTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;soTimeout&#8203;(int&nbsp;soTimeout)</pre>
<div class="block">Sets the value to use when configuring the socket level soTimeout option.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>soTimeout</code> - the soTimeout value to configure on the newly create socket.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="tcpNoDelay()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tcpNoDelay</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;tcpNoDelay()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level tcpNoDelay option.</dd>
</dl>
</li>
</ul>
<a id="tcpNoDelay(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tcpNoDelay</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;tcpNoDelay&#8203;(boolean&nbsp;tcpNoDelay)</pre>
<div class="block">Configure the underlying connection to use the tcpNoDelay option.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tcpNoDelay</code> - controls if the underlying connection configures tcpNoDelay.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="soLinger()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>soLinger</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;soLinger()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level soLinger option.</dd>
</dl>
</li>
</ul>
<a id="soLinger(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>soLinger</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;soLinger&#8203;(int&nbsp;soLinger)</pre>
<div class="block">Configures the soLinger value that should be configured on the connection socket.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>soLinger</code> - The soLinger value to use for the underlying socket.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="tcpKeepAlive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tcpKeepAlive</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;tcpKeepAlive()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level tcpKeepAlive option.</dd>
</dl>
</li>
</ul>
<a id="tcpKeepAlive(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tcpKeepAlive</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;tcpKeepAlive&#8203;(boolean&nbsp;keepAlive)</pre>
<div class="block">Configures the TCP socket keep-alive value that should be used for a connection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keepAlive</code> - The TCP/IP keep-alive value to use for the connection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="connectTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectTimeout</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;connectTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level connection timeout option.</dd>
</dl>
</li>
</ul>
<a id="connectTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;connectTimeout&#8203;(int&nbsp;connectTimeout)</pre>
<div class="block">A transport layer connection timeout value that controls how long a connection attempt can block
before giving up and throwing a connection error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectTimeout</code> - connection timeout in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="defaultTcpPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultTcpPort</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;defaultTcpPort()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level default port to use for connection if none is provided.</dd>
</dl>
</li>
</ul>
<a id="defaultTcpPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultTcpPort</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;defaultTcpPort&#8203;(int&nbsp;defaultTcpPort)</pre>
<div class="block">The default unsecured connection port to use when none has been specified by the user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultTcpPort</code> - the default port to use for non-SSL connection if none provided.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="localAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localAddress</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;localAddress()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level localAddress option.</dd>
</dl>
</li>
</ul>
<a id="localAddress(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localAddress</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;localAddress&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;localAddress)</pre>
<div class="block">The local address to bind to when attempting a remote connection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localAddress</code> - the local address to bind to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="localPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localPort</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;localPort()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level localPort option.</dd>
</dl>
</li>
</ul>
<a id="localPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localPort</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;localPort&#8203;(int&nbsp;localPort)</pre>
<div class="block">Configures the local port value to bind to when connecting to the remote, if that port is
already in use this can lead to a connection error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localPort</code> - local port value to use when making a remote connection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="allowNativeIO()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowNativeIO</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;allowNativeIO()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if an native IO library can be used if available on this platform instead of the JDK IO.</dd>
</dl>
</li>
</ul>
<a id="allowNativeIO(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowNativeIO</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;allowNativeIO&#8203;(boolean&nbsp;allowNativeIO)</pre>
<div class="block">Determines if the a native IO implementation is preferred to the JDK based IO.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowNativeIO</code> - should use of available native transport be allowed if one is available.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="nativeIOPreference()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nativeIOPreference</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;nativeIOPreference()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the nativeIOPreference</dd>
</dl>
</li>
</ul>
<a id="nativeIOPreference(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nativeIOPreference</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;nativeIOPreference&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;nativeIOPreference)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nativeIOPreference</code> - the nativeIOPreference to set</dd>
</dl>
</li>
</ul>
<a id="traceBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traceBytes</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;traceBytes()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the transport should enable byte tracing</dd>
</dl>
</li>
</ul>
<a id="traceBytes(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traceBytes</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;traceBytes&#8203;(boolean&nbsp;traceBytes)</pre>
<div class="block">Determines if the transport should add a logger for bytes in / out</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>traceBytes</code> - should the transport log the bytes in and out.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="useWebSockets()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useWebSockets</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;useWebSockets()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured state of WebSockets for client connections.</dd>
</dl>
</li>
</ul>
<a id="useWebSockets(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useWebSockets</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;useWebSockets&#8203;(boolean&nbsp;webSockets)</pre>
<div class="block">Set to true to configure the transport layer as a WebSocket based connection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>webSockets</code> - should the transport attempt connection using a WebSocket.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="webSocketPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webSocketPath</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;webSocketPath()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level WebSocket path option.</dd>
</dl>
</li>
</ul>
<a id="webSocketPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webSocketPath</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;webSocketPath&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;webSocketPath)</pre>
<div class="block">The optional path element to provide when connecting via a WebSocket.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>webSocketPath</code> - path value to use for WebSocket connections.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="webSocketHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webSocketHeaders</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;webSocketHeaders()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level WebSocket Headers option.</dd>
</dl>
</li>
</ul>
<a id="addWebSocketHeader(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWebSocketHeader</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;addWebSocketHeader&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;value)</pre>
<div class="block">Additional headers to be passed along to the remote when performing a WebSocket based connect.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the header key to use with the provided value.</dd>
<dd><code>value</code> - the value to store under the provided key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="webSocketMaxFrameSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webSocketMaxFrameSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;webSocketMaxFrameSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured value for the socket level WebSocket max frame size option.</dd>
</dl>
</li>
</ul>
<a id="webSocketMaxFrameSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webSocketMaxFrameSize</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;webSocketMaxFrameSize&#8203;(int&nbsp;maxFrameSize)</pre>
<div class="block">Configures the maximum size of each WebSocket frame, payloads larger than the max frame size are
split into multiple frames during transmission.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxFrameSize</code> - the maximum WebSocket frame size before payloads are split.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="copyInto(org.apache.qpid.protonj2.client.TransportOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;copyInto&#8203;(<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;other)</pre>
<div class="block">Copy all configuration into the given <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> from this instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another <a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance that will receive the configuration from this instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the options instance that was copied into.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TransportOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>