Skip to main content

PubSub

Struct PubSub 

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

Adapter-owned PubSub runtime abstraction.

Implementations§

Source§

impl PubSub

Source

pub fn new(topic_capacity: usize) -> Self

Create the built-in in-process backend.

Source

pub fn with_backend<B>(backend: B) -> Self
where B: PubSubBackend + 'static,

Wrap a custom backend implementation (for clustered fanout backends).

Source

pub fn subscribe(&self, topic: impl Into<String>) -> PubSubSubscription

Subscribe to a topic.

Source

pub fn broadcast( &self, topic: impl Into<String>, messages: Vec<ServerMessage>, ) -> usize

Broadcast one payload to all subscribers on a topic.

Source

pub fn capabilities(&self) -> PubSubCapabilities

Backend cluster/delivery capability contract.

Source

pub fn register_presence( &self, topic: impl Into<String>, session_id: impl Into<String>, node_id: impl Into<String>, )

Register one session as present for a topic on one cluster node.

Source

pub fn unregister_presence( &self, topic: impl Into<String>, session_id: impl Into<String>, node_id: impl Into<String>, )

Unregister one session presence from a topic on one cluster node.

Source

pub fn presence_snapshot( &self, topic: impl Into<String>, ) -> PubSubPresenceSnapshot

Return presence counts for one topic.

Trait Implementations§

Source§

impl Clone for PubSub

Source§

fn clone(&self) -> PubSub

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PubSub

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PubSub

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.