Struct splinter::mesh::Mesh

pub struct Mesh { /* private fields */ }

A Connection reactor

Implementations

impl Mesh

pub fn new(incoming_capacity: usize, outgoing_capacity: usize) -> Self

Create a new mesh, spawning a background thread for sending and receiving, and setting up channels to communicate with it.

pub fn add(
    &self,
    connection: Box<dyn Connection>,
    unique_id: String
) -> Result<usize, AddError>

Add a new connection to the mesh, moving it to the background thread, and add the returned mesh id to the unique_ids map

pub fn remove(&self, unique_id: &str) -> Result<Box<dyn Connection>, RemoveError>

Remove an existing connection from the mesh and return it.

pub fn send(&self, envelope: Envelope) -> Result<(), SendError>

Send the envelope on the mesh.

This is a convenience function and is equivalent to mesh.outgoing(envelope.id()).send(Vec::from(envelope)).

pub fn recv(&self) -> Result<Envelope, RecvError>

Receive a new envelope from the mesh.

pub fn recv_timeout(
    &self,
    timeout: Duration
) -> Result<Envelope, RecvTimeoutError>

Receive a new envelope from the mesh.

pub fn get_life_cycle(&self) -> MeshLifeCycle

Creates a MeshLifeCycle that can be used to add and remove connection from this Mesh

pub fn get_sender(&self) -> MeshMatrixSender

Creates a MeshMatrixSender that can be used to send messages over through this Mesh

pub fn get_receiver(&self) -> MeshMatrixReceiver

Creates a MeshMatrixReceiver that can be used to receives message from this Mesh

Trait Implementations

impl Clone for Mesh

fn clone(&self) -> Mesh

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ShutdownHandle for Mesh

fn signal_shutdown(&mut self)

Instructs the component to begin shutting down.

fn wait_for_shutdown(self) -> Result<(), InternalError>

Waits until the the component has completely shutdown.