| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Connection (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client, interface: Connection"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Connection.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client</a></div> |
| <h1 title="Interface Connection" class="title">Interface Connection</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ClientConnection.html" title="class in org.apache.qpid.protonj2.client.impl">ClientConnection</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Connection</span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div> |
| <div class="block">Top level <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> object that can be used as a stand alone API for sending |
| messages and creating <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances for message consumption. The Connection |
| API also exposes a <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> based API for more advanced messaging use cases. |
| |
| When a Connection is closed all the resources created by the connection are implicitly closed.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#client()" class="member-name-link">client</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">close</a><wbr>(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#closeAsync()" class="member-name-link">closeAsync</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the Connection has been fully closed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">closeAsync</a><wbr>(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the Connection has been fully closed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#defaultSender()" class="member-name-link">defaultSender</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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="#send(org.apache.qpid.protonj2.client.Message)"><code>send(Message)</code></a> |
| calls.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#defaultSession()" class="member-name-link">defaultSession</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns 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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#desiredCapabilities()" class="member-name-link">desiredCapabilities</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextReceiver()" class="member-name-link">nextReceiver</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Waits indefinitely for a receiver created from the connection default session to have a |
| delivery ready for receipt.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextReceiver(long,java.util.concurrent.TimeUnit)" class="member-name-link">nextReceiver</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Waits for the configured time interval for a receiver created from the connection default |
| session to have a delivery ready for receipt.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextReceiver(org.apache.qpid.protonj2.client.NextReceiverPolicy)" class="member-name-link">nextReceiver</a><wbr>(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a> policy)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Waits indefinitely for a receiver created from the connection default session to have a |
| delivery ready for receipt.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextReceiver(org.apache.qpid.protonj2.client.NextReceiverPolicy,long,java.util.concurrent.TimeUnit)" class="member-name-link">nextReceiver</a><wbr>(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a> policy, |
| long timeout, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Waits for the configured time interval for a receiver created from the connection default |
| session to have a delivery ready for receipt.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#offeredCapabilities()" class="member-name-link">offeredCapabilities</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns 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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openAnonymousSender()" class="member-name-link">openAnonymousSender</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)" class="member-name-link">openAnonymousSender</a><wbr>(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDurableReceiver(java.lang.String,java.lang.String)" class="member-name-link">openDurableReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subscriptionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)" class="member-name-link">openDurableReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subscriptionName, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDynamicReceiver()" class="member-name-link">openDynamicReceiver</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDynamicReceiver(java.util.Map)" class="member-name-link">openDynamicReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> dynamicNodeProperties)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote..</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)" class="member-name-link">openDynamicReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> dynamicNodeProperties, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)" class="member-name-link">openDynamicReceiver</a><wbr>(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote..</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openFuture()" class="member-name-link">openFuture</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openReceiver(java.lang.String)" class="member-name-link">openReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a receiver used to consumer messages from the given node address.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)" class="member-name-link">openReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a receiver used to consumer messages from the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openSender(java.lang.String)" class="member-name-link">openSender</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)" class="member-name-link">openSender</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openSession()" class="member-name-link">openSession</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openSession(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">openSession</a><wbr>(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openStreamReceiver(java.lang.String)" class="member-name-link">openStreamReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)" class="member-name-link">openStreamReceiver</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a> receiverOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a streaming message receiver used to consume large messages from the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openStreamSender(java.lang.String)" class="member-name-link">openStreamSender</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a stream sender used to send large messages to the given node address.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)" class="member-name-link">openStreamSender</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a> senderOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a streaming sender used to send large messages to the given node address.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#properties()" class="member-name-link">properties</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns 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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#send(org.apache.qpid.protonj2.client.Message)" class="member-name-link">send</a><wbr>(<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><?> message)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="client()"> |
| <h3>client</h3> |
| <div class="member-signature"><span class="return-type"><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></span> <span class="element-name">client</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openFuture()"> |
| <h3>openFuture</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></span> <span class="element-name">openFuture</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 |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link"><code>Exception</code></a> is thrown from the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> method when called.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span><wbr><span class="parameters">(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</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 class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeAsync()"> |
| <h3>closeAsync</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></span> <span class="element-name">closeAsync</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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the Connection has been fully closed.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <h3>closeAsync</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>></span> <span class="element-name">closeAsync</span><wbr><span class="parameters">(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the Connection has been fully closed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openReceiver(java.lang.String)"> |
| <h3>openReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dt>Returns:</dt> |
| <dd>the consumer.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <h3>openReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDurableReceiver(java.lang.String,java.lang.String)"> |
| <h3>openDurableReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDurableReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subscriptionName)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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. 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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <h3>openDurableReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDurableReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subscriptionName, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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. The returned receiver will be configured using |
| provided options. |
| |
| 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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDynamicReceiver()"> |
| <h3>openDynamicReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDynamicReceiver</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDynamicReceiver(java.util.Map)"> |
| <h3>openDynamicReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDynamicReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> dynamicNodeProperties)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote.. |
| |
| 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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dynamicNodeProperties</code> - The dynamic node properties to be applied to the node created by the remote.</dd> |
| <dt>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <h3>openDynamicReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDynamicReceiver</span><wbr><span class="parameters">(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote.. |
| |
| 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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <h3>openDynamicReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">openDynamicReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> dynamicNodeProperties, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openStreamReceiver(java.lang.String)"> |
| <h3>openStreamReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></span> <span class="element-name">openStreamReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using |
| the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dt>Returns:</dt> |
| <dd>the newly created <a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openStreamReceiver(java.lang.String,org.apache.qpid.protonj2.client.StreamReceiverOptions)"> |
| <h3>openStreamReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></span> <span class="element-name">openStreamReceiver</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a> receiverOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> |
| method and using the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the newly created <a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultSender()"> |
| <h3>defaultSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></span> <span class="element-name">defaultSender</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="#send(org.apache.qpid.protonj2.client.Message)"><code>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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openSender(java.lang.String)"> |
| <h3>openSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></span> <span class="element-name">openSender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)"> |
| <h3>openSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></span> <span class="element-name">openSender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openStreamSender(java.lang.String)"> |
| <h3>openStreamSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></span> <span class="element-name">openStreamSender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - The target address to attach to, cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd>the stream sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openStreamSender(java.lang.String,org.apache.qpid.protonj2.client.StreamSenderOptions)"> |
| <h3>openStreamSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></span> <span class="element-name">openStreamSender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> address, |
| <a href="StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a> senderOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openAnonymousSender()"> |
| <h3>openAnonymousSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></span> <span class="element-name">openAnonymousSender</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)"> |
| <h3>openAnonymousSender</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></span> <span class="element-name">openAnonymousSender</span><wbr><span class="parameters">(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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="Link.html#openFuture()"><code>Link.openFuture()</code></a> method and using the |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt>Returns:</dt> |
| <dd>the sender.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultSession()"> |
| <h3>defaultSession</h3> |
| <div class="member-signature"><span class="return-type"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span> <span class="element-name">defaultSession</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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>. |
| <p> |
| While it is possible to use the returned Session to cause Connection level resources |
| to operate within a transaction it is strongly discouraged. Transactions should be |
| performed from a user created Session with a single <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> |
| link for best results.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openSession()"> |
| <h3>openSession</h3> |
| <div class="member-signature"><span class="return-type"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span> <span class="element-name">openSession</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openSession(org.apache.qpid.protonj2.client.SessionOptions)"> |
| <h3>openSession</h3> |
| <div class="member-signature"><span class="return-type"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span> <span class="element-name">openSession</span><wbr><span class="parameters">(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> options)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link"><code>Future.get()</code></a> methods to wait for completion.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</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>Returns:</dt> |
| <dd>a new <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="send(org.apache.qpid.protonj2.client.Message)"> |
| <h3>send</h3> |
| <div class="member-signature"><span class="return-type"><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></span> <span class="element-name">send</span><wbr><span class="parameters">(<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><?> message)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>message</code> - The message to send</dd> |
| <dt>Returns:</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>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextReceiver()"> |
| <h3>nextReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">nextReceiver</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Waits indefinitely for a receiver created from the connection default session to have a |
| delivery ready for receipt. The selection of the next receiver when more than one exists |
| which has pending deliveries is based upon the configured value of the |
| <a href="ConnectionOptions.html#defaultNextReceiverPolicy()"><code>ConnectionOptions.defaultNextReceiverPolicy()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the next receiver that has a pending delivery available based on policy.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextReceiver(org.apache.qpid.protonj2.client.NextReceiverPolicy)"> |
| <h3>nextReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">nextReceiver</span><wbr><span class="parameters">(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a> policy)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Waits indefinitely for a receiver created from the connection default session to have a |
| delivery ready for receipt. The selection of the next receiver when more than one exists |
| which has pending deliveries is based upon the value of the <a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client"><code>NextReceiverPolicy</code></a> |
| that is provided by the caller.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>policy</code> - The policy to apply when selecting the next receiver.</dd> |
| <dt>Returns:</dt> |
| <dd>the next receiver that has a pending delivery available based on policy.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextReceiver(long,java.util.concurrent.TimeUnit)"> |
| <h3>nextReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">nextReceiver</span><wbr><span class="parameters">(long timeout, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Waits for the configured time interval for a receiver created from the connection default |
| session to have a delivery ready for receipt. The selection of the next receiver when more |
| than one exists which has pending deliveries is based upon the configured value of the |
| <a href="ConnectionOptions.html#defaultNextReceiverPolicy()"><code>ConnectionOptions.defaultNextReceiverPolicy()</code></a>. If no receiver has an incoming delivery |
| before the given timeout expires the method returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - The timeout value used to control how long the method waits for a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to be available.</dd> |
| <dd><code>unit</code> - The unit of time that the given timeout represents.</dd> |
| <dt>Returns:</dt> |
| <dd>the next receiver that has a pending delivery available based on policy or null if the timeout is reached.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextReceiver(org.apache.qpid.protonj2.client.NextReceiverPolicy,long,java.util.concurrent.TimeUnit)"> |
| <h3>nextReceiver</h3> |
| <div class="member-signature"><span class="return-type"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></span> <span class="element-name">nextReceiver</span><wbr><span class="parameters">(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a> policy, |
| long timeout, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span> |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></span></div> |
| <div class="block">Waits for the configured time interval for a receiver created from the connection default |
| session to have a delivery ready for receipt. The selection of the next receiver when more |
| than one exists which has pending deliveries is based upon the <a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client"><code>NextReceiverPolicy</code></a> |
| provided by the caller. If no receiver has an incoming delivery before the given timeout |
| expires the method returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>policy</code> - The policy to apply when selecting the next receiver.</dd> |
| <dd><code>timeout</code> - The timeout value used to control how long the method waits for a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to be available.</dd> |
| <dd><code>unit</code> - The unit of time that the given timeout represents.</dd> |
| <dt>Returns:</dt> |
| <dd>the next receiver that has a pending delivery available based on policy or null if the timeout is reached.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="properties()"> |
| <h3>properties</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">properties</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>any properties provided from the remote once the connection has successfully opened.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="offeredCapabilities()"> |
| <h3>offeredCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">offeredCapabilities</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>any capabilities provided from the remote once the connection has successfully opened.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="desiredCapabilities()"> |
| <h3>desiredCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">desiredCapabilities</span>() |
| throws <span class="exceptions"><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>any desired capabilities provided from the remote once the connection has successfully opened.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |