Struct SimNetHandle

pub struct SimNetHandle { /* private fields */ }

A handle to a running SimNet instance.

Implementations

impl SimNetHandle

pub fn send_event(&self, event: Box<dyn Event>) -> Result<(), SimNetError>

Sends an event to be scheduled onto the simnet’s event loop

pub fn send_nonadvanceable_event( &self, event: Box<dyn Event>, ) -> Result<(), SimNetError>

Sends an non-advanceable event to be scheduled onto the simnet’s event loop A non-advanceable event is an event that cannot advance the simnet’s time unless the earliest event in the simnet’s advancing event queue occurs after the earliest event in the simnet’s non-advancing event queue, or some debounce period has passed where there are only events in the simnet’s non-advancing event queue.

pub fn set_training_script_state(&self, state: TrainingScriptState)

Let the simnet know if the training script is running or waiting for the backend to return a future result.

pub fn bind(&self, address: ChannelAddr) -> Result<(), SimNetError>

Bind the given address to this simulator instance.

pub async fn close(&self) -> Result<Vec<SimulatorEventRecord>, JoinError>

Close the simulator, processing pending messages before completing the returned future.

pub async fn flush(&self, timeout: Duration) -> Result<(), SimNetError>

Wait for all of the received events to be scheduled for flight. It ticks the simnet time till all of the scheduled events are processed.

pub fn register_proc(&self, proc_id: ProcId, point: Point)

Register the location in resource space for a Proc

pub fn sample_latency(&self, src: &ProcId, dest: &ProcId) -> Duration

Sample a latency between two procs