[−][src]Struct redis::PubSub
Represents a pubsub connection.
Methods
impl<'a> PubSub<'a>
[src]
The pubsub object provides convenient access to the redis pubsub system. Once created you can subscribe and unsubscribe from channels and listen in on messages.
Example:
let client = redis::Client::open("redis://127.0.0.1/")?; let mut con = client.get_connection()?; let mut pubsub = con.as_pubsub(); pubsub.subscribe("channel_1")?; pubsub.subscribe("channel_2")?; loop { let msg = pubsub.get_message()?; let payload : String = msg.get_payload()?; println!("channel '{}': {}", msg.get_channel_name(), payload); }
pub fn subscribe<T: ToRedisArgs>(&mut self, channel: T) -> RedisResult<()>
[src]
Subscribes to a new channel.
pub fn psubscribe<T: ToRedisArgs>(&mut self, pchannel: T) -> RedisResult<()>
[src]
Subscribes to a new channel with a pattern.
pub fn unsubscribe<T: ToRedisArgs>(&mut self, channel: T) -> RedisResult<()>
[src]
Unsubscribes from a channel.
pub fn punsubscribe<T: ToRedisArgs>(&mut self, pchannel: T) -> RedisResult<()>
[src]
Unsubscribes from a channel with a pattern.
pub fn get_message(&mut self) -> RedisResult<Msg>
[src]
Fetches the next message from the pubsub connection. Blocks until a message becomes available. This currently does not provide a wait not to block :(
The message itself is still generic and can be converted into an appropriate type through the helper methods on it.
pub fn set_read_timeout(&self, dur: Option<Duration>) -> RedisResult<()>
[src]
Sets the read timeout for the connection.
If the provided value is None
, then get_message
call will
block indefinitely. It is an error to pass the zero Duration
to this
method.
Trait Implementations
Auto Trait Implementations
impl<'a> RefUnwindSafe for PubSub<'a>
impl<'a> Send for PubSub<'a>
impl<'a> Sync for PubSub<'a>
impl<'a> Unpin for PubSub<'a>
impl<'a> !UnwindSafe for PubSub<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,