Google Git
Sign in
eclipse / www.eclipse.org / jetty / 2015b9efe5c3a8d797f66738c80eeccc1b655d02 / . / javadoc / jetty-11 / org / eclipse / jetty / client / api / Request.Listener.html
blob: cb0d2c2dc2267e229d0bfa18cea84a1aeba93921 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 -->
<title>Request.Listener (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: Request, interface: Listener">
<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/Request.Listener.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.client.api</a></div>
<h1 title="Interface Request.Listener" class="title">Interface Request.Listener</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code>, <code><a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a></code>, <code><a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a></code>, <code><a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a></code>, <code><a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a></code>, <code><a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a></code>, <code><a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a></code>, <code><a href="Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a></code>, <code><a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="Request.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Request.Listener.Adapter</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing interface:</dt>
<dd><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">Request.Listener</span><span class="extends-implements">
extends <a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a>, <a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a>, <a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a>, <a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a>, <a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a>, <a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a>, <a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a></span></div>
<div class="block">Listener for all request events.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Request.Listener.Adapter.html" class="type-name-link" title="class in org.eclipse.jetty.client.api">Request.Listener.Adapter</a></code></div>
<div class="col-last even-row-color">
<div class="block">An empty implementation of <a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Listener</code></a></div>
</div>
</div>
</section>
</li>
<!-- ========== 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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onBegin(org.eclipse.jetty.client.api.Request)" class="member-name-link">onBegin</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request begins being processed in order to be sent.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onCommit(org.eclipse.jetty.client.api.Request)" class="member-name-link">onCommit</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request headers (and perhaps small content) have been sent.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onContent(org.eclipse.jetty.client.api.Request,java.nio.ByteBuffer)" class="member-name-link">onContent</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>&nbsp;content)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when a chunk of request content has been sent successfully.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onFailure(org.eclipse.jetty.client.api.Request,java.lang.Throwable)" class="member-name-link">onFailure</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;failure)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request has failed to be sent</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onHeaders(org.eclipse.jetty.client.api.Request)" class="member-name-link">onHeaders</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request headers (and perhaps small content) are ready to be sent.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onQueued(org.eclipse.jetty.client.api.Request)" class="member-name-link">onQueued</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request is queued, waiting to be sent</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onSuccess(org.eclipse.jetty.client.api.Request)" class="member-name-link">onSuccess</a><wbr>(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Callback method invoked when the request has been successfully sent.</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="onQueued(org.eclipse.jetty.client.api.Request)">
<h3>onQueued</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onQueued</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.QueuedListener.html#onQueued(org.eclipse.jetty.client.api.Request)">Request.QueuedListener</a></code></span></div>
<div class="block">Callback method invoked when the request is queued, waiting to be sent</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.QueuedListener.html#onQueued(org.eclipse.jetty.client.api.Request)">onQueued</a></code>&nbsp;in interface&nbsp;<code><a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request being queued</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onBegin(org.eclipse.jetty.client.api.Request)">
<h3>onBegin</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onBegin</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.BeginListener.html#onBegin(org.eclipse.jetty.client.api.Request)">Request.BeginListener</a></code></span></div>
<div class="block">Callback method invoked when the request begins being processed in order to be sent.
This is the last opportunity to modify the request.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.BeginListener.html#onBegin(org.eclipse.jetty.client.api.Request)">onBegin</a></code>&nbsp;in interface&nbsp;<code><a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request that begins being processed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onHeaders(org.eclipse.jetty.client.api.Request)">
<h3>onHeaders</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onHeaders</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.HeadersListener.html#onHeaders(org.eclipse.jetty.client.api.Request)">Request.HeadersListener</a></code></span></div>
<div class="block">Callback method invoked when the request headers (and perhaps small content) are ready to be sent.
The request has been converted into bytes, but not yet sent to the server, and further modifications
to the request may have no effect.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.HeadersListener.html#onHeaders(org.eclipse.jetty.client.api.Request)">onHeaders</a></code>&nbsp;in interface&nbsp;<code><a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request that is about to be committed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onCommit(org.eclipse.jetty.client.api.Request)">
<h3>onCommit</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onCommit</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.CommitListener.html#onCommit(org.eclipse.jetty.client.api.Request)">Request.CommitListener</a></code></span></div>
<div class="block">Callback method invoked when the request headers (and perhaps small content) have been sent.
The request is now committed, and in transit to the server, and further modifications to the
request may have no effect.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.CommitListener.html#onCommit(org.eclipse.jetty.client.api.Request)">onCommit</a></code>&nbsp;in interface&nbsp;<code><a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request that has been committed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onContent(org.eclipse.jetty.client.api.Request,java.nio.ByteBuffer)">
<h3>onContent</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onContent</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>&nbsp;content)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.ContentListener.html#onContent(org.eclipse.jetty.client.api.Request,java.nio.ByteBuffer)">Request.ContentListener</a></code></span></div>
<div class="block">Callback method invoked when a chunk of request content has been sent successfully.
Changes to bytes in the given buffer have no effect, as the content has already been sent.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.ContentListener.html#onContent(org.eclipse.jetty.client.api.Request,java.nio.ByteBuffer)">onContent</a></code>&nbsp;in interface&nbsp;<code><a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request that has been committed</dd>
<dd><code>content</code> - the content</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onSuccess(org.eclipse.jetty.client.api.Request)">
<h3>onSuccess</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onSuccess</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.SuccessListener.html#onSuccess(org.eclipse.jetty.client.api.Request)">Request.SuccessListener</a></code></span></div>
<div class="block">Callback method invoked when the request has been successfully sent.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.SuccessListener.html#onSuccess(org.eclipse.jetty.client.api.Request)">onSuccess</a></code>&nbsp;in interface&nbsp;<code><a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onFailure(org.eclipse.jetty.client.api.Request,java.lang.Throwable)">
<h3>onFailure</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onFailure</span><wbr><span class="parameters">(<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;request,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;failure)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Request.FailureListener.html#onFailure(org.eclipse.jetty.client.api.Request,java.lang.Throwable)">Request.FailureListener</a></code></span></div>
<div class="block">Callback method invoked when the request has failed to be sent</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Request.FailureListener.html#onFailure(org.eclipse.jetty.client.api.Request,java.lang.Throwable)">onFailure</a></code>&nbsp;in interface&nbsp;<code><a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a></code></dd>
<dt>Parameters:</dt>
<dd><code>request</code> - the request that failed</dd>
<dd><code>failure</code> - the failure</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>