Struct h2::server::Connection
source · pub struct Connection<T, B: IntoBuf> { /* private fields */ }
Expand description
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`.
})
})
Implementations
sourceimpl<T, B> Connection<T, B>where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
impl<T, B> Connection<T, B>where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
sourcepub fn set_target_window_size(&mut self, size: u32)
pub fn set_target_window_size(&mut self, size: u32)
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.
sourcepub fn poll_close(&mut self) -> Poll<(), Error>
pub fn poll_close(&mut self) -> Poll<(), Error>
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.
sourcepub fn abrupt_shutdown(&mut self, reason: Reason)
pub fn abrupt_shutdown(&mut self, reason: Reason)
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
.
sourcepub fn graceful_shutdown(&mut self)
pub fn graceful_shutdown(&mut self)
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.
Trait Implementations
sourceimpl<T, B> Stream for Connection<T, B>where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
B::Buf: 'static,
impl<T, B> Stream for Connection<T, B>where
T: AsyncRead + AsyncWrite,
B: IntoBuf,
B::Buf: 'static,
type Item = (Request<RecvStream>, SendResponse<B>)
type Item = (Request<RecvStream>, SendResponse<B>)
sourcefn poll(&mut self) -> Poll<Option<Self::Item>, Error>
fn poll(&mut self) -> Poll<Option<Self::Item>, Error>
None
if
the stream is finished. Read moresourcefn wait(self) -> Wait<Self>where
Self: Sized,
fn wait(self) -> Wait<Self>where
Self: Sized,
sourcefn into_future(self) -> StreamFuture<Self>where
Self: Sized,
fn into_future(self) -> StreamFuture<Self>where
Self: Sized,
Future
. Read moresourcefn filter<F>(self, f: F) -> Filter<Self, F>where
F: FnMut(&Self::Item) -> bool,
Self: Sized,
fn filter<F>(self, f: F) -> Filter<Self, F>where
F: FnMut(&Self::Item) -> bool,
Self: Sized,
sourcefn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
sourcefn then<F, U>(self, f: F) -> Then<Self, F, U>where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
fn then<F, U>(self, f: F) -> Then<Self, F, U>where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
f
. Read moresourcefn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
f
. Read moresourcefn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
f
. Read moresourcefn collect(self) -> Collect<Self>where
Self: Sized,
fn collect(self) -> Collect<Self>where
Self: Sized,
sourcefn 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>,
Self: Sized,
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>,
Self: Sized,
sourcefn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
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>,
Self: Sized,
true
. Read moresourcefn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
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>,
Self: Sized,
true
. Read moresourcefn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
sourcefn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
fn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
From
for
this stream’s Error
, returning a new stream. Read moresourcefn take(self, amt: u64) -> Take<Self>where
Self: Sized,
fn take(self, amt: u64) -> Take<Self>where
Self: Sized,
amt
items of the underlying stream. Read moresourcefn skip(self, amt: u64) -> Skip<Self>where
Self: Sized,
fn skip(self, amt: u64) -> Skip<Self>where
Self: Sized,
amt
items of the underlying stream. Read moresourcefn fuse(self) -> Fuse<Self>where
Self: Sized,
fn fuse(self) -> Fuse<Self>where
Self: Sized,
poll
will never again be called once it has
finished. Read moresourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
sourcefn merge<S>(self, other: S) -> Merge<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
fn merge<S>(self, other: S) -> Merge<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
select
nowsourcefn zip<S>(self, other: S) -> Zip<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
fn zip<S>(self, other: S) -> Zip<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
sourcefn chain<S>(self, other: S) -> Chain<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
fn chain<S>(self, other: S) -> Chain<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
sourcefn peekable(self) -> Peekable<Self>where
Self: Sized,
fn peekable(self) -> Peekable<Self>where
Self: Sized,
peek
method. Read more