| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>Stream.Server.Listener (Eclipse Jetty API Doc - v10.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.http3.api, interface: Stream, interface: Server, 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/Stream.Server.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.eclipse.jetty.http3.api</a></div> |
| <h1 title="Interface Stream.Server.Listener" class="title">Interface Stream.Server.Listener</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">Stream.Server.Listener</span></div> |
| <div class="block"><p>A <a href="Stream.Server.Listener.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Server.Listener</code></a> is the passive counterpart of a <a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Server</code></a> |
| and receives server-side events happening on an HTTP/3 stream.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream.Server</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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="#onDataAvailable(org.eclipse.jetty.http3.api.Stream.Server)" class="member-name-link">onDataAvailable</a><wbr>(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream)</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 if the application has expressed |
| <a href="Stream.html#demand()"><code>demand</code></a> for content, and if there may |
| be content available.</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.http3.api.Stream.Server,long,java.lang.Throwable)" class="member-name-link">onFailure</a><wbr>(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| long error, |
| <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> 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 a stream failure occurred.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onIdleTimeout(org.eclipse.jetty.http3.api.Stream.Server,java.lang.Throwable)" class="member-name-link">onIdleTimeout</a><wbr>(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| <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> failure)</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 stream idle timeout elapses.</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="#onTrailer(org.eclipse.jetty.http3.api.Stream.Server,org.eclipse.jetty.http3.frames.HeadersFrame)" class="member-name-link">onTrailer</a><wbr>(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</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 a trailer is received.</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="onDataAvailable(org.eclipse.jetty.http3.api.Stream.Server)"> |
| <h3>onDataAvailable</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">onDataAvailable</span><wbr><span class="parameters">(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream)</span></div> |
| <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="Stream.Client.Listener.html#onResponse(org.eclipse.jetty.http3.api.Stream.Client,org.eclipse.jetty.http3.frames.HeadersFrame)"><code>Stream.Client.Listener.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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StackOverflowError.html" title="class or interface in java.lang" class="external-link"><code>StackOverflowError</code></a>.</p> |
| <p>Typical usage:</p> |
| <pre> |
| class MyStreamListener implements Stream.Server.Listener |
| { |
| @Override |
| public void onDataAvailable(Stream.Server 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onTrailer(org.eclipse.jetty.http3.api.Stream.Server,org.eclipse.jetty.http3.frames.HeadersFrame)"> |
| <h3>onTrailer</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">onTrailer</span><wbr><span class="parameters">(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| <a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a> frame)</span></div> |
| <div class="block"><p>Callback method invoked when a trailer is received.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>frame</code> - the HEADERS frame containing the trailer headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onIdleTimeout(org.eclipse.jetty.http3.api.Stream.Server,java.lang.Throwable)"> |
| <h3>onIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">onIdleTimeout</span><wbr><span class="parameters">(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| <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> failure)</span></div> |
| <div class="block"><p>Callback method invoked when the stream idle timeout elapses.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream</dd> |
| <dd><code>failure</code> - the timeout failure</dd> |
| <dt>Returns:</dt> |
| <dd>true to reset the stream, false to ignore the idle timeout</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFailure(org.eclipse.jetty.http3.api.Stream.Server,long,java.lang.Throwable)"> |
| <h3>onFailure</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">onFailure</span><wbr><span class="parameters">(<a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a> stream, |
| long error, |
| <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> failure)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
