Struct MessageSystem

pub struct MessageSystem<M, B, L, N>
where
    M: MessageMetadata + Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + 'static,
    B: Backend<M> + Send + Sync + 'static,
    L: LocalDelivery<M> + Send + Sync + 'static,
    N: UnderlyingSessionTransport<Message = M> + Send + Sync + 'static,
{ /* private fields */ }

Implementations

impl<M, B, L, N> MessageSystem<M, B, L, N>

where M: MessageMetadata + Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + 'static, B: Backend<M> + Send + Sync + 'static, L: LocalDelivery<M> + Send + Sync + 'static, N: UnderlyingSessionTransport<Message = M> + Send + Sync + 'static,

pub async fn new( backend: B, local_delivery: L, network: N, ) -> Result<Self, BackendError>

pub async fn send_to( &self, to: M::PeerId, contents: impl Into<Vec<u8>>, ) -> Result<(), NetworkError>

The preferred entrypoint for sending messages. Unlike [Self::send_raw_message], this ensures the message is properly created

pub async fn send_raw_message(&self, message: M) -> Result<(), NetworkError>

This message should only be used internally or if the developer needs to manually create messages. In this case, the message ID must be an auto-incremented value to ensure uniqueness, and the source_id must match the ID of the node sending the message in the networking layer. Additionally, the source and destination fields cannot be the same

pub async fn shutdown(self, timeout: Duration) -> Result<(), NetworkError>

Shutdown the message system gracefully This will stop the background tasks and wait for pending outbound messages to be processed

Trait Implementations

impl<M, B, L, N> Clone for MessageSystem<M, B, L, N>

where M: MessageMetadata + Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + 'static, B: Backend<M> + Send + Sync + 'static, L: LocalDelivery<M> + Send + Sync + 'static, N: UnderlyingSessionTransport<Message = M> + Send + Sync + 'static,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, B, L, N> Drop for MessageSystem<M, B, L, N>

where M: MessageMetadata + Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + 'static, B: Backend<M> + Send + Sync + 'static, L: LocalDelivery<M> + Send + Sync + 'static, N: UnderlyingSessionTransport<Message = M> + Send + Sync + 'static,

fn drop(&mut self)

Executes the destructor for this type.