Struct SessionContext 

pub struct SessionContext<'a> { /* private fields */ }

Everything a session may touch, for one call.

Implementations

impl SessionContext<'_>

pub fn info(&self) -> &ConnectionInfo

The connection’s facts.

pub fn output(&mut self) -> &mut Output

The output queue.

pub fn now(&self) -> Instant

The worker’s clock.

pub fn set_phase(&mut self, phase: Phase)

Chooses which deadlines run.

pub fn set_exchange_deadline(&mut self, at: Option<Instant>)

The deadline for the current exchange (None clears it).

pub fn set_idle_timeout(&mut self, timeout: Option<Duration>)

Overrides this connection’s idle timeout from its next wait for an exchange on; None restores the listener’s limit. For example, a protocol shortens keep-alive while the worker pool is nearly full. Values below the timer tick are raised to one tick.

use std::time::Duration;
use net_io::{Input, Session, SessionContext, Step};

struct KeepAlive;
impl Session for KeepAlive {
    fn on_data(&mut self, cx: &mut SessionContext<'_>, input: &mut Input) -> Step {
        let n = input.bytes().len();
        input.consume(n);
        let short = (cx.pressure() > 0.75).then_some(Duration::from_secs(2));
        cx.set_idle_timeout(short);
        Step::Write
    }
}

pub fn draining(&self) -> bool

Whether drain started: finish the current exchange, then close.

pub fn pressure(&self) -> f32

0.0 to 1.0: busy workers (blocking driver); 1.0 while the control line sheds.

pub fn kill_handle(&self) -> KillHandle

A handle other threads can use to abort this connection.

pub fn completer(&self) -> Completer

This worker’s completion queue.

pub fn worker(&self) -> WorkerId

The worker that runs this connection.

pub fn buffers(&mut self) -> &mut BufferPool

This worker’s buffer pool.

pub fn release(&mut self, buffer: Buffer)

Returns a buffer (for example one taken by Input::swap); it is wiped.

pub fn grow_input(&mut self, class: SizeClass) -> Result<(), NetError>

Moves the unconsumed input into a buffer of class after this call returns.

Errors

Limit { which: ReadBuffer } above the maximum read class.

Trait Implementations

impl Debug for SessionContext<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.