Enum PolymorphicEnvelopeBuffer

pub enum PolymorphicEnvelopeBuffer {
    InMemory(EnvelopeBuffer<MemoryStackProvider>),
    Sqlite(EnvelopeBuffer<SqliteStackProvider>),
}

Polymorphic envelope buffering interface.

The underlying buffer can either be disk-based or memory-based, depending on the given configuration.

NOTE: This is implemented as an enum because a trait object with async methods would not be object safe.

Variants

InMemory(EnvelopeBuffer<MemoryStackProvider>)

An enveloper buffer that uses in-memory envelopes stacks.

Sqlite(EnvelopeBuffer<SqliteStackProvider>)

An enveloper buffer that uses sqlite envelopes stacks.

Implementations

impl PolymorphicEnvelopeBuffer

pub fn is_memory(&self) -> bool

Returns true if the implementation stores all envelopes in RAM.

pub async fn from_config( partition_id: u8, config: &Config, memory_checker: MemoryChecker, ) -> Result<Self, EnvelopeBufferError>

Creates either a memory-based or a disk-based envelope buffer, depending on the given configuration.

pub async fn initialize(&mut self)

Initializes the envelope buffer.

pub async fn push( &mut self, envelope: Box<Envelope>, ) -> Result<(), EnvelopeBufferError>

Adds an envelope to the buffer.

pub async fn peek(&mut self) -> Result<Peek, EnvelopeBufferError>

Returns a reference to the next-in-line envelope.

pub async fn pop( &mut self, ) -> Result<Option<Box<Envelope>>, EnvelopeBufferError>

Pops the next-in-line envelope.

pub fn mark_ready(&mut self, project: &ProjectKey, is_ready: bool) -> bool

Marks a project as ready or not ready.

The buffer re-prioritizes its envelopes based on this information. Returns true if at least one priority was changed.

pub fn mark_seen( &mut self, project_key_pair: &ProjectKeyPair, next_fetch: Duration, )

Marks a stack as seen.

Non-ready stacks are deprioritized when they are marked as seen, such that the next call to .peek() will look at a different stack. This prevents head-of-line blocking.

pub fn has_capacity(&self) -> bool

Returns true whether the buffer has capacity to accept new [Envelope]s.

pub async fn shutdown(&mut self) -> bool

Shuts down the PolymorphicEnvelopeBuffer.

Trait Implementations

impl Debug for PolymorphicEnvelopeBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.