Struct AgentSession 

pub struct AgentSession { /* private fields */ }

The device agent’s end of the connection.

Implementations

impl AgentSession

pub fn new(config: AgentConfig, now: Instant) -> AgentSession

Starts the session; the hello is ready to send at once, and the welcome must arrive within the peer timeout.

pub fn receive(&mut self, bytes: &[u8], now: Instant)

Feeds bytes read from the connection.

pub fn receive_eof(&mut self, now: Instant)

The connection reached its end.

pub fn handle_timeout(&mut self, now: Instant)

Answers requests whose deadline passed and keeps the connection alive.

pub fn poll_timeout(&self) -> Option<Instant>

When handle_timeout must next run; None once closed.

pub fn deadline(&self, id: u32) -> Option<Instant>

The instant request id must be answered by, if it has a deadline.

pub fn respond(&mut self, id: u32, result: Result<Reply, Error>) -> Responded

Answers request id.

pub fn emit(&mut self, payload: EventPayload, time_us: u64) -> Option<u64>

Sends an event on its payload’s stream with the stream’s next sequence number and returns the number. None when the session is not ready, or when the event exceeds the negotiated frame size; its number is used up then, so the host sees the gap and asks for a resync.

pub fn skip_event(&mut self, stream: Stream) -> Option<u64>

Uses up the next sequence number of stream without sending an event, as when a full event queue drops one. The host sees the gap: a lossless stream then asks for a resync, a lossy one counts a drop.

pub fn last_seq(&self, stream: Stream) -> u64

The last sequence number sent or skipped on stream; 0 before the first.

pub fn poll_transmit(&mut self) -> Option<Vec<u8>>

Bytes to write to the connection.

pub fn poll_event(&mut self) -> Option<AgentEvent>

pub fn is_closed(&self) -> bool

pub fn close_reason(&self) -> Option<&DisconnectReason>

Why the session closed, once it has.

Trait Implementations

impl Debug for AgentSession

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

Formats the value using the given formatter.