| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9) on Wed Nov 04 12:15:18 CST 2020 --> |
| <title>HttpClientTransport (Jetty :: Project 9.4.34.v20201102 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-11-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HttpClientTransport (Jetty :: Project 9.4.34.v20201102 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpClientTransport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.client</a></div> |
| <h2 title="Interface HttpClientTransport" class="title">Interface HttpClientTransport</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractConnectorHttpClientTransport.html" title="class in org.eclipse.jetty.client">AbstractConnectorHttpClientTransport</a></code>, <code><a href="AbstractHttpClientTransport.html" title="class in org.eclipse.jetty.client">AbstractHttpClientTransport</a></code>, <code><a href="../fcgi/client/http/HttpClientTransportOverFCGI.html" title="class in org.eclipse.jetty.fcgi.client.http">HttpClientTransportOverFCGI</a></code>, <code><a href="http/HttpClientTransportOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpClientTransportOverHTTP</a></code>, <code><a href="../http2/client/http/HttpClientTransportOverHTTP2.html" title="class in org.eclipse.jetty.http2.client.http">HttpClientTransportOverHTTP2</a></code>, <code><a href="../unixsocket/client/HttpClientTransportOverUnixSockets.html" title="class in org.eclipse.jetty.unixsocket.client">HttpClientTransportOverUnixSockets</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">HttpClientTransport</span> |
| extends <a href="../io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></pre> |
| <div class="block"><a href="HttpClientTransport.html" title="interface in org.eclipse.jetty.client"><code>HttpClientTransport</code></a> represents what transport implementations should provide |
| in order to plug-in a different transport for <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>. |
| <p> |
| While the <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> APIs define the HTTP semantic (request, response, headers, etc.) |
| <em>how</em> an HTTP exchange is carried over the network depends on implementations of this class. |
| <p> |
| The default implementation uses the HTTP protocol to carry over the network the HTTP exchange, |
| but the HTTP exchange may also be carried using the FCGI protocol, the HTTP/2 protocol or, |
| in future, other protocols.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.io.ClientConnectionFactory"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.io.<a href="../io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></h3> |
| <code><a href="../io/ClientConnectionFactory.Decorator.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory.Decorator</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HTTP_CONNECTION_PROMISE_CONTEXT_KEY">HTTP_CONNECTION_PROMISE_CONTEXT_KEY</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HTTP_DESTINATION_CONTEXT_KEY">HTTP_DESTINATION_CONTEXT_KEY</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.io.ClientConnectionFactory"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.io.<a href="../io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></h3> |
| <code><a href="../io/ClientConnectionFactory.html#CONNECTOR_CONTEXT_KEY">CONNECTOR_CONTEXT_KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect(java.net.InetSocketAddress,java.util.Map)">connect</a></span>​(java.net.InetSocketAddress address, |
| java.util.Map<java.lang.String,​java.lang.Object> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Establishes a physical connection to the given <code>address</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ConnectionPool.Factory.html" title="interface in org.eclipse.jetty.client">ConnectionPool.Factory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionPoolFactory()">getConnectionPoolFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="HttpDestination.html" title="class in org.eclipse.jetty.client">HttpDestination</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newHttpDestination(org.eclipse.jetty.client.Origin)">newHttpDestination</a></span>​(<a href="Origin.html" title="class in org.eclipse.jetty.client">Origin</a> origin)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new, transport-specific, <a href="HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectionPoolFactory(org.eclipse.jetty.client.ConnectionPool.Factory)">setConnectionPoolFactory</a></span>​(<a href="ConnectionPool.Factory.html" title="interface in org.eclipse.jetty.client">ConnectionPool.Factory</a> factory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHttpClient(org.eclipse.jetty.client.HttpClient)">setHttpClient</a></span>​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> instance on this transport.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.io.ClientConnectionFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.io.<a href="../io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></h3> |
| <code><a href="../io/ClientConnectionFactory.html#customize(org.eclipse.jetty.io.Connection,java.util.Map)">customize</a>, <a href="../io/ClientConnectionFactory.html#newConnection(org.eclipse.jetty.io.EndPoint,java.util.Map)">newConnection</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="HTTP_DESTINATION_CONTEXT_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HTTP_DESTINATION_CONTEXT_KEY</h4> |
| <pre>static final java.lang.String HTTP_DESTINATION_CONTEXT_KEY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.client.HttpClientTransport.HTTP_DESTINATION_CONTEXT_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HTTP_CONNECTION_PROMISE_CONTEXT_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HTTP_CONNECTION_PROMISE_CONTEXT_KEY</h4> |
| <pre>static final java.lang.String HTTP_CONNECTION_PROMISE_CONTEXT_KEY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.client.HttpClientTransport.HTTP_CONNECTION_PROMISE_CONTEXT_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setHttpClient(org.eclipse.jetty.client.HttpClient)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHttpClient</h4> |
| <pre class="methodSignature">void setHttpClient​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</pre> |
| <div class="block">Sets the <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> instance on this transport. |
| <p> |
| This is needed because of a chicken-egg problem: in order to create the <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> |
| a <a href="HttpClientTransport.html" title="interface in org.eclipse.jetty.client"><code>HttpClientTransport</code></a> is needed, that therefore cannot have a reference yet to the |
| <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the <a href="HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> that uses this transport.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newHttpDestination(org.eclipse.jetty.client.Origin)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newHttpDestination</h4> |
| <pre class="methodSignature"><a href="HttpDestination.html" title="class in org.eclipse.jetty.client">HttpDestination</a> newHttpDestination​(<a href="Origin.html" title="class in org.eclipse.jetty.client">Origin</a> origin)</pre> |
| <div class="block">Creates a new, transport-specific, <a href="HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object. |
| <p> |
| <a href="HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> controls the destination-connection cardinality: protocols like |
| HTTP have 1-N cardinality, while multiplexed protocols like HTTP/2 have a 1-1 cardinality.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>origin</code> - the destination origin</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new, transport-specific, <a href="HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="connect(java.net.InetSocketAddress,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre class="methodSignature">void connect​(java.net.InetSocketAddress address, |
| java.util.Map<java.lang.String,​java.lang.Object> context)</pre> |
| <div class="block">Establishes a physical connection to the given <code>address</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - the address to connect to</dd> |
| <dd><code>context</code> - the context information to establish the connection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConnectionPoolFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionPoolFactory</h4> |
| <pre class="methodSignature"><a href="ConnectionPool.Factory.html" title="interface in org.eclipse.jetty.client">ConnectionPool.Factory</a> getConnectionPoolFactory()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the factory for ConnectionPool instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConnectionPoolFactory(org.eclipse.jetty.client.ConnectionPool.Factory)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setConnectionPoolFactory</h4> |
| <pre class="methodSignature">void setConnectionPoolFactory​(<a href="ConnectionPool.Factory.html" title="interface in org.eclipse.jetty.client">ConnectionPool.Factory</a> factory)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>factory</code> - the factory for ConnectionPool instances</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpClientTransport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
