| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Transport (Qpid ProtonJ2 Parent 1.0.0-M18 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, interface: Transport"> |
| <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/Transport.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</a></div> |
| <h1 title="Interface Transport" class="title">Interface Transport</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="netty4/TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">TcpTransport</a></code>, <code><a href="netty5/TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">TcpTransport</a></code>, <code><a href="netty4/WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">WebSocketTransport</a></code>, <code><a href="netty5/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 interface </span><span class="element-name type-name-label">Transport</span></div> |
| <div class="block">Base class for all QpidJMS Transport instances.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#awaitConnect()" class="member-name-link">awaitConnect</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>connect(String, int, TransportListener)</code></a> call.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> host, |
| int port, |
| <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#flush()" class="member-name-link">flush</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Request a flush of all pending writes to the underlying connection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBufferAllocator()" class="member-name-link">getBufferAllocator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHost()" class="member-name-link">getHost</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocalPrincipal()" class="member-name-link">getLocalPrincipal</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPort()" class="member-name-link">getPort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> output)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> ioComplete)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> output)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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> ioComplete)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ 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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></span> <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> host, |
| int port, |
| <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> 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">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="#awaitConnect()"><code>awaitConnect()</code></a> method |
| will wait for and or throw an error based on the connect outcome.</div> |
| <dl class="notes"> |
| <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="return-type">void</span> <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">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="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>connect(String, int, TransportListener)</code></a> call.</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/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="return-type">boolean</span> <span class="element-name">isConnected</span>()</div> |
| <dl class="notes"> |
| <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="return-type">boolean</span> <span class="element-name">isSecure</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if transport is connected using a secured channel (SSL).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <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">Close the Transport, no additional send operations are accepted.</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> - 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="return-type"><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></span> <span class="element-name">getBufferAllocator</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>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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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)</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">Writes a chunk of data over the Transport connection without performing an |
| explicit flush on the transport.</div> |
| <dl class="notes"> |
| <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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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> ioComplete)</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">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>Parameters:</dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</dd> |
| <dd><code>ioComplete</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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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)</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">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| <dl class="notes"> |
| <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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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> ioComplete)</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">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</dd> |
| <dd><code>ioComplete</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="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></span> <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">Request a flush of all pending writes to the underlying connection.</div> |
| <dl class="notes"> |
| <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="return-type"><a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></span> <span class="element-name">getTransportListener</span>()</div> |
| <div class="block">Gets the currently set TransportListener instance</div> |
| <dl class="notes"> |
| <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="return-type"><a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></span> <span class="element-name">getTransportOptions</span>()</div> |
| <dl class="notes"> |
| <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="return-type"><a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></span> <span class="element-name">getSslOptions</span>()</div> |
| <dl class="notes"> |
| <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="getHost()"> |
| <h3>getHost</h3> |
| <div class="member-signature"><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">getHost</span>()</div> |
| <dl class="notes"> |
| <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="return-type">int</span> <span class="element-name">getPort</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the port that the transport connects to.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteURI()"> |
| <h3>getRemoteURI</h3> |
| <div class="member-signature"><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">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="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>connect(String, int, TransportListener)</code></a> |
| method this method returns <code>null</code>.</div> |
| <dl class="notes"> |
| <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="getLocalPrincipal()"> |
| <h3>getLocalPrincipal</h3> |
| <div class="member-signature"><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> <span class="element-name">getLocalPrincipal</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the local principal for a Transport that is using a secure connection.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
