Struct ipmpsc::Sender

pub struct Sender(_);

Represents the sending end of an inter-process channel.

Implementations

impl Sender

pub fn new(buffer: SharedRingBuffer) -> Self

Constructs a Sender from the specified SharedRingBuffer

pub fn send(&self, value: &impl Serialize) -> Result<()>

Send the specified message, waiting for sufficient contiguous space to become available in the ring buffer if necessary.

The serialized size of the message must be greater than zero or else this method will return Err(Error::ZeroSizedMessage)). If the serialized size is greater than the ring buffer capacity, this method will return Err(Error::MessageTooLarge)).

pub fn send_timeout(
    &self,
    value: &impl Serialize,
    timeout: Duration
) -> Result<bool>

Send the specified message, waiting for sufficient contiguous space to become available in the ring buffer if necessary, but only up to the specified timeout.

This will return Ok(true) if the message was sent, or Ok(false) if it timed out while waiting.

The serialized size of the message must be greater than zero or else this method will return Err(Error::ZeroSizedMessage)). If the serialized size is greater than the ring buffer capacity, this method will return Err(Error::MessageTooLarge)).

pub fn send_when_empty(&self, value: &impl Serialize) -> Result<()>

Send the specified message, waiting for the ring buffer to become completely empty first.

This method is appropriate for sending time-sensitive messages where buffering would introduce undesirable latency.

The serialized size of the message must be greater than zero or else this method will return Err(Error::ZeroSizedMessage)). If the serialized size is greater than the ring buffer capacity, this method will return Err(Error::MessageTooLarge)).

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

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

Performs copy-assignment from source.