Struct TransmitLimitedQueue

Source

pub struct TransmitLimitedQueue<B: Broadcast, N> { /* private fields */ }

Expand description

Used to queue messages to broadcast to the cluster (via gossip) but limits the number of transmits per message. It also prioritizes messages with lower transmit counts (hence newer messages).

Implementations§

Source §

impl<B: Broadcast, N: NodeCalculator> TransmitLimitedQueue<B, N>

Source

pub fn new(retransmit_mult: usize, calc: N) -> Self

Creates a new TransmitLimitedQueue.

Source

pub async fn num_queued(&self) -> usize

Returns the number of messages queued.

Source

pub async fn get_broadcasts(&self, limit: usize) -> TinyVec<B::Message>

Returns the messages can be broadcast.

Source

pub async fn queue_broadcast(&self, b: B)

Used to enqueue a broadcast

Source

pub async fn reset(&self)

Clears all the queued messages.

Source

pub async fn prune(&self, max_retain: usize)

Retain the max_retain latest messages, and the rest will be discarded. This can be used to prevent unbounded queue sizes

Auto Trait Implementations§

§

impl<B, N> UnwindSafe for TransmitLimitedQueue<B, N>
where N: UnwindSafe, ::Id: UnwindSafe, B: RefUnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §