Google Git
Sign in
apache / qpid-site / 0df3b3c248dc4df16a17888284695afd7eb8eee2 / . / content / releases / qpid-protonj2-1.0.0-M19 / api / org / apache / qpid / protonj2 / client / transport / netty5 / TcpTransport.html
blob: 2d7b37b378203e60e3be8b3fff3b4db227fb35dd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TcpTransport (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.qpid.protonj2.client.transport.netty5, class: TcpTransport">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/TcpTransport.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&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="sub-nav-list">
<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>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client.transport.netty5</a></div>
<h1 title="Class TcpTransport" class="title">Class TcpTransport</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.qpid.protonj2.client.transport.netty5.TcpTransport</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">WebSocketTransport</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TcpTransport</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></span></div>
<div class="block">TCP based transport that uses Netty as the underlying IO layer.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="TcpTransport.NettyDefaultHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport.NettyDefaultHandler</a>&lt;<a href="TcpTransport.NettyDefaultHandler.html" title="type parameter in TcpTransport.NettyDefaultHandler">E</a>&gt;</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="TcpTransport.NettyTcpTransportHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport.NettyTcpTransportHandler</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected final io.netty5.bootstrap.Bootstrap</code></div>
<div class="col-second even-row-color"><code><a href="#bootstrap" class="member-name-link">bootstrap</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected io.netty5.channel.Channel</code></div>
<div class="col-second odd-row-color"><code><a href="#channel" class="member-name-link">channel</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a></code></div>
<div class="col-second even-row-color"><code><a href="#closed" class="member-name-link">closed</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a></code></div>
<div class="col-second odd-row-color"><code><a href="#connected" class="member-name-link">connected</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CountDownLatch.html" title="class or interface in java.util.concurrent" class="external-link">CountDownLatch</a></code></div>
<div class="col-second even-row-color"><code><a href="#connectedLatch" class="member-name-link">connectedLatch</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></div>
<div class="col-second odd-row-color"><code><a href="#failureCause" class="member-name-link">failureCause</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#host" class="member-name-link">host</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></code></div>
<div class="col-second odd-row-color"><code><a href="#listener" class="member-name-link">listener</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="../../../buffer/netty/Netty5ProtonBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer.netty">Netty5ProtonBufferAllocator</a></code></div>
<div class="col-second even-row-color"><code><a href="#nettyAllocator" class="member-name-link">nettyAllocator</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final <a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></div>
<div class="col-second odd-row-color"><code><a href="#options" class="member-name-link">options</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected int</code></div>
<div class="col-second even-row-color"><code><a href="#port" class="member-name-link">port</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div>
<div class="col-second odd-row-color"><code><a href="#sslOptions" class="member-name-link">sslOptions</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.netty5.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">TcpTransport</a><wbr>(io.netty5.bootstrap.Bootstrap&nbsp;bootstrap,
<a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;options,
<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;sslOptions)</code></div>
<div class="col-last even-row-color">
<div class="block">Create a new <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5"><code>TcpTransport</code></a> instance with the given configuration.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAdditionalHandlers(io.netty5.channel.ChannelPipeline)" class="member-name-link">addAdditionalHandlers</a><wbr>(io.netty5.channel.ChannelPipeline&nbsp;pipeline)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#awaitConnect()" class="member-name-link">awaitConnect</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Waits interruptibly for the <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> to connect to the remote that was
indicated in the <a href="../Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>Transport.connect(String, int, TransportListener)</code></a> call.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkConnected()" class="member-name-link">checkConnected</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Close the Transport, no additional send operations are accepted.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;host,
int&nbsp;port,
<a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a>&nbsp;listener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Performs the connect operation for the implemented Transport type such as
a TCP socket connection, SSL/TLS handshake etc.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.netty5.channel.ChannelHandler</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createChannelHandler()" class="member-name-link">createChannelHandler</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#flush()" class="member-name-link">flush</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Request a flush of all pending writes to the underlying connection.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferAllocator()" class="member-name-link">getBufferAllocator</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets a buffer allocator that can produce <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance that may be
optimized for use with the underlying transport implementation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHost()" class="member-name-link">getHost</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html" title="class or interface in java.security" class="external-link">Principal</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocalPrincipal()" class="member-name-link">getLocalPrincipal</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPort()" class="member-name-link">getPort</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemoteURI()" class="member-name-link">getRemoteURI</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a URI that contains some meaningful information about the remote connection such as a
scheme that reflects the transport type and the remote host and port that the connection was
instructed to connect to.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheme()" class="member-name-link">getScheme</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSslOptions()" class="member-name-link">getSslOptions</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTransportListener()" class="member-name-link">getTransportListener</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the currently set TransportListener instance</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTransportOptions()" class="member-name-link">getTransportOptions</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleConnected(io.netty5.channel.Channel)" class="member-name-link">handleConnected</a><wbr>(io.netty5.channel.Channel&nbsp;connectedChannel)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleTransportFailure(io.netty5.channel.Channel,java.lang.Throwable)" class="member-name-link">handleTransportFailure</a><wbr>(io.netty5.channel.Channel&nbsp;failedChannel,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;cause)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isConnected()" class="member-name-link">isConnected</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSecure()" class="member-name-link">isSecure</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">write</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Writes a chunk of data over the Transport connection without performing an
explicit flush on the transport.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)" class="member-name-link">write</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;onComplete)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Writes a chunk of data over the Transport connection without performing an
explicit flush on the transport.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">writeAndFlush</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Writes a chunk of data over the Transport connection and requests a flush of
all pending queued write operations</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)" class="member-name-link">writeAndFlush</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;onComplete)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Writes a chunk of data over the Transport connection and requests a flush of
all pending queued write operations</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">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" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="connected">
<h3>connected</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a></span>&nbsp;<span class="element-name">connected</span></div>
</section>
</li>
<li>
<section class="detail" id="closed">
<h3>closed</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicBoolean.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicBoolean</a></span>&nbsp;<span class="element-name">closed</span></div>
</section>
</li>
<li>
<section class="detail" id="connectedLatch">
<h3>connectedLatch</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CountDownLatch.html" title="class or interface in java.util.concurrent" class="external-link">CountDownLatch</a></span>&nbsp;<span class="element-name">connectedLatch</span></div>
</section>
</li>
<li>
<section class="detail" id="options">
<h3>options</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></span>&nbsp;<span class="element-name">options</span></div>
</section>
</li>
<li>
<section class="detail" id="sslOptions">
<h3>sslOptions</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span>&nbsp;<span class="element-name">sslOptions</span></div>
</section>
</li>
<li>
<section class="detail" id="bootstrap">
<h3>bootstrap</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">io.netty5.bootstrap.Bootstrap</span>&nbsp;<span class="element-name">bootstrap</span></div>
</section>
</li>
<li>
<section class="detail" id="channel">
<h3>channel</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">io.netty5.channel.Channel</span>&nbsp;<span class="element-name">channel</span></div>
</section>
</li>
<li>
<section class="detail" id="failureCause">
<h3>failureCause</h3>
<div class="member-signature"><span class="modifiers">protected volatile</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span>&nbsp;<span class="element-name">failureCause</span></div>
</section>
</li>
<li>
<section class="detail" id="host">
<h3>host</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">host</span></div>
</section>
</li>
<li>
<section class="detail" id="port">
<h3>port</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">port</span></div>
</section>
</li>
<li>
<section class="detail" id="listener">
<h3>listener</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></span>&nbsp;<span class="element-name">listener</span></div>
</section>
</li>
<li>
<section class="detail" id="nettyAllocator">
<h3>nettyAllocator</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../../../buffer/netty/Netty5ProtonBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer.netty">Netty5ProtonBufferAllocator</a></span>&nbsp;<span class="element-name">nettyAllocator</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(io.netty5.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)">
<h3>TcpTransport</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TcpTransport</span><wbr><span class="parameters">(io.netty5.bootstrap.Bootstrap&nbsp;bootstrap,
<a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;options,
<a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;sslOptions)</span></div>
<div class="block">Create a new <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5"><code>TcpTransport</code></a> instance with the given configuration.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>bootstrap</code> - the Netty <code>Bootstrap</code> that this transport's IO layer is bound to.</dd>
<dd><code>options</code> - the <a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> used to configure the socket connection.</dd>
<dd><code>sslOptions</code> - the <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> to use if the options indicate SSL is enabled.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">
<h3>connect</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;host,
int&nbsp;port,
<a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a>&nbsp;listener)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">Transport</a></code></span></div>
<div class="block">Performs the connect operation for the implemented Transport type such as
a TCP socket connection, SSL/TLS handshake etc. The connection operation
itself will be performed as an asynchronous operation with the success or
failure being communicated to the event point
<a href="../TransportListener.html#transportError(java.lang.Throwable)"><code>TransportListener.transportError(Throwable)</code></a>. If the users wishes
to perform a block on connect outcome the <a href="../Transport.html#awaitConnect()"><code>Transport.awaitConnect()</code></a> method
will wait for and or throw an error based on the connect outcome.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">connect</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Parameters:</dt>
<dd><code>host</code> - The remote host that this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> should attempt to connect to.</dd>
<dd><code>port</code> - The port on the remote host that this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> should attempt to bind to.</dd>
<dd><code>listener</code> - The <a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>TransportListener</code></a> that will handle <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> events.</dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs while attempting the connect.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="awaitConnect()">
<h3>awaitConnect</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">awaitConnect</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#awaitConnect()">Transport</a></code></span></div>
<div class="block">Waits interruptibly for the <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> to connect to the remote that was
indicated in the <a href="../Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>Transport.connect(String, int, TransportListener)</code></a> call.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#awaitConnect()">awaitConnect</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - If the wait mechanism was interrupted while waiting for a successful connect.</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> failed to connect or was closed before connected.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isConnected()">
<h3>isConnected</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isConnected</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#isConnected()">isConnected</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>true if transport is connected or false if the connection is down.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isSecure()">
<h3>isSecure</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSecure</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#isSecure()">isSecure</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>true if transport is connected using a secured channel (SSL).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHost()">
<h3>getHost</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getHost</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getHost()">getHost</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>the host name or IP address that the transport connects to.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPort()">
<h3>getPort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getPort</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getPort()">getPort</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>the port that the transport connects to.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#close()">Transport</a></code></span></div>
<div class="block">Close the Transport, no additional send operations are accepted.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs while closing the connection.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBufferAllocator()">
<h3>getBufferAllocator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></span>&nbsp;<span class="element-name">getBufferAllocator</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#getBufferAllocator()">Transport</a></code></span></div>
<div class="block">Gets a buffer allocator that can produce <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance that may be
optimized for use with the underlying transport implementation.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getBufferAllocator()">getBufferAllocator</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>a <a href="../../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBufferAllocator</code></a> that creates transport friendly buffers.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">
<h3>write</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">write</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">Transport</a></code></span></div>
<div class="block">Writes a chunk of data over the Transport connection without performing an
explicit flush on the transport.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">write</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Parameters:</dt>
<dd><code>output</code> - The buffer of data that is to be transmitted.</dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">
<h3>write</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">write</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;onComplete)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">Transport</a></code></span></div>
<div class="block">Writes a chunk of data over the Transport connection without performing an
explicit flush on the transport. This method allows for a completion callback
that is signaled when the actual low level IO operation is completed which could
be after this method has returned.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">write</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Parameters:</dt>
<dd><code>output</code> - The buffer of data that is to be transmitted.</dd>
<dd><code>onComplete</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> that is invoked when the IO operation completes successfully.</dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">
<h3>writeAndFlush</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">writeAndFlush</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">Transport</a></code></span></div>
<div class="block">Writes a chunk of data over the Transport connection and requests a flush of
all pending queued write operations</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeAndFlush</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Parameters:</dt>
<dd><code>output</code> - The buffer of data that is to be transmitted.</dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">
<h3>writeAndFlush</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">writeAndFlush</span><wbr><span class="parameters">(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;output,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;onComplete)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">Transport</a></code></span></div>
<div class="block">Writes a chunk of data over the Transport connection and requests a flush of
all pending queued write operations</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">writeAndFlush</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Parameters:</dt>
<dd><code>output</code> - The buffer of data that is to be transmitted.</dd>
<dd><code>onComplete</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> that is invoked when the IO operation completes successfully.</dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="flush()">
<h3>flush</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></span>&nbsp;<span class="element-name">flush</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#flush()">Transport</a></code></span></div>
<div class="block">Request a flush of all pending writes to the underlying connection.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#flush()">flush</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>this <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs during the flush operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTransportListener()">
<h3>getTransportListener</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></span>&nbsp;<span class="element-name">getTransportListener</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#getTransportListener()">Transport</a></code></span></div>
<div class="block">Gets the currently set TransportListener instance</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getTransportListener()">getTransportListener</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>the current TransportListener or null if none set.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTransportOptions()">
<h3>getTransportOptions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></span>&nbsp;<span class="element-name">getTransportOptions</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getTransportOptions()">getTransportOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>a <a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> instance copied from the immutable options given at create time..</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSslOptions()">
<h3>getSslOptions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span>&nbsp;<span class="element-name">getSslOptions</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getSslOptions()">getSslOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>a <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> instance copied from the immutable options given at create time..</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLocalPrincipal()">
<h3>getLocalPrincipal</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html" title="class or interface in java.security" class="external-link">Principal</a></span>&nbsp;<span class="element-name">getLocalPrincipal</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getLocalPrincipal()">getLocalPrincipal</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>the local principal for a Transport that is using a secure connection.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addAdditionalHandlers(io.netty5.channel.ChannelPipeline)">
<h3>addAdditionalHandlers</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addAdditionalHandlers</span><wbr><span class="parameters">(io.netty5.channel.ChannelPipeline&nbsp;pipeline)</span></div>
</section>
</li>
<li>
<section class="detail" id="createChannelHandler()">
<h3>createChannelHandler</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">io.netty5.channel.ChannelHandler</span>&nbsp;<span class="element-name">createChannelHandler</span>()</div>
</section>
</li>
<li>
<section class="detail" id="handleConnected(io.netty5.channel.Channel)">
<h3>handleConnected</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">handleConnected</span><wbr><span class="parameters">(io.netty5.channel.Channel&nbsp;connectedChannel)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="handleTransportFailure(io.netty5.channel.Channel,java.lang.Throwable)">
<h3>handleTransportFailure</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">handleTransportFailure</span><wbr><span class="parameters">(io.netty5.channel.Channel&nbsp;failedChannel,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;cause)</span></div>
</section>
</li>
<li>
<section class="detail" id="checkConnected()">
<h3>checkConnected</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">checkConnected</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRemoteURI()">
<h3>getRemoteURI</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getRemoteURI</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Transport.html#getRemoteURI()">Transport</a></code></span></div>
<div class="block">Returns a URI that contains some meaningful information about the remote connection such as a
scheme that reflects the transport type and the remote host and port that the connection was
instructed to connect to. If called before the <a href="../Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>Transport.connect(String, int, TransportListener)</code></a>
method this method returns <code>null</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Transport.html#getRemoteURI()">getRemoteURI</a></code>&nbsp;in interface&nbsp;<code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd>
<dt>Returns:</dt>
<dd>a URI that reflects a meaningful view of the <a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> remote connection details.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getScheme()">
<h3>getScheme</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getScheme</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>