blob: de41dda4ba590b92f79783193b6f09195f7e72a1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>Stream.Server (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">
<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.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.http3.api</a></div>
<h1 title="Interface Stream.Server" class="title">Interface Stream.Server</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing interface:</dt>
<dd><a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">Stream.Server</span><span class="extends-implements">
extends <a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a></span></div>
<div class="block"><p>The server side version of <a href="Stream.html" title="interface in org.eclipse.jetty.http3.api"><code>Stream</code></a>.</p></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 interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Stream.Server.Listener.html" class="type-name-link" title="interface in org.eclipse.jetty.http3.api">Stream.Server.Listener</a></code></div>
<div class="col-last even-row-color">
<div class="block">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.</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.http3.api.Stream">Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.http3.api.<a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a></h2>
<code><a href="Stream.Client.html" title="interface in org.eclipse.jetty.http3.api">Stream.Client</a>, <a href="Stream.Data.html" title="class in org.eclipse.jetty.http3.api">Stream.Data</a>, <a href="Stream.Server.html" title="interface in org.eclipse.jetty.http3.api">Stream.Server</a></code></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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#respond(org.eclipse.jetty.http3.frames.HeadersFrame)" class="member-name-link">respond</a><wbr>(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Responds to a request performed via <a href="Session.Client.html#newRequest(org.eclipse.jetty.http3.frames.HeadersFrame,org.eclipse.jetty.http3.api.Stream.Client.Listener)"><code>Session.Client.newRequest(HeadersFrame, Client.Listener)</code></a>,
sending the given HEADERS frame containing the response status code and response headers.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.http3.api.Stream">Methods inherited from interface&nbsp;org.eclipse.jetty.http3.api.<a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a></h3>
<code><a href="Stream.html#data(org.eclipse.jetty.http3.frames.DataFrame)">data</a>, <a href="Stream.html#demand()">demand</a>, <a href="Stream.html#getId()">getId</a>, <a href="Stream.html#getSession()">getSession</a>, <a href="Stream.html#readData()">readData</a>, <a href="Stream.html#reset(long,java.lang.Throwable)">reset</a>, <a href="Stream.html#trailer(org.eclipse.jetty.http3.frames.HeadersFrame)">trailer</a></code></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="respond(org.eclipse.jetty.http3.frames.HeadersFrame)">
<h3>respond</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http3.api">Stream</a>&gt;</span>&nbsp;<span class="element-name">respond</span><wbr><span class="parameters">(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http3.frames">HeadersFrame</a>&nbsp;frame)</span></div>
<div class="block"><p>Responds to a request performed via <a href="Session.Client.html#newRequest(org.eclipse.jetty.http3.frames.HeadersFrame,org.eclipse.jetty.http3.api.Stream.Client.Listener)"><code>Session.Client.newRequest(HeadersFrame, Client.Listener)</code></a>,
sending the given HEADERS frame containing the response status code and response headers.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the HEADERS frame containing the response headers</dd>
<dt>Returns:</dt>
<dd>the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a> that gets notified when the frame has been sent</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>