Skip to main content

NotificationDispatcher

Struct NotificationDispatcher 

Source
pub struct NotificationDispatcher { /* private fields */ }
Expand description

A notification dispatcher that routes PG notifications to subscribers.

Wraps a tokio broadcast channel. Multiple receivers can subscribe, and each receives all notifications. Used internally by the listener to fan out notifications from a single dedicated connection.

Implementations§

Source§

impl NotificationDispatcher

Source

pub fn new() -> Self

Create a new dispatcher with the default buffer capacity.

Source

pub fn with_capacity(capacity: usize) -> Self

Create a new dispatcher with a specific buffer capacity.

Source

pub fn subscribe(&self) -> NotificationReceiver

Subscribe to receive notifications.

Returns a receiver that will get all notifications dispatched after this point.

Source

pub fn dispatch(&self, notification: Notification) -> usize

Dispatch a notification to all subscribers.

Returns the number of receivers that got the message. Returns 0 if there are no active subscribers (which is fine).

Source

pub fn add_channel(&mut self, channel: String)

Track that we’re listening on a channel.

Source

pub fn remove_channel(&mut self, channel: &str)

Remove a tracked channel.

Source

pub fn channels(&self) -> &HashSet<String>

Get all tracked channel names (for re-subscribing on reconnect).

Source

pub fn subscriber_count(&self) -> usize

Number of active subscribers.

Trait Implementations§

Source§

impl Default for NotificationDispatcher

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more