| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 --> |
| <title>Stream.Client.Listener (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="Stream.Client.Listener (Eclipse Jetty API Doc - v10.0.8)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default 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/Stream.Client.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">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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.http3.api</a></div> |
| <h2 title="Interface Stream.Client.Listener" class="title">Interface Stream.Client.Listener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a></dd> |
| </dl> |
| <hr> |
| <pre>public static interface <span class="typeNameLabel">Stream.Client.Listener</span></pre> |
| <div class="block"><p>A <a href="Stream.Client.Listener.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Client.Listener</code></a> is the passive counterpart of a <a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Client</code></a> |
| and receives client-side events happening on an HTTP/3 stream.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Client</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onDataAvailable(org.eclipse.jetty.http3.api.Stream.Client)">onDataAvailable</a></span>​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked if the application has expressed |
| <a href="Stream.html#demand()"><code>demand</code></a> for content, and if there may |
| be content available.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFailure(org.eclipse.jetty.http3.api.Stream.Client,long,java.lang.Throwable)">onFailure</a></span>​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| long error, |
| java.lang.Throwable failure)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked when a stream failure occurred.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onIdleTimeout(org.eclipse.jetty.http3.api.Stream.Client,java.lang.Throwable)">onIdleTimeout</a></span>​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| java.lang.Throwable failure)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked when the stream idle timeout elapses.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponse(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)">onResponse</a></span>​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked when a response is received.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onTrailer(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)">onTrailer</a></span>​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked when a trailer is received.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="onResponse(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponse</h4> |
| <pre class="methodSignature">default void onResponse​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</pre> |
| <div class="block"><p>Callback method invoked when a response is received.</p> |
| <p>To read response content, applications should call |
| <a href="Stream.html#demand()"><code>Stream.demand()</code></a> and override |
| <a href="#onDataAvailable(org.eclipse.jetty.http3.api.Stream.Client)"><code>onDataAvailable(Client)</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>frame</code> - the HEADERS frame containing the response headers</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#onDataAvailable(org.eclipse.jetty.http3.api.Stream.Client)"><code>onDataAvailable(Client)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onDataAvailable(org.eclipse.jetty.http3.api.Stream.Client)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onDataAvailable</h4> |
| <pre class="methodSignature">default void onDataAvailable​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream)</pre> |
| <div class="block"><p>Callback method invoked if the application has expressed |
| <a href="Stream.html#demand()"><code>demand</code></a> for content, and if there may |
| be content available.</p> |
| <p>A server application that wishes to handle request content |
| should typically call <a href="Stream.html#demand()"><code>Stream.demand()</code></a> from |
| <a href="Session.Server.Listener.html#onRequest(org.eclipse.jetty.http3.api.Stream.Server,org.eclipse.jetty.http3.frames.HeadersFrame)"><code>Session.Server.Listener.onRequest(Server, HeadersFrame)</code></a>.</p> |
| <p>A client application that wishes to handle response content |
| should typically call <a href="Stream.html#demand()"><code>Stream.demand()</code></a> from |
| <a href="#onResponse(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)"><code>onResponse(Client, HeadersFrame)</code></a>.</p> |
| <p>Just prior calling this method, the outstanding demand is |
| cancelled; applications that implement this method should read |
| content calling <a href="Stream.html#readData()"><code>Stream.readData()</code></a>, and call |
| <a href="Stream.html#demand()"><code>Stream.demand()</code></a> to signal to the implementation to call |
| again this method when there may be more content available.</p> |
| <p>Only one thread at a time invokes this method, although it |
| may not be the same thread across different invocations.</p> |
| <p>It is always guaranteed that invoking <a href="Stream.html#demand()"><code>Stream.demand()</code></a> |
| from within this method will not cause a <code>StackOverflowError</code>.</p> |
| <p>Typical usage:</p> |
| <pre> |
| class MyStreamListener implements Stream.Client.Listener |
| { |
| @Override |
| public void onDataAvailable(Stream.Client stream) |
| { |
| // Read a chunk of the content. |
| Stream.Data data = stream.readData(); |
| if (data == null) |
| { |
| // No data available now, demand to be called back. |
| stream.demand(); |
| } |
| else |
| { |
| // Process the content. |
| process(data.getByteBuffer()); |
| // Notify that the content has been consumed. |
| data.complete(); |
| if (!data.isLast()) |
| { |
| // Demand to be called back. |
| stream.demand(); |
| } |
| } |
| } |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onTrailer(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTrailer</h4> |
| <pre class="methodSignature">default void onTrailer​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</pre> |
| <div class="block"><p>Callback method invoked when a trailer is received.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>frame</code> - the HEADERS frame containing the trailer headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onIdleTimeout(org.eclipse.jetty.http3.api.Stream.Client,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onIdleTimeout</h4> |
| <pre class="methodSignature">default boolean onIdleTimeout​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| java.lang.Throwable failure)</pre> |
| <div class="block"><p>Callback method invoked when the stream idle timeout elapses.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>failure</code> - the timeout failure</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true to reset the stream, false to ignore the idle timeout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onFailure(org.eclipse.jetty.http3.api.Stream.Client,long,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onFailure</h4> |
| <pre class="methodSignature">default void onFailure​(<a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a> stream, |
| long error, |
| java.lang.Throwable failure)</pre> |
| <div class="block"><p>Callback method invoked when a stream failure occurred.</p> |
| <p>Typical stream failures, among others, are failures to |
| decode a HEADERS frame, or failures to read bytes because |
| the stream has been reset.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>error</code> - the failure error</dd> |
| <dd><code>failure</code> - the cause of the failure</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/Stream.Client.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">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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
