Struct splinter::mesh::Mesh

pub struct Mesh { /* fields omitted */ }

A Connection reactor

Methods

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>) -> Result<usize, AddError>

Add a new connection to the mesh, moving it to the background thread, and return its id.

pub fn remove(&self, id: usize) -> 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(envelope.take_payload()).

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 outgoing(&self, id: usize) -> Option<Outgoing>

Create a new handle for sending to the existing connection with the given id.

This may be faster if many sends on the same Connection are going to be performed because the internal lock around the pool of senders does not need to be reacquired.

pub fn incoming(&self) -> Incoming

Create a new handle for receiving envelopes from the mesh.

This is useful if an object only needs to receive and doesn't need to send.

pub fn get_life_cycle(&self) -> MeshLifeCycle

pub fn get_sender(&self) -> MeshMatrixSender

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.