| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Transport (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="Transport (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Transport.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.apache.qpid.protonj2.client.transport</a></div> |
| <h2 title="Interface Transport" class="title">Interface Transport</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a></code>, <code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Transport</span></pre> |
| <div class="block">Base class for all QpidJMS Transport instances.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awaitConnect()">awaitConnect</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Close the Transport, no additional send operations are accepted.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">connect</a></span>​(<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> host, |
| int port, |
| <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs the connect operation for the implemented Transport type such as |
| a TCP socket connection, SSL/TLS handshake etc.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush()">flush</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Request a flush of all pending writes to the underlying connection.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferAllocator()">getBufferAllocator</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHost()">getHost</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html?is-external=true" title="class or interface in java.security" class="externalLink">Principal</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalPrincipal()">getLocalPrincipal</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPort()">getPort</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" 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="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslOptions()">getSslOptions</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransportListener()">getTransportListener</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the currently set TransportListener instance</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransportOptions()">getTransportOptions</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConnected()">isConnected</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">write</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output)</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="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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>​(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete)</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="i16" class="altColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeAndFlush</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output)</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> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</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>​(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete)</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> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre class="methodSignature"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> connect​(<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> host, |
| int port, |
| <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> listener) |
| 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">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> |
| <dt><span class="paramLabel">Parameters:</span></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><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 while attempting the connect.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="awaitConnect()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitConnect</h4> |
| <pre class="methodSignature">void awaitConnect() |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a>, |
| <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">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> |
| <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/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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?is-external=true" title="class or interface in java.io" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="isConnected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConnected</h4> |
| <pre class="methodSignature">boolean isConnected()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if transport is connected or false if the connection is down.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSecure()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecure</h4> |
| <pre class="methodSignature">boolean isSecure()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if transport is connected using a secured channel (SSL).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close() |
| 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">Close the Transport, no additional send operations are accepted.</div> |
| <dl> |
| <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 while closing the connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBufferAllocator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferAllocator</h4> |
| <pre class="methodSignature"><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a> getBufferAllocator()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="write(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre class="methodSignature"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> write​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output) |
| 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">Writes a chunk of data over the Transport connection without performing an |
| explicit flush on the transport.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</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="write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre class="methodSignature"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> write​(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete) |
| 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">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="paramLabel">Parameters:</span></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?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)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeAndFlush</h4> |
| <pre class="methodSignature"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> writeAndFlush​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output) |
| 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">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</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"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> writeAndFlush​(<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?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete) |
| 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">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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?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="flush()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre class="methodSignature"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a> flush() |
| 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">Request a flush of all pending writes to the underlying connection.</div> |
| <dl> |
| <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 flush operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTransportListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransportListener</h4> |
| <pre class="methodSignature"><a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> getTransportListener()</pre> |
| <div class="block">Gets the currently set TransportListener instance</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current TransportListener or null if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTransportOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransportOptions</h4> |
| <pre class="methodSignature"><a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> getTransportOptions()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="getSslOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslOptions</h4> |
| <pre class="methodSignature"><a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> getSslOptions()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature"><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> getHost()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the host name or IP address that the transport connects to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre class="methodSignature">int getPort()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port that the transport connects to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteURI</h4> |
| <pre class="methodSignature"><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> getRemoteURI()</pre> |
| <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> |
| <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="getLocalPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getLocalPrincipal</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html?is-external=true" title="class or interface in java.security" class="externalLink">Principal</a> getLocalPrincipal()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local principal for a Transport that is using a secure connection.</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/Transport.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |