Struct CuSessionTracker 

pub struct CuSessionTracker { /* private fields */ }

Protocol-independent session rules shared by every bridge.

The bridge feeds it requests from Copper and events decoded from the controller. It owns no I/O and never allocates.

Implementations

impl CuSessionTracker

pub fn state(&self) -> &CuSessionState

Current state.

pub fn take_changed(&mut self) -> bool

True once since the last call if the state changed.

pub fn is_busy(&self) -> bool

True while a command is queued or awaiting its answer.

pub fn request(&mut self, command: CuSessionCommand) -> CuSessionDecision

Handle one request from Copper.

pub fn take_outgoing(&mut self) -> Option<CuSessionCommand>

The queued command, removed from the queue. Pass it to mark_sent once written.

pub fn mark_sent(&mut self, command: CuSessionCommand, sequence: u32)

Record that command went out with protocol sequence sequence.

pub fn on_acknowledged(&mut self, sequence: u32)

The controller accepted command sequence. Other sequences are ignored.

pub fn on_rejected(&mut self, sequence: u32, detail: &str)

The controller refused command sequence with detail.

pub fn on_control_report(&mut self, in_control: bool)

The controller reported whether this client is in control. On controllers that answer control requests this way instead of with an acknowledgement, it also completes a pending acquire or release.

pub fn on_drive_report(&mut self, drives_ready: bool, motion_allowed: bool)

The controller reported drive readiness and whether it would accept motion.

pub fn on_disconnected(&mut self)

The transport was lost: nothing is pending and nothing is held.

pub fn shutdown_step(&self) -> Option<CuSessionCommand>

Next command to wind the session down, or None once this session holds nothing: disable drives this session enabled, then release control this session acquired. Queue it with request when the tracker is not busy.

Trait Implementations

impl Clone for CuSessionTracker

fn clone(&self) -> CuSessionTracker

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CuSessionTracker

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

Formats the value using the given formatter.

impl Default for CuSessionTracker

fn default() -> CuSessionTracker

Returns the “default value” for a type.