juniper/solicit/http/session/index.html

190 lines
9 KiB
HTML
Raw Normal View History

2016-09-11 13:41:24 -05:00
<!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 `session` mod in crate `solicit`.">
<meta name="keywords" content="rust, rustlang, rust-lang, session">
<title>solicit::http::session - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a></p><script>window.sidebarCurrent = {name: 'session', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<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 mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a class='mod' href=''>session</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'>&#x2212;</span>]
</a>
</span><a id='src-966' class='srclink' href='../../../src/solicit/http/session.rs.html#1-500' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Defines the interface for the session-level management of HTTP/2
communication. This is effectively an API that allows hooking into an
HTTP/2 connection in order to handle events arising on the connection.</p>
<p>The module also provides a default implementation for some of the traits.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.DefaultSessionState.html'
title='solicit::http::session::DefaultSessionState'>DefaultSessionState</a></td>
<td class='docblock short'>
<p>An implementation of the <code>SessionState</code> trait that tracks the active streams in a <code>HashMap</code>,
mapping the stream ID to the concrete <code>Stream</code> instance.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.DefaultStream.html'
title='solicit::http::session::DefaultStream'>DefaultStream</a></td>
<td class='docblock short'>
<p>An implementation of the <code>Stream</code> trait that saves all headers and data
in memory.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.StreamIter.html'
title='solicit::http::session::StreamIter'>StreamIter</a></td>
<td class='docblock short'>
<p>A newtype for an iterator over <code>Stream</code>s saved in a <code>SessionState</code>.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class='enum' href='enum.StreamDataChunk.html'
title='solicit::http::session::StreamDataChunk'>StreamDataChunk</a></td>
<td class='docblock short'>
<p>The enum represents the successful completion of the <code>Stream::get_data_chunk</code> method.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.StreamDataError.html'
title='solicit::http::session::StreamDataError'>StreamDataError</a></td>
<td class='docblock short'>
<p>The enum represents errors that can be returned from the <code>Stream::get_data_chunk</code> method.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.StreamState.html'
title='solicit::http::session::StreamState'>StreamState</a></td>
<td class='docblock short'>
<p>The enum represents all the states that an HTTP/2 stream can be found in.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class='trait' href='trait.Session.html'
title='solicit::http::session::Session'>Session</a></td>
<td class='docblock short'>
<p>A trait that defines the interface between an <code>HttpConnection</code> and the higher-levels that use
it. Essentially, it allows the <code>HttpConnection</code> to pass information onto those higher levels
through a well-defined interface.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='trait' href='trait.SessionState.html'
title='solicit::http::session::SessionState'>SessionState</a></td>
<td class='docblock short'>
<p>A trait defining a set of methods for accessing and influencing an HTTP/2 session&#39;s state.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='trait' href='trait.Stream.html'
title='solicit::http::session::Stream'>Stream</a></td>
<td class='docblock short'>
<p>A trait representing a single HTTP/2 stream. An HTTP/2 connection multiplexes a number of
streams.</p>
</td>
</tr></table></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "solicit";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>