| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ClientConnection (Qpid ProtonJ2 Parent 1.0.0-M2 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="ClientConnection (Qpid ProtonJ2 Parent 1.0.0-M2 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,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientConnection.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.impl</a></div> |
| <h2 title="Class ClientConnection" class="title">Class ClientConnection</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.impl.ClientConnection</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.lang.AutoCloseable</code>, <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ClientConnection</span> |
| extends java.lang.Object |
| implements <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></pre> |
| <div class="block">A <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> implementation that uses the Proton engine for AMQP protocol support.</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="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="#checkClosedOrFailed()">checkClosedOrFailed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and waits until the Connection has been |
| fully closed or until the configured <a href="../ConnectionOptions.html#closeTimeout()"><code>ConnectionOptions.closeTimeout()</code></a> is exceeded.</div> |
| </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(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></span>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and waits until the Connection has been |
| fully closed or until the configured <a href="../ConnectionOptions.html#closeTimeout()"><code>ConnectionOptions.closeTimeout()</code></a> is exceeded.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync()">closeAsync</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the Connection has been fully closed.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the Connection has been fully closed.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultSender()">defaultSender</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default anonymous sender used by this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> for <a href="../Connection.html#send(org.apache.qpid.protonj2.client.Message)"><code>Connection.send(Message)</code></a> |
| calls.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultSession()">defaultSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance that is used by this Connection to |
| create the default anonymous connection <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> as well as creating those |
| resources created from the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> such as <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> and <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> |
| instances not married to a specific <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</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="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openAnonymousSender()">openAnonymousSender</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each message |
| that is sent using this sender must specify an address in its destination address field.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)">openAnonymousSender</a></span>​(<a href="../SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDurableReceiver(java.lang.String,java.lang.String)">openDurableReceiver</a></span>​(java.lang.String address, |
| java.lang.String subscriptionName)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openDurableReceiver</a></span>​(java.lang.String address, |
| java.lang.String subscriptionName, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver()">openDynamicReceiver</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(java.util.Map)">openDynamicReceiver</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></span>​(<a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openFuture()">openFuture</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">When a <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> is created it may not be opened on the remote peer, the future returned |
| from this method allows the caller to await the completion of the Connection open by the remote before |
| proceeding on to other messaging operations.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openReceiver(java.lang.String)">openReceiver</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consumer messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openReceiver</a></span>​(java.lang.String address, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consumer messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSender(java.lang.String)">openSender</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)">openSender</a></span>​(java.lang.String address, |
| <a href="../SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSession()">openSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSession(org.apache.qpid.protonj2.client.SessionOptions)">openSession</a></span>​(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> sessionOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openStreamReceiver(java.lang.String)">openStreamReceiver</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)">openStreamReceiver</a></span>​(java.lang.String address, |
| <a href="../StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openStreamSender(java.lang.String)">openStreamSender</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a stream sender used to send large messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)">openStreamSender</a></span>​(java.lang.String address, |
| <a href="../StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a> senderOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a streaming sender used to send large messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.apache.qpid.protonj2.client.Message)">send</a></span>​(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><?> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> using the internal connection sender.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </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, wait, wait, wait</code></li> |
| </ul> |
| </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="client()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>client</h4> |
| <pre class="methodSignature">public <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a> client()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#client()">client</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance that holds this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openFuture()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFuture</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>> openFuture()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openFuture()">Connection</a></code></span></div> |
| <div class="block">When a <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> is created it may not be opened on the remote peer, the future returned |
| from this method allows the caller to await the completion of the Connection open by the remote before |
| proceeding on to other messaging operations. If the open of the connection fails at the remote an |
| <code>Exception</code> is thrown from the <code>Future.get()</code> method when called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openFuture()">openFuture</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote opens this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#close()">Connection</a></code></span></div> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and waits until the Connection has been |
| fully closed or until the configured <a href="../ConnectionOptions.html#closeTimeout()"><code>ConnectionOptions.closeTimeout()</code></a> is exceeded.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#close()">close</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">Connection</a></code></span></div> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and waits until the Connection has been |
| fully closed or until the configured <a href="../ConnectionOptions.html#closeTimeout()"><code>ConnectionOptions.closeTimeout()</code></a> is exceeded.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>error</code> - The <a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="closeAsync()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAsync</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>> closeAsync()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#closeAsync()">Connection</a></code></span></div> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the Connection has been fully closed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#closeAsync()">closeAsync</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote closes this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAsync</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>> closeAsync​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">Connection</a></code></span></div> |
| <div class="block">Requests a close of the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the Connection has been fully closed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>error</code> - The <a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote closes this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="defaultSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultSession</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> defaultSession() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#defaultSession()">Connection</a></code></span></div> |
| <div class="block">Returns the default <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance that is used by this Connection to |
| create the default anonymous connection <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> as well as creating those |
| resources created from the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> such as <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> and <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> |
| instances not married to a specific <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#defaultSession()">defaultSession</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSession</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> openSession() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openSession()">Connection</a></code></span></div> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application. The returned session |
| will be configured using default options and will take its timeout configuration values from those |
| specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> can block until the remote fully opens the session, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Session.html#openFuture()"><code>Session.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openSession()">openSession</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSession(org.apache.qpid.protonj2.client.SessionOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSession</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> openSession​(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> sessionOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application. |
| |
| The returned <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> can block until the remote fully opens the session, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Session.html#openFuture()"><code>Session.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)">openSession</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionOptions</code> - The <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> that control properties of the created session.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openReceiver(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openReceiver​(java.lang.String address) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openReceiver(java.lang.String)">Connection</a></code></span></div> |
| <div class="block">Creates a receiver used to consumer messages from the given node address. The returned receiver will |
| be configured using default options and will take its timeout configuration values from those specified |
| in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openReceiver(java.lang.String)">openReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the consumer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openReceiver​(java.lang.String address, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a receiver used to consumer messages from the given node address. The returned receiver |
| will be configured using the options provided in the given <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDurableReceiver(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDurableReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDurableReceiver​(java.lang.String address, |
| java.lang.String subscriptionName) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDurableReceiver(java.lang.String,java.lang.String)">Connection</a></code></span></div> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDurableReceiver(java.lang.String,java.lang.String)">openDurableReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>subscriptionName</code> - The name to give the subscription (link name).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDurableReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDurableReceiver​(java.lang.String address, |
| java.lang.String subscriptionName, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openDurableReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>subscriptionName</code> - The name to give the subscription (link name).</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDynamicReceiver()">Connection</a></code></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address. The returned receiver |
| will be configured using default options and will take its timeout configuration values from those |
| specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDynamicReceiver()">openDynamicReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDynamicReceiver(java.util.Map)">Connection</a></code></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDynamicReceiver(java.util.Map)">openDynamicReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dynamicNodeProperties</code> - The dynamic node properties to be applied to the node created by the remote.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(<a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties, |
| <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address. |
| |
| The returned receiver may not have been opened on the remote when it is returned. Some methods of the |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> can block until the remote fully opens the receiver, the user can wait for the remote |
| to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dynamicNodeProperties</code> - The dynamic node properties to be applied to the node created by the remote.</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openStreamReceiver(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openStreamReceiver</h4> |
| <pre class="methodSignature">public <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a> openStreamReceiver​(java.lang.String address) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openStreamReceiver(java.lang.String)">Connection</a></code></span></div> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address. The |
| returned <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> will be configured using default options and will take its timeout |
| configuration values from those specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned stream receiver may not have been opened on the remote when it is returned. Some methods of |
| the <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> can block until the remote fully opens the receiver link, the user can wait for |
| the remote to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> method and using |
| the <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openStreamReceiver(java.lang.String)">openStreamReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openStreamReceiver</h4> |
| <pre class="methodSignature">public <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a> openStreamReceiver​(java.lang.String address, |
| <a href="../StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a> receiverOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address. The |
| returned receiver will be configured using the options provided in the given <a href="../ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> |
| instance. |
| |
| The returned <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> may not have been opened on the remote when it is returned. Some |
| methods of the <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> can block until the remote fully opens the receiver link, the user |
| can wait for the remote to respond to the open request by calling the <a href="../Receiver.html#openFuture()"><code>Receiver.openFuture()</code></a> |
| method and using the <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)">openStreamReceiver</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="defaultSender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultSender</h4> |
| <pre class="methodSignature">public <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> defaultSender() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#defaultSender()">Connection</a></code></span></div> |
| <div class="block">Returns the default anonymous sender used by this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> for <a href="../Connection.html#send(org.apache.qpid.protonj2.client.Message)"><code>Connection.send(Message)</code></a> |
| calls. If the sender has not been created yet this call will initiate its creation and open with |
| the remote peer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#defaultSender()">defaultSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs opening the default sender.</dd> |
| <dd><code><a href="../exceptions/ClientUnsupportedOperationException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientUnsupportedOperationException</a></code> - if the remote did not signal support for anonymous relays.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSender(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSender</h4> |
| <pre class="methodSignature">public <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openSender​(java.lang.String address) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openSender(java.lang.String)">Connection</a></code></span></div> |
| <div class="block">Creates a sender used to send messages to the given node address. The returned sender will |
| be configured using default options and will take its timeout configuration values from those |
| specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openSender(java.lang.String)">openSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSender</h4> |
| <pre class="methodSignature">public <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openSender​(java.lang.String address, |
| <a href="../SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a sender used to send messages to the given node address. |
| |
| The returned <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)">openSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openAnonymousSender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openAnonymousSender</h4> |
| <pre class="methodSignature">public <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openAnonymousSender() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openAnonymousSender()">Connection</a></code></span></div> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each message |
| that is sent using this sender must specify an address in its destination address field. |
| The returned sender will be configured using default options and will take its timeout |
| configuration values from those specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openAnonymousSender()">openAnonymousSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| <dd><code><a href="../exceptions/ClientUnsupportedOperationException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientUnsupportedOperationException</a></code> - if the remote did not signal support for anonymous relays.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openAnonymousSender</h4> |
| <pre class="methodSignature">public <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openAnonymousSender​(<a href="../SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field. |
| |
| The returned <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)">openAnonymousSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| <dd><code><a href="../exceptions/ClientUnsupportedOperationException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientUnsupportedOperationException</a></code> - if the remote did not signal support for anonymous relays.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openStreamSender(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openStreamSender</h4> |
| <pre class="methodSignature">public <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a> openStreamSender​(java.lang.String address) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openStreamSender(java.lang.String)">Connection</a></code></span></div> |
| <div class="block">Creates a stream sender used to send large messages to the given node address. The returned sender will |
| be configured using default options and will take its timeout configuration values from those |
| specified in the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| |
| The returned <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openStreamSender(java.lang.String)">openStreamSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stream sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openStreamSender</h4> |
| <pre class="methodSignature">public <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a> openStreamSender​(java.lang.String address, |
| <a href="../StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a> senderOptions) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)">Connection</a></code></span></div> |
| <div class="block">Creates a streaming sender used to send large messages to the given node address. |
| <p> |
| The returned <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> may not have been opened on the remote when it is returned. Some methods |
| of the <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> can block until the remote fully opens the sender, the user can wait for the |
| remote to respond to the open request by calling the <a href="../Sender.html#openFuture()"><code>Sender.openFuture()</code></a> method and using the |
| <code>Future.get()</code> methods to wait for completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)">openStreamSender</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send(org.apache.qpid.protonj2.client.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a> send​(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><?> message) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#send(org.apache.qpid.protonj2.client.Message)">Connection</a></code></span></div> |
| <div class="block">Sends the given <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> using the internal connection sender. |
| <p> |
| The connection <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> is an anonymous AMQP sender which requires that the |
| given message has a valid to value set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#send(org.apache.qpid.protonj2.client.Message)">send</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - The message to send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> that allows the client to track settlement of the message.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="properties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> properties() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#properties()">Connection</a></code></span></div> |
| <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. If the |
| open has not completed yet this method will block to await the open response which carries the remote |
| properties. If the remote provides no properties this method will return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#properties()">properties</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any properties provided from the remote once the connection has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> remote properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="offeredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offeredCapabilities</h4> |
| <pre class="methodSignature">public java.lang.String[] offeredCapabilities() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#offeredCapabilities()">Connection</a></code></span></div> |
| <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| If the open has not completed yet this method will block to await the open response which carries the |
| remote offered capabilities. If the remote provides no capabilities this method will return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#offeredCapabilities()">offeredCapabilities</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any capabilities provided from the remote once the connection has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> remote offered capabilities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="desiredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>desiredCapabilities</h4> |
| <pre class="methodSignature">public java.lang.String[] desiredCapabilities() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Connection.html#desiredCapabilities()">Connection</a></code></span></div> |
| <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>. |
| If the open has not completed yet this method will block to await the open response which carries the |
| remote desired capabilities. If the remote provides no capabilities this method will return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Connection.html#desiredCapabilities()">desiredCapabilities</a></code> in interface <code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any desired capabilities provided from the remote once the connection has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> remote desired capabilities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkClosedOrFailed()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkClosedOrFailed</h4> |
| <pre class="methodSignature">protected void checkClosedOrFailed() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientConnection.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> |
