[−][src]Struct h2::server::Connection
Accepts inbound HTTP/2.0 streams on a connection.
A Connection
is backed by an I/O resource (usually a TCP socket) and
implements the HTTP/2.0 server logic for that connection. It is responsible
for receiving inbound streams initiated by the client as well as driving the
internal state forward.
Connection
values are created by calling handshake
. Once a
Connection
value is obtained, the caller must call poll
or
poll_close
in order to drive the internal connection state forward.
See module level documentation for more details
Examples
server::handshake(my_io) .and_then(|server| { server.for_each(|(request, respond)| { // Process the request and send the response back to the client // using `respond`. }) })
Methods
impl<T, B> Connection<T, B> where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
[src]
T: AsyncRead + AsyncWrite,
B: IntoBuf,
pub fn set_target_window_size(&mut self, size: u32)
[src]
Sets the target window size for the whole connection.
If size
is greater than the current value, then a WINDOW_UPDATE
frame will be immediately sent to the remote, increasing the connection
level window by size - current_value
.
If size
is less than the current value, nothing will happen
immediately. However, as window capacity is released by
ReleaseCapacity
instances, no WINDOW_UPDATE
frames will be sent
out until the number of "in flight" bytes drops below size
.
The default value is 65,535.
See ReleaseCapacity
documentation for more details.
pub fn poll_close(&mut self) -> Poll<(), Error>
[src]
Returns Ready
when the underlying connection has closed.
If any new inbound streams are received during a call to poll_close
,
they will be queued and returned on the next call to poll
.
This function will advance the internal connection state, driving
progress on all the other handles (e.g. RecvStream
and SendStream
).
See here for more details.
pub fn abrupt_shutdown(&mut self, reason: Reason)
[src]
Sets the connection to a GOAWAY state.
Does not terminate the connection. Must continue being polled to close connection.
After flushing the GOAWAY frame, the connection is closed. Any
outstanding streams do not prevent the connection from closing. This
should usually be reserved for shutting down when something bad
external to h2
has happened, and open streams cannot be properly
handled.
For graceful shutdowns, see graceful_shutdown
.
pub fn graceful_shutdown(&mut self)
[src]
Starts a graceful shutdown process.
Must continue being polled to close connection.
It's possible to receive more requests after calling this method, since they might have been in-flight from the client already. After about 1 RTT, no new requests should be accepted. Once all active streams have completed, the connection is closed.
pub fn ping_pong(&mut self) -> Option<PingPong>
[src]
Takes a PingPong
instance from the connection.
Note
This may only be called once. Calling multiple times will return None
.
Trait Implementations
impl<T, B> Debug for Connection<T, B> where
T: Debug,
B: Debug + IntoBuf,
B::Buf: Debug,
[src]
T: Debug,
B: Debug + IntoBuf,
B::Buf: Debug,
impl<T, B> Stream for Connection<T, B> where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
B::Buf: 'static,
[src]
T: AsyncRead + AsyncWrite,
B: IntoBuf,
B::Buf: 'static,
type Item = (Request<RecvStream>, SendResponse<B>)
The type of item this stream will yield on success.
type Error = Error
The type of error this stream may generate.
fn poll(&mut self) -> Poll<Option<Self::Item>, Error>
[src]
fn wait(self) -> Wait<Self>
[src]
fn into_future(self) -> StreamFuture<Self>
[src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U,
[src]
F: FnMut(Self::Item) -> U,
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U,
[src]
F: FnMut(Self::Error) -> U,
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
[src]
F: FnMut(Self::Item) -> Option<B>,
fn then<F, U>(self, f: F) -> Then<Self, F, U> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
[src]
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
[src]
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
[src]
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
fn collect(self) -> Collect<Self>
[src]
fn concat2(self) -> Concat2<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,
[src]
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,
fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
[src]
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T>,
Self::Error: From<<Fut as IntoFuture>::Error>,
[src]
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T>,
Self::Error: From<<Fut as IntoFuture>::Error>,
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
[src]
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
[src]
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
[src]
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
[src]
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
fn from_err<E>(self) -> FromErr<Self, E> where
E: From<Self::Error>,
[src]
E: From<Self::Error>,
fn take(self, amt: u64) -> Take<Self>
[src]
fn skip(self, amt: u64) -> Skip<Self>
[src]
fn fuse(self) -> Fuse<Self>
[src]
fn by_ref(&mut self) -> &mut Self
[src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
[src]
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
[src]
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
fn merge<S>(self, other: S) -> Merge<Self, S> where
S: Stream<Error = Self::Error>,
[src]
S: Stream<Error = Self::Error>,
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>,
[src]
S: Stream<Error = Self::Error>,
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
[src]
S: Stream<Item = Self::Item, Error = Self::Error>,
fn peekable(self) -> Peekable<Self>
[src]
fn chunks(self, capacity: usize) -> Chunks<Self>
[src]
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
[src]
S: Stream<Item = Self::Item, Error = Self::Error>,
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>,
[src]
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>,
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink,
[src]
Self: Sink,
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
[src]
F: FnMut(&Self::Item),
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error),
[src]
F: FnMut(&Self::Error),
Auto Trait Implementations
impl<T, B> Send for Connection<T, B> where
T: Send,
<B as IntoBuf>::Buf: Send,
T: Send,
<B as IntoBuf>::Buf: Send,
impl<T, B> Unpin for Connection<T, B> where
T: Unpin,
<B as IntoBuf>::Buf: Unpin,
T: Unpin,
<B as IntoBuf>::Buf: Unpin,
impl<T, B> Sync for Connection<T, B> where
T: Sync,
<B as IntoBuf>::Buf: Send + Sync,
T: Sync,
<B as IntoBuf>::Buf: Send + Sync,
impl<T, B> !UnwindSafe for Connection<T, B>
impl<T, B> !RefUnwindSafe for Connection<T, B>
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,