blob: f6583b5a6f7cb5ccf40a1770fba9d4540da3cc8b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>HttpSenderOverHTTP (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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="HttpSenderOverHTTP (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
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/HttpSenderOverHTTP.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.client.http</a></div>
<h2 title="Class HttpSenderOverHTTP" class="title">Class HttpSenderOverHTTP</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">org.eclipse.jetty.client.HttpSender</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.client.http.HttpSenderOverHTTP</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">HttpSenderOverHTTP</span>
extends <a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.http.HttpChannelOverHTTP)">HttpSenderOverHTTP</a></span>&#8203;(<a href="HttpChannelOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpChannelOverHTTP</a>&nbsp;channel)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</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">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dispose()">dispose</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="HttpChannelOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpChannelOverHTTP</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpChannel()">getHttpChannel</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isShutdown()">isShutdown</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">sendContent</a></span>&#8203;(<a href="../HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>&nbsp;exchange,
java.nio.ByteBuffer&nbsp;contentBuffer,
boolean&nbsp;lastContent,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Implementations should send the given HTTP content over the wire.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHeaders(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">sendHeaders</a></span>&#8203;(<a href="../HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>&nbsp;exchange,
java.nio.ByteBuffer&nbsp;contentBuffer,
boolean&nbsp;lastContent,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Implementations should send the HTTP headers over the wire, possibly with some content,
in a single write, and notify the given <code>callback</code> of the result of this operation.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.HttpSender">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.client.<a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></h3>
<code><a href="../HttpSender.html#abort(org.eclipse.jetty.client.HttpExchange,java.lang.Throwable)">abort</a>, <a href="../HttpSender.html#beginToHeaders(org.eclipse.jetty.client.HttpExchange)">beginToHeaders</a>, <a href="../HttpSender.html#expects100Continue(org.eclipse.jetty.client.api.Request)">expects100Continue</a>, <a href="../HttpSender.html#getHttpExchange()">getHttpExchange</a>, <a href="../HttpSender.html#headersToCommit(org.eclipse.jetty.client.HttpExchange)">headersToCommit</a>, <a href="../HttpSender.html#isFailed()">isFailed</a>, <a href="../HttpSender.html#proceed(org.eclipse.jetty.client.HttpExchange,java.lang.Throwable)">proceed</a>, <a href="../HttpSender.html#queuedToBegin(org.eclipse.jetty.client.HttpExchange)">queuedToBegin</a>, <a href="../HttpSender.html#relativize(java.lang.String)">relativize</a>, <a href="../HttpSender.html#send(org.eclipse.jetty.client.HttpExchange)">send</a>, <a href="../HttpSender.html#someToContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer)">someToContent</a>, <a href="../HttpSender.html#someToSuccess(org.eclipse.jetty.client.HttpExchange)">someToSuccess</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.eclipse.jetty.client.http.HttpChannelOverHTTP)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HttpSenderOverHTTP</h4>
<pre>public&nbsp;HttpSenderOverHTTP&#8203;(<a href="HttpChannelOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpChannelOverHTTP</a>&nbsp;channel)</pre>
</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="getHttpChannel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpChannel</h4>
<pre class="methodSignature">public&nbsp;<a href="HttpChannelOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpChannelOverHTTP</a>&nbsp;getHttpChannel()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../HttpSender.html#getHttpChannel()">getHttpChannel</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></dd>
</dl>
</li>
</ul>
<a id="sendHeaders(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendHeaders</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;sendHeaders&#8203;(<a href="../HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>&nbsp;exchange,
java.nio.ByteBuffer&nbsp;contentBuffer,
boolean&nbsp;lastContent,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../HttpSender.html#sendHeaders(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">HttpSender</a></code></span></div>
<div class="block"><p>Implementations should send the HTTP headers over the wire, possibly with some content,
in a single write, and notify the given <code>callback</code> of the result of this operation.</p>
<p>If there is more content to send, then <a href="../HttpSender.html#sendContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)"><code>HttpSender.sendContent(HttpExchange, ByteBuffer, boolean, Callback)</code></a>
will be invoked.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../HttpSender.html#sendHeaders(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">sendHeaders</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exchange</code> - the exchange</dd>
<dd><code>contentBuffer</code> - the content to send</dd>
<dd><code>lastContent</code> - whether the content is the last content to send</dd>
<dd><code>callback</code> - the callback to notify</dd>
</dl>
</li>
</ul>
<a id="sendContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendContent</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;sendContent&#8203;(<a href="../HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>&nbsp;exchange,
java.nio.ByteBuffer&nbsp;contentBuffer,
boolean&nbsp;lastContent,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../HttpSender.html#sendContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">HttpSender</a></code></span></div>
<div class="block"><p>Implementations should send the given HTTP content over the wire.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../HttpSender.html#sendContent(org.eclipse.jetty.client.HttpExchange,java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">sendContent</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exchange</code> - the exchange</dd>
<dd><code>contentBuffer</code> - the content to send</dd>
<dd><code>lastContent</code> - whether the content is the last content to send</dd>
<dd><code>callback</code> - the callback to notify</dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;reset()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../HttpSender.html#reset()">reset</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></dd>
</dl>
</li>
</ul>
<a id="dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;dispose()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../HttpSender.html#dispose()">dispose</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></dd>
</dl>
</li>
</ul>
<a id="isShutdown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShutdown</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isShutdown()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../HttpSender.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../HttpSender.html" title="class in org.eclipse.jetty.client">HttpSender</a></code></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/HttpSenderOverHTTP.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>