blob: 54b083c7f4f29556dc03685182dd63eb2f569993 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:31 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HttpClientTransport (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpClientTransport (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/client/HttpConnection.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/client/HttpClientTransport.html" target="_top">Frames</a></li>
<li><a href="HttpClientTransport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.client</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><a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/eclipse/jetty/client/AbstractHttpClientTransport.html" title="class in org.eclipse.jetty.client">AbstractHttpClientTransport</a>, <a href="../../../../org/eclipse/jetty/fcgi/client/http/HttpClientTransportOverFCGI.html" title="class in org.eclipse.jetty.fcgi.client.http">HttpClientTransportOverFCGI</a>, <a href="../../../../org/eclipse/jetty/client/http/HttpClientTransportOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpClientTransportOverHTTP</a>, <a href="../../../../org/eclipse/jetty/http2/client/http/HttpClientTransportOverHTTP2.html" title="class in org.eclipse.jetty.http2.client.http">HttpClientTransportOverHTTP2</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">HttpClientTransport</span>
extends <a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></pre>
<div class="block"><a href="../../../../org/eclipse/jetty/client/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="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.
<p>
While the <a href="../../../../org/eclipse/jetty/client/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> a 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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpClientTransport.html#HTTP_CONNECTION_PROMISE_CONTEXT_KEY">HTTP_CONNECTION_PROMISE_CONTEXT_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpClientTransport.html#HTTP_DESTINATION_CONTEXT_KEY">HTTP_DESTINATION_CONTEXT_KEY</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.io.ClientConnectionFactory">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.io.<a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></h3>
<code><a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html#CONNECTOR_CONTEXT_KEY">CONNECTOR_CONTEXT_KEY</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpClientTransport.html#connect-java.net.InetSocketAddress-java.util.Map-">connect</a></span>(java.net.InetSocketAddress&nbsp;address,
java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;context)</code>
<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="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client">HttpDestination</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpClientTransport.html#newHttpDestination-org.eclipse.jetty.client.Origin-">newHttpDestination</a></span>(<a href="../../../../org/eclipse/jetty/client/Origin.html" title="class in org.eclipse.jetty.client">Origin</a>&nbsp;origin)</code>
<div class="block">Creates a new, transport-specific, <a href="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpClientTransport.html#setHttpClient-org.eclipse.jetty.client.HttpClient-">setHttpClient</a></span>(<a href="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client)</code>
<div class="block">Sets the <a href="../../../../org/eclipse/jetty/client/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 name="methods.inherited.from.class.org.eclipse.jetty.io.ClientConnectionFactory">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.io.<a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></h3>
<code><a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html#customize-org.eclipse.jetty.io.Connection-java.util.Map-">customize</a>, <a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html#newConnection-org.eclipse.jetty.io.EndPoint-java.util.Map-">newConnection</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="HTTP_DESTINATION_CONTEXT_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_DESTINATION_CONTEXT_KEY</h4>
<pre>static final&nbsp;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 name="HTTP_CONNECTION_PROMISE_CONTEXT_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HTTP_CONNECTION_PROMISE_CONTEXT_KEY</h4>
<pre>static final&nbsp;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>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setHttpClient-org.eclipse.jetty.client.HttpClient-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHttpClient</h4>
<pre>void&nbsp;setHttpClient(<a href="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a>&nbsp;client)</pre>
<div class="block">Sets the <a href="../../../../org/eclipse/jetty/client/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="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>
a <a href="../../../../org/eclipse/jetty/client/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="../../../../org/eclipse/jetty/client/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="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> that uses this transport.</dd>
</dl>
</li>
</ul>
<a name="newHttpDestination-org.eclipse.jetty.client.Origin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newHttpDestination</h4>
<pre><a href="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client">HttpDestination</a>&nbsp;newHttpDestination(<a href="../../../../org/eclipse/jetty/client/Origin.html" title="class in org.eclipse.jetty.client">Origin</a>&nbsp;origin)</pre>
<div class="block">Creates a new, transport-specific, <a href="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object.
<p>
<a href="../../../../org/eclipse/jetty/client/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="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client"><code>HttpDestination</code></a> object</dd>
</dl>
</li>
</ul>
<a name="connect-java.net.InetSocketAddress-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>connect</h4>
<pre>void&nbsp;connect(java.net.InetSocketAddress&nbsp;address,
java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;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>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../org/eclipse/jetty/client/HttpClient.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/client/HttpConnection.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/client/HttpClientTransport.html" target="_top">Frames</a></li>
<li><a href="HttpClientTransport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>