Struct puff_rs::databases::pubsub::PubSubClient

pub struct PubSubClient { /* private fields */ }

A client to work with PubSub. A pubsub client currently is assumed to be alive for the lifetime of a program and maintains a single persistent connection to Redis.

PubSubConnections do not create new Redis connections instead share the same one and the client broadcasts new messages over unbounded channels.

Implementations

impl PubSubClient

pub fn start_supervised_listener(&self)

pub fn connection_with_id(
    &self,
    connection_id: ConnectionId
) -> PuffResult<(PubSubConnection, UnboundedReceiver<PubSubMessage>)>

Create a connection that can subscribe to channels with a specific ConnectionId

pub fn connection(
    &self
) -> PuffResult<(PubSubConnection, UnboundedReceiver<PubSubMessage>)>

Create a connection that can subscribe to channels.

pub fn new_connection_id(&self) -> ConnectionId

Generate a new connection ID

pub fn publish_as<T: Into<Text>, M: Into<Bytes>>(
    &self,
    connection_id: ConnectionId,
    channel: T,
    body: M
) -> BoxFuture<'_, PuffResult<()>>

Try to broadcast a message to the channel.

Trait Implementations

impl Clone for PubSubClient

fn clone(&self) -> PubSubClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Puff for PubSubClient

fn puff(&self) -> Self