| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>TcpTransport (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TcpTransport (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</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/TcpTransport.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="../../../../../../index-all.html">Index</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> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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><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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class TcpTransport" class="title">Class TcpTransport</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.transport.TcpTransport</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="WebSocketTransport.html" title="class in org.apache.qpid.protonj2.client.transport">WebSocketTransport</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">TcpTransport</span> |
| extends java.lang.Object |
| implements <a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></pre> |
| <div class="block">TCP based transport that uses Netty as the underlying IO layer.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="TcpTransport.NettyDefaultHandler.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport.NettyDefaultHandler</a><<a href="TcpTransport.NettyDefaultHandler.html" title="type parameter in TcpTransport.NettyDefaultHandler">E</a>></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="TcpTransport.NettyTcpTransportHandler.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport.NettyTcpTransportHandler</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected io.netty.bootstrap.Bootstrap</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bootstrap">bootstrap</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected io.netty.channel.Channel</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#channel">channel</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.concurrent.atomic.AtomicBoolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closed">closed</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.concurrent.atomic.AtomicBoolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connected">connected</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.concurrent.CountDownLatch</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectedLatch">connectedLatch</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.io.IOException</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#failureCause">failureCause</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#host">host</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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="#listener">listener</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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="#options">options</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#port">port</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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="#sslOptions">sslOptions</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(io.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)">TcpTransport</a></span>​(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></th> |
| <td class="colLast"> |
| <div class="block">Create a new <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport"><code>TcpTransport</code></a> instance with the given configuration.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAdditionalHandlers(io.netty.channel.ChannelPipeline)">addAdditionalHandlers</a></span>​(io.netty.channel.ChannelPipeline pipeline)</code></th> |
| <td class="colLast"> </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="#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="Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>Transport.connect(String, int, TransportListener)</code></a> call.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkConnected()">checkConnected</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" 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="i4" class="altColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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>​(java.lang.String 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="i5" class="rowColor"> |
| <td class="colFirst"><code>protected io.netty.channel.ChannelInboundHandlerAdapter</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createChannelHandler()">createChannelHandler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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="i7" class="rowColor"> |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</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="i9" class="rowColor"> |
| <td class="colFirst"><code>java.security.Principal</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="i10" class="altColor"> |
| <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="i11" class="rowColor"> |
| <td class="colFirst"><code>java.net.URI</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="i12" class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheme()">getScheme</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" 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="i14" 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="i15" 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="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleConnected(io.netty.channel.Channel)">handleConnected</a></span>​(io.netty.channel.Channel connectedChannel)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleTransportFailure(io.netty.channel.Channel,java.lang.Throwable)">handleTransportFailure</a></span>​(io.netty.channel.Channel failedChannel, |
| java.lang.Throwable cause)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" 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="i19" 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="i20" class="altColor"> |
| <td class="colFirst"><code>protected io.netty.buffer.ByteBuf</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toOutputBuffer(org.apache.qpid.protonj2.buffer.ProtonBuffer)">toOutputBuffer</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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="i22" class="altColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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, |
| java.lang.Runnable onComplete)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a chunk of data over the Transport connection without performing an |
| explicit flush on the transport.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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="i24" class="altColor"> |
| <td class="colFirst"><code><a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</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, |
| java.lang.Runnable onComplete)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="connected"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connected</h4> |
| <pre>protected final java.util.concurrent.atomic.AtomicBoolean connected</pre> |
| </li> |
| </ul> |
| <a id="closed"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closed</h4> |
| <pre>protected final java.util.concurrent.atomic.AtomicBoolean closed</pre> |
| </li> |
| </ul> |
| <a id="connectedLatch"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connectedLatch</h4> |
| <pre>protected final java.util.concurrent.CountDownLatch connectedLatch</pre> |
| </li> |
| </ul> |
| <a id="options"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>options</h4> |
| <pre>protected final <a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> options</pre> |
| </li> |
| </ul> |
| <a id="sslOptions"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sslOptions</h4> |
| <pre>protected final <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> sslOptions</pre> |
| </li> |
| </ul> |
| <a id="bootstrap"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bootstrap</h4> |
| <pre>protected final io.netty.bootstrap.Bootstrap bootstrap</pre> |
| </li> |
| </ul> |
| <a id="channel"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channel</h4> |
| <pre>protected io.netty.channel.Channel channel</pre> |
| </li> |
| </ul> |
| <a id="failureCause"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>failureCause</h4> |
| <pre>protected volatile java.io.IOException failureCause</pre> |
| </li> |
| </ul> |
| <a id="host"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>host</h4> |
| <pre>protected java.lang.String host</pre> |
| </li> |
| </ul> |
| <a id="port"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>port</h4> |
| <pre>protected int port</pre> |
| </li> |
| </ul> |
| <a id="listener"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>listener</h4> |
| <pre>protected <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> listener</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(io.netty.bootstrap.Bootstrap,org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TcpTransport</h4> |
| <pre>public TcpTransport​(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)</pre> |
| <div class="block">Create a new <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport"><code>TcpTransport</code></a> instance with the given configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bootstrap</code> - the Netty <code>Bootstrap</code> that this transport's IO layer is bound to.</dd> |
| <dd><code>options</code> - the <a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> used to configure the socket connection.</dd> |
| <dd><code>sslOptions</code> - the <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> to use if the options indicate SSL is enabled.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="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">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> connect​(java.lang.String host, |
| int port, |
| <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> listener) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">Transport</a></code></span></div> |
| <div class="block">Performs the connect operation for the implemented Transport type such as |
| a TCP socket connection, SSL/TLS handshake etc. The connection operation |
| itself will be performed as an asynchronous operation with the success or |
| failure being communicated to the event point |
| <a href="TransportListener.html#transportError(java.lang.Throwable)"><code>TransportListener.transportError(Throwable)</code></a>. If the users wishes |
| to perform a block on connect outcome the <a href="Transport.html#awaitConnect()"><code>Transport.awaitConnect()</code></a> method |
| will wait for and or throw an error based on the connect outcome.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)">connect</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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>java.io.IOException</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">public void awaitConnect() |
| throws java.lang.InterruptedException, |
| java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#awaitConnect()">Transport</a></code></span></div> |
| <div class="block">Waits interruptibly for the <a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> to connect to the remote that was |
| indicated in the <a href="Transport.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.transport.TransportListener)"><code>Transport.connect(String, int, TransportListener)</code></a> call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#awaitConnect()">awaitConnect</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code> - If the wait mechanism was interrupted while waiting for a successful connect.</dd> |
| <dd><code>java.io.IOException</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">public boolean isConnected()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#isConnected()">isConnected</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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">public boolean isSecure()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#isSecure()">isSecure</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if transport is connected using a secured channel (SSL).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature">public java.lang.String getHost()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getHost()">getHost</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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">public int getPort()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getPort()">getPort</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port that the transport connects to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#close()">Transport</a></code></span></div> |
| <div class="block">Close the Transport, no additional send operations are accepted.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#close()">close</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</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">public <a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a> getBufferAllocator()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#getBufferAllocator()">Transport</a></code></span></div> |
| <div class="block">Gets a buffer allocator that can produce <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance that may be |
| optimized for use with the underlying transport implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getBufferAllocator()">getBufferAllocator</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> write​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">Transport</a></code></span></div> |
| <div class="block">Writes a chunk of data over the Transport connection without performing an |
| explicit flush on the transport.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer)">write</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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>java.io.IOException</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">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> write​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output, |
| java.lang.Runnable onComplete) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#write(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">write</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</dd> |
| <dd><code>onComplete</code> - A <code>Runnable</code> 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>java.io.IOException</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">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> writeAndFlush​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">Transport</a></code></span></div> |
| <div class="block">Writes a chunk of data over the Transport connection and requests a flush of |
| all pending queued write operations</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeAndFlush</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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>java.io.IOException</code> - if an error occurs during the write operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeAndFlush</h4> |
| <pre class="methodSignature">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> writeAndFlush​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output, |
| java.lang.Runnable onComplete) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#writeAndFlush(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">writeAndFlush</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>output</code> - The buffer of data that is to be transmitted.</dd> |
| <dd><code>onComplete</code> - A <code>Runnable</code> 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>java.io.IOException</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">public <a href="TcpTransport.html" title="class in org.apache.qpid.protonj2.client.transport">TcpTransport</a> flush() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#flush()">Transport</a></code></span></div> |
| <div class="block">Request a flush of all pending writes to the underlying connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#flush()">flush</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></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>java.io.IOException</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">public <a href="TransportListener.html" title="interface in org.apache.qpid.protonj2.client.transport">TransportListener</a> getTransportListener()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Transport.html#getTransportListener()">Transport</a></code></span></div> |
| <div class="block">Gets the currently set TransportListener instance</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getTransportListener()">getTransportListener</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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">public <a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> getTransportOptions()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getTransportOptions()">getTransportOptions</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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">public <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> getSslOptions()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getSslOptions()">getSslOptions</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <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="getLocalPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalPrincipal</h4> |
| <pre class="methodSignature">public java.security.Principal getLocalPrincipal()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Transport.html#getLocalPrincipal()">getLocalPrincipal</a></code> in interface <code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local principal for a Transport that is using a secure connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toOutputBuffer(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toOutputBuffer</h4> |
| <pre class="methodSignature">protected final io.netty.buffer.ByteBuf toOutputBuffer​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> output) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addAdditionalHandlers(io.netty.channel.ChannelPipeline)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAdditionalHandlers</h4> |
| <pre class="methodSignature">protected void addAdditionalHandlers​(io.netty.channel.ChannelPipeline pipeline)</pre> |
| </li> |
| </ul> |
| <a id="createChannelHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createChannelHandler</h4> |
| <pre class="methodSignature">protected io.netty.channel.ChannelInboundHandlerAdapter createChannelHandler()</pre> |
| </li> |
| </ul> |
| <a id="handleConnected(io.netty.channel.Channel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleConnected</h4> |
| <pre class="methodSignature">protected void handleConnected​(io.netty.channel.Channel connectedChannel) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="handleTransportFailure(io.netty.channel.Channel,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleTransportFailure</h4> |
| <pre class="methodSignature">protected void handleTransportFailure​(io.netty.channel.Channel failedChannel, |
| java.lang.Throwable cause)</pre> |
| </li> |
| </ul> |
| <a id="checkConnected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkConnected</h4> |
| <pre class="methodSignature">protected final void checkConnected() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteURI</h4> |
| <pre class="methodSignature">public java.net.URI getRemoteURI()</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><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="getScheme()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getScheme</h4> |
| <pre class="methodSignature">protected java.lang.String getScheme()</pre> |
| </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/TcpTransport.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="../../../../../../index-all.html">Index</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><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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |