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

    let (send_request, connection) = client::handshake(my_io).await?;
    // Submit the connection handle to an executor.
    tokio::spawn(async { connection.await.expect("connection failed"); });

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

Methods

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

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 + Unpin,
    B: IntoBuf + Unpin,
    B::Buf: Unpin, 

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.