Struct radiorust::blocks::buffering::Buffer

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

Buffering mechanism for Temporal data

This struct is a Consumer and Producer which forwards data from a connected Producer to all connected Consumers while performing buffering.

This block may also be used to “suck” parasitic buffers empty. As each flow::Sender has a capacity of 1 (see underlying broadcast_bp channel), a chain of blocks may accumulate a significant buffer volume. This may be unwanted. By placing a Buffer block near the end of the chain and providing a max_age argument equal to or smaller than max_capacity to Buffer::new, the buffer block will consume (and discard) data even when its connected consumer isn’t fast enough.

Implementations

impl<T> Buffer<T>where
    T: Clone + Send + Sync + 'static,
    T: Temporal,

pub fn new(
    initial_capacity: f64,
    min_capacity: f64,
    max_capacity: f64,
    max_age: f64
) -> Self

Create new Buffer

The buffer will start with buffering initial_capacity seconds of data before beginning to send out received data. When empty, the buffer will buffer data corresponding to a duration of at least min_capacity seconds before sending out data again. It will suspend receiving when holding strictly more than max_capacity seconds of data. If buffered data is held longer than max_age seconds, it will be discarded.

Trait Implementations

impl<T> Consumer<T> for Buffer<T>

fn receiver_connector(&self) -> &ReceiverConnector<T>

Obtain reference to ReceiverConnector

fn feed_from<P: Producer<T>>(&self, producer: &P)

Connect Consumer to Producer

fn feed_from_none(&self)

Disconnect Consumer from any connected Producer if connected

fn connect_to_producer<P: Producer<T>>(&self, producer: &P)

👎Deprecated since 0.2.0: method has been renamed to feed_from

Connect Consumer to Producer

fn disconnect_from_producer(&self)

👎Deprecated since 0.2.0: method has been renamed to feed_from_none

Disconnect Consumer from any connected Producer if connected

impl<T> Producer<T> for Buffer<T>

fn sender_connector(&self) -> &SenderConnector<T>

Obtain reference to SenderConnector

fn feed_into<C: Consumer<T>>(&self, consumer: &C)

Connect Producer to Consumer

fn connect_to_consumer<C: Consumer<T>>(&self, consumer: &C)

👎Deprecated since 0.2.0: method has been renamed to feed_into

Connect Producer to Consumer