Struct QueueEvents 

pub struct QueueEvents { /* private fields */ }

A cross-process, stream-based queue event listener.

See the module documentation for details.

Implementations

impl QueueEvents

pub async fn new(name: &str, opts: QueueEventsOptions) -> Result<Self, Error>

Create a new QueueEvents listener with its own Redis connection.

pub async fn with_connection( name: &str, conn: RedisConnection, opts: QueueEventsOptions, ) -> Result<Self, Error>

Create a QueueEvents listener that reuses an existing connection.

Note: the listener still opens a dedicated connection internally for the blocking XREAD; conn is only used for its client/configuration.

pub async fn from_queue_options( name: &str, opts: &QueueOptions, ) -> Result<Self, Error>

Convenience constructor that derives options from QueueOptions.

pub fn name(&self) -> &str

The queue name this listener observes.

pub fn keys(&self) -> &QueueKeys

The queue keys helper.

pub fn is_running(&self) -> bool

Whether the consuming loop is currently running.

pub async fn run(&self) -> Result<(), Error>

Start consuming events.

Called automatically when QueueEventsOptions::autorun is true. Returns an error if the listener is already running.

pub async fn next_event(&self) -> Option<QueueEventEntry>

Wait for and return the next event, or None once the listener is closed and the buffer is drained.

pub async fn try_next_event(&self) -> Option<QueueEventEntry>

Try to receive a buffered event without waiting.

pub async fn close(&self)

Stop consuming events and release the dedicated connection.