Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / content / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / transport / WebSocketTransport.html
blob: 44af902cd5ad3d54cb8728cd8706a2f6a2ad1106 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>WebSocketTransport (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="WebSocketTransport (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};
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/WebSocketTransport.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><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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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.transport</a></div>
<h2 title="Class WebSocketTransport" class="title">Class WebSocketTransport</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><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">org.apache.qpid.protonj2.client.transport.TcpTransport</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.transport.WebSocketTransport</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketTransport</span>
extends <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></pre>
<div class="block">Netty based WebSockets Transport that wraps and extends the TCP Transport.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.qpid.protonj2.client.transport.TcpTransport">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.qpid.protonj2.client.transport.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></h3>
<code><a href="TcpTransport.NettyDefaultHandler.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport.NettyDefaultHandler</a>&lt;<a href="TcpTransport.NettyDefaultHandler.html" title="type parameter in TcpTransport.NettyDefaultHandler">E</a>&gt;, <a href="TcpTransport.NettyTcpTransportHandler.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport.NettyTcpTransportHandler</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.client.transport.TcpTransport">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.qpid.protonj2.client.transport.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></h3>
<code><a href="TcpTransport.html#bootstrap">bootstrap</a>, <a href="TcpTransport.html#channel">channel</a>, <a href="TcpTransport.html#closed">closed</a>, <a href="TcpTransport.html#connected">connected</a>, <a href="TcpTransport.html#connectedLatch">connectedLatch</a>, <a href="TcpTransport.html#failureCause">failureCause</a>, <a href="TcpTransport.html#host">host</a>, <a href="TcpTransport.html#listener">listener</a>, <a href="TcpTransport.html#options">options</a>, <a href="TcpTransport.html#port">port</a>, <a href="TcpTransport.html#sslOptions">sslOptions</a></code></li>
</ul>
</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(io.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)">WebSocketTransport</a></span>&#8203;(io.netty.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></th>
<td class="colLast">
<div class="block">Create a new <a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport"><code>WebSocketTransport</code></a> instance with the given configuration.</div>
</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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAdditionalHandlers(io.netty.channel.ChannelPipeline)">addAdditionalHandlers</a></span>&#8203;(io.netty.channel.ChannelPipeline&nbsp;pipeline)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected io.netty.channel.ChannelInboundHandlerAdapter</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createChannelHandler()">createChannelHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteURI()">getRemoteURI</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <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="#getScheme()">getScheme</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleConnected(io.netty.channel.Channel)">handleConnected</a></span>&#8203;(io.netty.channel.Channel&nbsp;channel)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">write</a></span>&#8203;(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a>&nbsp;onComplete)</code></th>
<td class="colLast">
<div class="block">Writes a chunk of data over the Transport connection without performing an
explicit flush on the transport.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">writeAndFlush</a></span>&#8203;(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a>&nbsp;onComplete)</code></th>
<td class="colLast">
<div class="block">Writes a chunk of data over the Transport connection and requests a flush of
all pending queued write operations</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.transport.TcpTransport">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.qpid.protonj2.client.transport.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></h3>
<code><a href="TcpTransport.html#awaitConnect()">awaitConnect</a>, <a href="TcpTransport.html#checkConnected()">checkConnected</a>, <a href="TcpTransport.html#close()">close</a>, <a href="TcpTransport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">connect</a>, <a href="TcpTransport.html#flush()">flush</a>, <a href="TcpTransport.html#getBufferAllocator()">getBufferAllocator</a>, <a href="TcpTransport.html#getHost()">getHost</a>, <a href="TcpTransport.html#getLocalPrincipal()">getLocalPrincipal</a>, <a href="TcpTransport.html#getPort()">getPort</a>, <a href="TcpTransport.html#getSslOptions()">getSslOptions</a>, <a href="TcpTransport.html#getTransportListener()">getTransportListener</a>, <a href="TcpTransport.html#getTransportOptions()">getTransportOptions</a>, <a href="TcpTransport.html#handleTransportFailure(io.netty.channel.Channel,java.lang.Throwable)">handleTransportFailure</a>, <a href="TcpTransport.html#isConnected()">isConnected</a>, <a href="TcpTransport.html#isSecure()">isSecure</a>, <a href="TcpTransport.html#toOutputBuffer(org.apache.qpid.protonj2.buffer.ProtonBuffer)">toOutputBuffer</a>, <a href="TcpTransport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">write</a>, <a href="TcpTransport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeAndFlush</a></code></li>
</ul>
<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#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <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">
<!-- ========= 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;(io.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketTransport</h4>
<pre>public&nbsp;WebSocketTransport&#8203;(io.netty.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)</pre>
<div class="block">Create a new <a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport"><code>WebSocketTransport</code></a> instance with the given configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bootstrap</code> - the <code>Bootstrap</code> that this transport's IO 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>
</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="write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a>&nbsp;write&#8203;(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a>&nbsp;onComplete)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">write</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></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?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Runnable</code></a> that is invoked when the IO operation completes successfully.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> 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/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</li>
</ul>
<a id="writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeAndFlush</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a>&nbsp;writeAndFlush&#8203;(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a>&nbsp;onComplete)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">writeAndFlush</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></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?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Runnable</code></a> that is invoked when the IO operation completes successfully.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> 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/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an error occurs during the write operation.</dd>
</dl>
</li>
</ul>
<a id="getRemoteURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteURI</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;getRemoteURI()</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#getRemoteURI()">getRemoteURI</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></dd>
<dt><span class="returnLabel">Returns:</span></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>
</li>
</ul>
<a id="createChannelHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChannelHandler</h4>
<pre class="methodSignature">protected&nbsp;io.netty.channel.ChannelInboundHandlerAdapter&nbsp;createChannelHandler()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#createChannelHandler()">createChannelHandler</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></dd>
</dl>
</li>
</ul>
<a id="addAdditionalHandlers(io.netty.channel.ChannelPipeline)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAdditionalHandlers</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;addAdditionalHandlers&#8203;(io.netty.channel.ChannelPipeline&nbsp;pipeline)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#addAdditionalHandlers(io.netty.channel.ChannelPipeline)">addAdditionalHandlers</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></dd>
</dl>
</li>
</ul>
<a id="handleConnected(io.netty.channel.Channel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleConnected</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;handleConnected&#8203;(io.netty.channel.Channel&nbsp;channel)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#handleConnected(io.netty.channel.Channel)">handleConnected</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></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/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="getScheme()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getScheme</h4>
<pre class="methodSignature">protected&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;getScheme()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TcpTransport.html#getScheme()">getScheme</a></code>&nbsp;in class&nbsp;<code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code></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/WebSocketTransport.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><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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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>