| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ClientInstance (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.impl, class: ClientInstance"> |
| <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/ClientInstance.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.impl</a></div> |
| <h1 title="Class ClientInstance" class="title">Class ClientInstance</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.impl.ClientInstance</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</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>, <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ClientInstance</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></span></div> |
| <div class="block">Container of <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances that are all created with the same |
| container parent and therefore share the same container Id.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Closes all currently open <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances created by this client.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"> |
| <div class="block">Closes all currently open <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances created by this client.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><code><a href="#connect(java.lang.String)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to the specified host, using the default port, without credentials and with all |
| connection options set to their defaults.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><code><a href="#connect(java.lang.String,int)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to the specified host and port, without credentials and with all |
| connection options set to their defaults.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><code><a href="#connect(java.lang.String,int,org.apache.qpid.protonj2.client.ConnectionOptions)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="../ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a> options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to the specified host and port, with given connection options.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><code><a href="#connect(java.lang.String,org.apache.qpid.protonj2.client.ConnectionOptions)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| <a href="../ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a> options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to the specified host, using the default port, without credentials and with all |
| connection options set to their defaults.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><code><a href="#containerId()" class="member-name-link">containerId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create()" class="member-name-link">create</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.qpid.protonj2.client.ClientOptions)" class="member-name-link">create</a><wbr>(<a href="../ClientOptions.html" title="class in org.apache.qpid.protonj2.client">ClientOptions</a> options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a new <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance using provided configuration options.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></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="create()"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></span> <span class="element-name">create</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a newly create <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientInstance</code></a> that uses default configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.qpid.protonj2.client.ClientOptions)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="../ClientOptions.html" title="class in org.apache.qpid.protonj2.client">ClientOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#create(org.apache.qpid.protonj2.client.ClientOptions)">Client</a></code></span></div> |
| <div class="block">Create a new <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance using provided configuration options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</code> - The configuration options to apply to the newly create <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientInstance</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>a newly create <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientInstance</code></a> that uses the configuration provided.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.String,int)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#connect(java.lang.String,int)">Client</a></code></span></div> |
| <div class="block">Connect to the specified host and port, without credentials and with all |
| connection options set to their defaults. |
| <p> |
| The connection returned may still fail afterwards as the majority of connection |
| setup is done asynchronously so the application should be prepared for errors to |
| arise of the connection methods if the open future is not waited on.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#connect(java.lang.String,int)">connect</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - the host to connect to</dd> |
| <dd><code>port</code> - the port to connect to</dd> |
| <dt>Returns:</dt> |
| <dd>connection, establishment not yet completed</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> is closed or an error occurs during connect.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.String,int,org.apache.qpid.protonj2.client.ConnectionOptions)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="../ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.ConnectionOptions)">Client</a></code></span></div> |
| <div class="block">Connect to the specified host and port, with given connection options. |
| <p> |
| The connection returned may still fail afterwards as the majority of connection |
| setup is done asynchronously so the application should be prepared for errors to |
| arise of the connection methods if the open future is not waited on.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#connect(java.lang.String,int,org.apache.qpid.protonj2.client.ConnectionOptions)">connect</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - the host to connect to</dd> |
| <dd><code>port</code> - the port to connect to</dd> |
| <dd><code>options</code> - options to use when creating the connection.</dd> |
| <dt>Returns:</dt> |
| <dd>connection, establishment not yet completed</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> is closed or an error occurs during connect.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.String)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#connect(java.lang.String)">Client</a></code></span></div> |
| <div class="block">Connect to the specified host, using the default port, without credentials and with all |
| connection options set to their defaults. |
| <p> |
| The connection returned may still fail afterwards as the majority of connection |
| setup is done asynchronously so the application should be prepared for errors to |
| arise of the connection methods if the open future is not waited on.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#connect(java.lang.String)">connect</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - the host to connect to</dd> |
| <dt>Returns:</dt> |
| <dd>connection, establishment not yet completed</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> is closed or an error occurs during connect.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.String,org.apache.qpid.protonj2.client.ConnectionOptions)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| <a href="../ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#connect(java.lang.String,org.apache.qpid.protonj2.client.ConnectionOptions)">Client</a></code></span></div> |
| <div class="block">Connect to the specified host, using the default port, without credentials and with all |
| connection options set to their defaults. |
| <p> |
| The connection returned may still fail afterwards as the majority of connection |
| setup is done asynchronously so the application should be prepared for errors to |
| arise of the connection methods if the open future is not waited on.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#connect(java.lang.String,org.apache.qpid.protonj2.client.ConnectionOptions)">connect</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - the host to connect to</dd> |
| <dd><code>options</code> - options to use when creating the connection.</dd> |
| <dt>Returns:</dt> |
| <dd>connection, establishment not yet completed</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> is closed or an error occurs during connect.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containerId()"> |
| <h3>containerId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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">containerId</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#containerId()">containerId</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the container id assigned to this <a href="../Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#close()">Client</a></code></span></div> |
| <div class="block">Closes all currently open <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances created by this client. |
| <p> |
| This method blocks and waits for each connection to close in turn using the configured |
| close timeout of the <a href="../ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> that the connection was created with.</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> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#close()">close</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeAsync()"> |
| <h3>closeAsync</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a>></span> <span class="element-name">closeAsync</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Client.html#closeAsync()">Client</a></code></span></div> |
| <div class="block">Closes all currently open <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances created by this client. |
| <p> |
| This method does not block and wait for each connection to be closed in turn, instead |
| it returns a future which will be completed once the close of all connections has been |
| completed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Client.html#closeAsync()">closeAsync</a></code> in interface <code><a href="../Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></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 all open connections have closed.</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> |
