Struct h2::PingPong

pub struct PingPong { /* fields omitted */ }

A handle to send and receive PING frames with the peer.

Methods

impl PingPong

pub fn send_ping(&mut self, ping: Ping) -> Result<(), Error>

Send a PING frame to the peer.

Only one ping can be pending at a time, so trying to send while a pong has not be received means this will return a user error.

Example

// let mut ping_pong = ...
ping_pong
    .send_ping(h2::Ping::opaque())
    .unwrap();

pub fn poll_pong(&mut self) -> Poll<Pong, Error>

Polls for the acknowledgement of a previously sent PING frame.

Example

// let mut ping_pong = ...

// First, send a PING.
ping_pong
    .send_ping(h2::Ping::opaque())
    .unwrap();

// And then wait for the PONG.
futures::future::poll_fn(move || {
    ping_pong.poll_pong()
}).wait().unwrap();

Trait Implementations

impl Debug for PingPong

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

Formats the value using the given formatter.