Struct solicit::http::client::ClientSession

pub struct ClientSession<'a, State, S> where
    State: SessionState + 'a,
    S: SendFrame + 'a,  { /* fields omitted */ }

An implementation of the Session trait specific to handling client HTTP/2 connections.

While handling the events signaled by the HttpConnection, the struct will modify the given session state appropriately.

The purpose of the type is to make it easier for client implementations to only handle stream-level events by providing a Stream implementation, instead of having to implement all session management callbacks.

For example, by varying the Stream implementation it is easy to implement a client that streams responses directly into a file on the local file system, instead of keeping it in memory (like the DefaultStream does), without having to change any HTTP/2-specific logic.

Implementations

impl<'a, State, S> ClientSession<'a, State, S> where
    State: SessionState + 'a,
    S: SendFrame + 'a, 

pub fn new(
    state: &'a mut State,
    sender: &'a mut S
) -> ClientSession<'a, State, S>

Returns a new ClientSession associated to the given state.

Trait Implementations

impl<'a, State, S> Session for ClientSession<'a, State, S> where
    State: SessionState + 'a,
    S: SendFrame + 'a, 

fn new_data_chunk(
    &mut self,
    stream_id: StreamId,
    data: &[u8],
    _: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that a new data chunk has arrived on the connection for a particular stream. Only the raw data is passed to the callback (all padding is already discarded by the connection).

fn new_headers<'n, 'v>(
    &mut self,
    stream_id: StreamId,
    headers: Vec<Header<'n, 'v>>,
    _conn: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that headers have arrived for a particular stream. The given list of headers is already decoded by the connection. TODO: The Session should be notified separately for every header that is decoded.

fn end_of_stream(
    &mut self,
    stream_id: StreamId,
    _: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that a particular stream got closed by the peer.

fn rst_stream(
    &mut self,
    stream_id: StreamId,
    error_code: ErrorCode,
    _: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that a particular stream was reset by the peer and provides the reason behind it.

fn new_settings(
    &mut self,
    _settings: Vec<HttpSetting>,
    conn: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that the peer has sent a new set of settings. The session itself is responsible for acknowledging the receipt of the settings.

fn on_ping(
    &mut self,
    ping: &PingFrame,
    conn: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that a PING request has been received. The session itself is responsible for replying with an ACK.

fn on_pong(
    &mut self,
    _ping: &PingFrame,
    _conn: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that a PING acknowledgement has been received.

fn on_goaway(
    &mut self,
    _last_stream_id: StreamId,
    error_code: ErrorCode,
    debug_data: Option<&[u8]>,
    _conn: &mut HttpConnection
) -> HttpResult<()>

Notifies the Session that the peer has sent a GOAWAY frame, indicating that the connection is terminated.