Struct h2::client::Connection

#[must_use = "futures do nothing unless polled"]
pub struct Connection<T, B: IntoBuf = Bytes> { /* fields omitted */ }

Manages all state associated with an HTTP/2.0 client connection.

A Connection is backed by an I/O resource (usually a TCP socket) and implements the HTTP/2.0 client logic for that connection. It is responsible for driving the internal state forward, performing the work requested of the associated handles (SendRequest, ResponseFuture, SendStream, RecvStream).

Connection values are created by calling handshake. Once a Connection value is obtained, the caller must repeatedly call poll until Ready is returned. The easiest way to do this is to submit the Connection instance to an executor.

Examples

client::handshake(my_io)
    .and_then(|(send_request, connection)| {
        // Submit the connection handle to an executor.
        my_executor.execute(
            connection.map_err(|_| panic!("connection failed"))
        ).unwrap();

        // Now, use `send_request` to initialize HTTP/2.0 streams.
        // ...
    })

Methods

impl<T, B> Connection<T, B> where
    T: AsyncRead + AsyncWrite,
    B: IntoBuf, 

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.

pub fn ping_pong(&mut self) -> Option<PingPong>

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: AsyncRead + AsyncWrite,
    T: Debug,
    B: Debug + IntoBuf,
    B::Buf: Debug, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T, B> Future for Connection<T, B> where
    T: AsyncRead + AsyncWrite,
    B: IntoBuf, 

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<(), Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.