Struct MessageTx 

pub struct MessageTx<T> { /* private fields */ }

Message transmitter using a double-buffer queue

This is similar to DoubleBufferTx<Message<T>> with the main difference that push automatically creates a Message.

Implementations

impl<T> MessageTx<T>

pub fn new(capacity: usize) -> Self

Creates a new transmitter which can publish at most the given number of messages per step.

pub fn new_auto_size() -> Self

Creates a new transmitter which can publish an unbounded number of messages per step. Not recommended as it can lead to queues growing without bound.

pub fn push(&mut self, acqtime: Acqtime, value: T) -> Result<(), TxSendError>

Adds a Message to the transmitter with given acqtime and value. The message “pubtime” is set to the current time and the message sequence number is automatically incremented. Messages are published after the step functions concludes.

pub fn push_many<I: IntoIterator<Item = (Acqtime, T)>>( &mut self, values: I, ) -> Result<(), TxSendError>

Adds multiple messages to the transmitter (see push).

Trait Implementations

impl<T: Send + Sync + Clone> Tx for MessageTx<T>

fn flush(&mut self) -> FlushResult

Finalizes sending of messages

fn is_connected(&self) -> bool

Returns true if the channel is connected

fn len(&self) -> usize

Number of messages currently in the outbox

impl<V: Send + Sync + Clone> TxConnectable for MessageTx<V>

type Message = Message<V>

Type of message this endpoint transmits

fn has_max_connection_count(&self) -> bool

Returns true if transmitter can connect to more receivers

fn overflow_policy(&self) -> OverflowPolicy

Overflow policy of the transmitter

fn on_connect(&mut self, stage: SharedBackStage<Self::Message>)

Connects the transmitter to a receiver