Struct redis_async::client::pubsub::PubsubConnection
source · pub struct PubsubConnection { /* private fields */ }
Expand description
A shareable reference to subscribe to PUBSUB topics
Implementations§
source§impl PubsubConnection
impl PubsubConnection
sourcepub async fn subscribe(&self, topic: &str) -> Result<PubsubStream, Error>
pub async fn subscribe(&self, topic: &str) -> Result<PubsubStream, Error>
Subscribes to a particular PUBSUB topic.
Returns a future that resolves to a Stream
that contains all the messages published on
that particular topic.
The resolved stream will end with redis_async::error::Error::EndOfStream
if the
underlying connection is lost for unexpected reasons. In this situation, clients should
subscribe
to re-subscribe; the underlying connect will automatically reconnect. However,
clients should be aware that resubscriptions will only succeed if the underlying connection
has re-established, so multiple calls to subscribe
may be required.
pub async fn psubscribe(&self, topic: &str) -> Result<PubsubStream, Error>
sourcepub fn unsubscribe<T: Into<String>>(&self, topic: T)
pub fn unsubscribe<T: Into<String>>(&self, topic: T)
Tells the client to unsubscribe from a particular topic. This will return immediately, the
actual unsubscription will be confirmed when the stream returned from subscribe
ends.
pub fn punsubscribe<T: Into<String>>(&self, topic: T)
Trait Implementations§
source§impl Clone for PubsubConnection
impl Clone for PubsubConnection
source§fn clone(&self) -> PubsubConnection
fn clone(&self) -> PubsubConnection
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more