| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>Destination (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.client.api, interface: Destination"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.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"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</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/Destination.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#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 class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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.eclipse.jetty.client.api</a></div> |
| <h1 title="Interface Destination" class="title">Interface Destination</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../DuplexHttpDestination.html" title="class in org.eclipse.jetty.client">DuplexHttpDestination</a></code>, <code><a href="../HttpDestination.html" title="class in org.eclipse.jetty.client">HttpDestination</a></code>, <code><a href="../MultiplexHttpDestination.html" title="class in org.eclipse.jetty.client">MultiplexHttpDestination</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Destination</span></div> |
| <div class="block"><a href="Destination.html" title="interface in org.eclipse.jetty.client.api"><code>Destination</code></a> represents the triple made of the <a href="#getScheme()"><code>getScheme()</code></a>, the <a href="#getHost()"><code>getHost()</code></a> |
| and the <a href="#getPort()"><code>getPort()</code></a>. |
| <p> |
| <a href="Destination.html" title="interface in org.eclipse.jetty.client.api"><code>Destination</code></a> holds a pool of <a href="Connection.html" title="interface in org.eclipse.jetty.client.api"><code>Connection</code></a>s, but allows to create unpooled |
| connections if the application wants full control over connection management via <a href="#newConnection(org.eclipse.jetty.util.Promise)"><code>newConnection(Promise)</code></a>. |
| <p> |
| <a href="Destination.html" title="interface in org.eclipse.jetty.client.api"><code>Destination</code></a>s may be obtained via <a href="../HttpClient.html#resolveDestination(org.eclipse.jetty.client.api.Request)"><code>HttpClient.resolveDestination(Request)</code></a></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="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="#getHost()" class="member-name-link">getHost</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>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPort()" class="member-name-link">getPort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#getScheme()" class="member-name-link">getScheme</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="#newConnection(org.eclipse.jetty.util.Promise)" class="member-name-link">newConnection</a><wbr>(<a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="Connection.html" title="interface in org.eclipse.jetty.client.api">Connection</a>> promise)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates asynchronously a new, unpooled, <a href="Connection.html" title="interface in org.eclipse.jetty.client.api"><code>Connection</code></a> that will be returned |
| at a later time through the given <a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util"><code>Promise</code></a>.</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="getScheme()"> |
| <h3>getScheme</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">getScheme</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the scheme of this destination, such as "http" or "https"</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHost()"> |
| <h3>getHost</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">getHost</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the host of this destination, such as "127.0.0.1" or "google.com"</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPort()"> |
| <h3>getPort</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getPort</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the port of this destination such as 80 or 443</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newConnection(org.eclipse.jetty.util.Promise)"> |
| <h3>newConnection</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">newConnection</span><wbr><span class="parameters">(<a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="Connection.html" title="interface in org.eclipse.jetty.client.api">Connection</a>> promise)</span></div> |
| <div class="block">Creates asynchronously a new, unpooled, <a href="Connection.html" title="interface in org.eclipse.jetty.client.api"><code>Connection</code></a> that will be returned |
| at a later time through the given <a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util"><code>Promise</code></a>. |
| <p> |
| Use <a href="../../util/FuturePromise.html" title="class in org.eclipse.jetty.util"><code>FuturePromise</code></a> to wait for the connection: |
| <pre> |
| Destination destination = ...; |
| FuturePromise<Connection> futureConnection = new FuturePromise<>(); |
| destination.newConnection(futureConnection); |
| Connection connection = futureConnection.get(5, TimeUnit.SECONDS); |
| </pre></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>promise</code> - the promise of a new, unpooled, <a href="Connection.html" title="interface in org.eclipse.jetty.client.api"><code>Connection</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
