Struct NotifyBroker 

pub struct NotifyBroker { /* private fields */ }

Message broker that distributes PostgreSQL NOTIFY events to subscribers.

Implementations

impl NotifyBroker

pub fn new(pool: PgPool) -> Self

Create a new notification broker.

pub fn with_capacity(pool: PgPool, capacity: usize) -> Self

Create a new notification broker with custom channel capacity.

pub async fn start( &self, listen_channels: Vec<String>, ) -> Result<(), BrokerError>

Start listening for notifications on the given channels.

This spawns a background task that listens for PostgreSQL NOTIFY events and broadcasts them to all subscribers.

pub async fn listen(&self, channels: Vec<String>) -> Result<(), BrokerError>

Listen on whichever of channels the broker is not listening on yet, over one new connection.

The channels already listened to are left alone, so a subscriber on one of them misses nothing while channels are added. On an error none of the new channels is recorded, and asking again retries them.

pub async fn stop(&self)

Stop the broker, and every connection it is listening on.

pub async fn subscribe( &self, channel: &str, ) -> Result<Pin<Box<dyn Stream<Item = PgNotification> + Send>>, BrokerError>

Subscribe to notifications for a specific channel.

Returns a stream of notifications for the given channel.

pub async fn subscribe_or_create( &self, channel: &str, ) -> Pin<Box<dyn Stream<Item = PgNotification> + Send>>

Subscribe to a channel, creating it if it doesn’t exist.

Note: This only creates a broadcast channel. You must also call listen_channel to start receiving PostgreSQL notifications.

pub async fn listen_channel(&self, channel: &str) -> Result<(), BrokerError>

Add a new channel to listen on dynamically.

pub async fn is_running(&self) -> bool

Check if the broker is currently running.

pub async fn channel_count(&self) -> usize

Get the number of active channels.