| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>WebSocketTransport (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.netty4, class: WebSocketTransport"> |
| <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/WebSocketTransport.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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.qpid.protonj2.client.transport.netty4</a></div> |
| <h1 title="Class WebSocketTransport" class="title">Class WebSocketTransport</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"><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">org.apache.qpid.protonj2.client.transport.netty4.TcpTransport</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.transport.netty4.WebSocketTransport</div> |
| </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> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">WebSocketTransport</span> |
| <span class="extends-implements">extends <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></span></div> |
| <div class="block">Netty based WebSockets Transport that wraps and extends the TCP Transport.</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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.qpid.protonj2.client.transport.netty4.TcpTransport">Nested classes/interfaces inherited from class org.apache.qpid.protonj2.client.transport.netty4.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></h2> |
| <code><a href="TcpTransport.NettyDefaultHandler.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport.NettyDefaultHandler</a><<a href="TcpTransport.NettyDefaultHandler.html" title="type parameter in TcpTransport.NettyDefaultHandler">E</a>>, <a href="TcpTransport.NettyTcpTransportHandler.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport.NettyTcpTransportHandler</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.qpid.protonj2.client.transport.netty4.TcpTransport">Fields inherited from class org.apache.qpid.protonj2.client.transport.netty4.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">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#nettyAllocator">nettyAllocator</a>, <a href="TcpTransport.html#options">options</a>, <a href="TcpTransport.html#port">port</a>, <a href="TcpTransport.html#sslOptions">sslOptions</a></code></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.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)" class="member-name-link">WebSocketTransport</a><wbr>(io.netty.bootstrap.Bootstrap bootstrap, |
| <a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> options, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> sslOptions)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a new <a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4"><code>WebSocketTransport</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.netty.channel.ChannelPipeline)" class="member-name-link">addAdditionalHandlers</a><wbr>(io.netty.channel.ChannelPipeline pipeline)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.netty.channel.ChannelInboundHandlerAdapter</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"> </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/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div> |
| <div class="col-second even-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 even-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 odd-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 odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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.netty.channel.Channel)" class="member-name-link">handleConnected</a><wbr>(io.netty.channel.Channel channel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">WebSocketTransport</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> 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> 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="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">WebSocketTransport</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,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> 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> onComplete)</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> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.client.transport.netty4.TcpTransport">Methods inherited from class org.apache.qpid.protonj2.client.transport.netty4.<a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(io.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)"> |
| <h3>WebSocketTransport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WebSocketTransport</span><wbr><span class="parameters">(io.netty.bootstrap.Bootstrap bootstrap, |
| <a href="../../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> options, |
| <a href="../../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> sslOptions)</span></div> |
| <div class="block">Create a new <a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4"><code>WebSocketTransport</code></a> instance with the given configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </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="write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">WebSocketTransport</a></span> <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> 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> 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: <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> in interface <code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">write</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</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,java.lang.Runnable)"> |
| <h3>writeAndFlush</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">WebSocketTransport</a></span> <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> 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> 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: <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> in interface <code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">writeAndFlush</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</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="getRemoteURI()"> |
| <h3>getRemoteURI</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getRemoteURI</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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> in interface <code><a href="../Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#getRemoteURI()">getRemoteURI</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</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="createChannelHandler()"> |
| <h3>createChannelHandler</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">io.netty.channel.ChannelInboundHandlerAdapter</span> <span class="element-name">createChannelHandler</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#createChannelHandler()">createChannelHandler</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAdditionalHandlers(io.netty.channel.ChannelPipeline)"> |
| <h3>addAdditionalHandlers</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">addAdditionalHandlers</span><wbr><span class="parameters">(io.netty.channel.ChannelPipeline pipeline)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#addAdditionalHandlers(io.netty.channel.ChannelPipeline)">addAdditionalHandlers</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleConnected(io.netty.channel.Channel)"> |
| <h3>handleConnected</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">handleConnected</span><wbr><span class="parameters">(io.netty.channel.Channel channel)</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>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#handleConnected(io.netty.channel.Channel)">handleConnected</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></code></dd> |
| <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="getScheme()"> |
| <h3>getScheme</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <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> <span class="element-name">getScheme</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TcpTransport.html#getScheme()">getScheme</a></code> in class <code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
