187 lines
16 KiB
HTML
187 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
<meta name="generator" content="rustdoc">
|
|||
|
|
<meta name="description" content="API documentation for the Rust `ServerProto` trait in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, ServerProto">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::ServerProto - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc trait">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Trait ServerProto</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Request">Request</a><a href="#associatedtype.RequestBody">RequestBody</a><a href="#associatedtype.Response">Response</a><a href="#associatedtype.ResponseBody">ResponseBody</a><a href="#associatedtype.Error">Error</a><a href="#associatedtype.Transport">Transport</a><a href="#associatedtype.BindTransport">BindTransport</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.bind_transport">bind_transport</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>streaming</a>::<wbr><a href='index.html'>multiplex</a></p><script>window.sidebarCurrent = {name: 'ServerProto', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>streaming</a>::<wbr><a href='index.html'>multiplex</a>::<wbr><a class="trait" href=''>ServerProto</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/server.rs.html#38-68' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait ServerProto<T: 'static>: 'static {
|
|||
|
|
type <a href='#associatedtype.Request' class="type">Request</a>: 'static;
|
|||
|
|
type <a href='#associatedtype.RequestBody' class="type">RequestBody</a>: 'static;
|
|||
|
|
type <a href='#associatedtype.Response' class="type">Response</a>: 'static;
|
|||
|
|
type <a href='#associatedtype.ResponseBody' class="type">ResponseBody</a>: 'static;
|
|||
|
|
type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> + 'static;
|
|||
|
|
type <a href='#associatedtype.Transport' class="type">Transport</a>: <a class="trait" href="../../../tokio_proto/streaming/multiplex/trait.Transport.html" title="trait tokio_proto::streaming::multiplex::Transport">Transport</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ServerProto::RequestBody">RequestBody</a>, Item = <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Request" title="type tokio_proto::streaming::multiplex::ServerProto::Request">Request</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ServerProto::RequestBody">RequestBody</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</a>>, SinkItem = <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Response" title="type tokio_proto::streaming::multiplex::ServerProto::Response">Response</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.ResponseBody" title="type tokio_proto::streaming::multiplex::ServerProto::ResponseBody">ResponseBody</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</a>>>;
|
|||
|
|
type <a href='#associatedtype.BindTransport' class="type">BindTransport</a>: <a class="trait" href="../../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Transport" title="type tokio_proto::streaming::multiplex::ServerProto::Transport">Transport</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>;
|
|||
|
|
fn <a href='#tymethod.bind_transport' class='fnname'>bind_transport</a>(&self, io: T) -> Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.BindTransport" title="type tokio_proto::streaming::multiplex::ServerProto::BindTransport">BindTransport</a>;
|
|||
|
|
}</pre><div class='docblock'><p>A streaming, multiplexed server protocol.</p>
|
|||
|
|
<p>The <code>T</code> parameter is used for the I/O object used to communicate, which is
|
|||
|
|
supplied in <code>bind_transport</code>.</p>
|
|||
|
|
<p>For simple protocols, the <code>Self</code> type is often a unit struct. In more
|
|||
|
|
advanced cases, <code>Self</code> may contain configuration information that is used
|
|||
|
|
for setting up the transport in <code>bind_transport</code>.</p>
|
|||
|
|
<h2 id="considerations" class="section-header"><a href="#considerations">Considerations</a></h2>
|
|||
|
|
<p>There are some difficulties with implementing back pressure in the case
|
|||
|
|
that the wire protocol does not support a means by which backpressure can
|
|||
|
|
be signaled to the peer.</p>
|
|||
|
|
<p>The problem is the potential for deadlock:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>The server is busy processing requests on this connection, and stops
|
|||
|
|
reading frames from its transport.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Meanwhile, the processing logic is blocked waiting for another frame that
|
|||
|
|
is currently pending on the socket.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>To deal with this, once the connection's frame buffer is filled, a timeout
|
|||
|
|
is set. If no further frames are able to be read before the timeout expires,
|
|||
|
|
the connection is killed.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.Request' class='method'><span id='Request.t' class='invisible'><code>type <a href='#associatedtype.Request' class="type">Request</a>: 'static</code></span></h3><div class='docblock'><p>Request headers.</p>
|
|||
|
|
</div><h3 id='associatedtype.RequestBody' class='method'><span id='RequestBody.t' class='invisible'><code>type <a href='#associatedtype.RequestBody' class="type">RequestBody</a>: 'static</code></span></h3><div class='docblock'><p>Request body chunks.</p>
|
|||
|
|
</div><h3 id='associatedtype.Response' class='method'><span id='Response.t' class='invisible'><code>type <a href='#associatedtype.Response' class="type">Response</a>: 'static</code></span></h3><div class='docblock'><p>Response headers.</p>
|
|||
|
|
</div><h3 id='associatedtype.ResponseBody' class='method'><span id='ResponseBody.t' class='invisible'><code>type <a href='#associatedtype.ResponseBody' class="type">ResponseBody</a>: 'static</code></span></h3><div class='docblock'><p>Response body chunks.</p>
|
|||
|
|
</div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> + 'static</code></span></h3><div class='docblock'><p>Errors, which are used both for error frames and for the service itself.</p>
|
|||
|
|
</div><h3 id='associatedtype.Transport' class='method'><span id='Transport.t' class='invisible'><code>type <a href='#associatedtype.Transport' class="type">Transport</a>: <a class="trait" href="../../../tokio_proto/streaming/multiplex/trait.Transport.html" title="trait tokio_proto::streaming::multiplex::Transport">Transport</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ServerProto::RequestBody">RequestBody</a>, Item = <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Request" title="type tokio_proto::streaming::multiplex::ServerProto::Request">Request</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ServerProto::RequestBody">RequestBody</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</a>>, SinkItem = <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Response" title="type tokio_proto::streaming::multiplex::ServerProto::Response">Response</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.ResponseBody" title="type tokio_proto::streaming::multiplex::ServerProto::ResponseBody">ResponseBody</a>, Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</a>>></code></span></h3><div class='docblock'><p>The frame transport, which usually take <code>T</code> as a parameter.</p>
|
|||
|
|
</div><h3 id='associatedtype.BindTransport' class='method'><span id='BindTransport.t' class='invisible'><code>type <a href='#associatedtype.BindTransport' class="type">BindTransport</a>: <a class="trait" href="../../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Transport" title="type tokio_proto::streaming::multiplex::ServerProto::Transport">Transport</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code></span></h3><div class='docblock'><p>A future for initializing a transport from an I/O object.</p>
|
|||
|
|
<p>In simple cases, <code>Result<Self::Transport, Self::Error></code> often suffices.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.bind_transport' class='method'><span id='bind_transport.v' class='invisible'><code>fn <a href='#tymethod.bind_transport' class='fnname'>bind_transport</a>(&self, io: T) -> Self::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.BindTransport" title="type tokio_proto::streaming::multiplex::ServerProto::BindTransport">BindTransport</a></code></span></h3><div class='docblock'><p>Build a transport from the given I/O object, using <code>self</code> for any
|
|||
|
|
configuration.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../../implementors/tokio_proto/streaming/multiplex/trait.ServerProto.js">
|
|||
|
|
</script></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../../";
|
|||
|
|
window.currentCrate = "tokio_proto";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../../main.js"></script>
|
|||
|
|
<script defer src="../../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|