Struct Queue

pub struct Queue {
    pub sequence_no: u64,
    /* private fields */
}

Defines a queue entity.

Fields

sequence_no: u64

The sequence number.

Implementations

impl Queue

pub fn new() -> NewQueue

Create a new queue within Event computation.

pub fn is_empty(queue: Grc<Queue>) -> impl Event<Item = bool> + Clone

Test whether the queue is empty.

pub fn content(queue: Grc<Queue>) -> impl Event<Item = isize> + Clone

Return the current queue content.

pub fn content_stats( queue: Grc<Queue>, ) -> impl Event<Item = TimingStats<isize>> + Clone

Return the queue content statistics.

pub fn content_changed( queue: Grc<Queue>, ) -> impl Observable<Message = isize> + Clone

Triggered when the content property changes.

pub fn content_changed_(&self) -> impl Observable<Message = ()> + Clone

Triggered when the content property changes.

pub fn enqueue_count(queue: Grc<Queue>) -> impl Event<Item = isize> + Clone

Return the total number of input items that were enqueued.

pub fn enqueue_count_changed( queue: Grc<Queue>, ) -> impl Observable<Message = isize> + Clone

Triggered when the enqueue_count property changes.

pub fn enqueue_count_changed_(&self) -> impl Observable<Message = ()> + Clone

Triggered when the enqueue_count property changes.

pub fn enqueue_zero_entry_count( queue: Grc<Queue>, ) -> impl Event<Item = isize> + Clone

Return the total number of zero entry items.

pub fn enqueue_zero_entry_count_changed( queue: Grc<Queue>, ) -> impl Observable<Message = isize> + Clone

Triggered when the enqueue_zero_entry_count property changes.

pub fn enqueue_zero_entry_count_changed_( &self, ) -> impl Observable<Message = ()> + Clone

Triggered when the enqueue_zero_entry_count property changes.

pub fn wait_time( queue: Grc<Queue>, ) -> impl Event<Item = SamplingStats<f64>> + Clone

Return the wait (or residence) time.

pub fn wait_time_changed( queue: Grc<Queue>, ) -> impl Observable<Message = SamplingStats<f64>> + Clone

Triggered when the wait_time property changes.

pub fn wait_time_changed_(&self) -> impl Observable<Message = ()> + Clone

Triggered when the wait_time property changes.

pub fn non_zero_entry_wait_time( queue: Grc<Queue>, ) -> impl Event<Item = SamplingStats<f64>> + Clone

Return the wait (or residence) time by excluding zero entries.

pub fn non_zero_entry_wait_time_changed( queue: Grc<Queue>, ) -> impl Observable<Message = SamplingStats<f64>> + Clone

Triggered when the wait_time property changes.

pub fn non_zero_entry_wait_time_changed_( &self, ) -> impl Observable<Message = ()> + Clone

Triggered when the non_zero_entry_wait_time property changes.

pub fn rate(queue: Grc<Queue>) -> impl Event<Item = f64> + Clone

Return a long-term average queue rate calculated as the average queue content divided by the average wait time.

pub fn rate_changed(queue: Grc<Queue>) -> impl Observable<Message = f64> + Clone

Triggered when the rate property changes.

pub fn rate_changed_(&self) -> impl Observable<Message = ()> + Clone

Triggered when the rate property changes.

pub fn enqueued(&self) -> impl Observable<Message = ()> + Clone

Notifies when enqueuing an item.

pub fn dequeued(&self) -> impl Observable<Message = ()> + Clone

Notifies when dequeuing the item.

pub fn enqueue( queue: Grc<Queue>, transact_id: Grc<TransactId>, increment: isize, ) -> Enqueue

Enqueue the item.

pub fn dequeue( queue: Grc<Queue>, transact_id: Grc<TransactId>, decrement: isize, ) -> Dequeue

Dequeue the item.

pub fn changed_(&self) -> impl Observable<Message = ()> + Clone

Signal whenever any property of the queue changes.

pub fn reset(queue: Grc<Queue>) -> impl Event<Item = ()> + Clone

Reset the statistics.

Trait Implementations

impl Hash for Queue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Queue

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Queue