t

scredis.commands

SubscriberCommands

trait SubscriberCommands extends AnyRef

This trait implements subscriber commands.

Self Type
SubscriberCommands with SubscriberConnection
Linear Supertypes
AnyRef, Any
Known Subclasses
SubscriberClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscriberCommands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def pSubscribe(patterns: String*)(subscription: Subscription): Future[Int]

    Listens for messages published to channels matching the given patterns.

    Listens for messages published to channels matching the given patterns.

    patterns

    the patterns

    subscription

    partial function handling received messages

    returns

    the total number of subscribed channels and patterns

    Since

    2.0.0

    Note

    Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE and PUNSUBSCRIBE commands.

  2. def pUnsubscribe(patterns: String*): Future[Int]

    Stops listening for messages published to channels matching the given patterns.

    Stops listening for messages published to channels matching the given patterns.

    patterns

    the patterns, if empty, unsubscribe from all patterns

    returns

    the total number of subscribed channels and patterns

    Since

    2.0.0

    Note

    When no patterns are specified, the client is unsubscribed from all the previously subscribed patterns. In this case, a message for every unsubscribed pattern will be sent to the client.

  3. def subscribe(channels: String*)(subscription: Subscription): Future[Int]

    Listens for messages published to the given channels.

    Listens for messages published to the given channels.

    channels

    channel name(s) of channel(s) to listen to

    subscription

    partial function handling received messages

    returns

    the total number of subscribed channels and patterns

    Since

    2.0.0

    Note

    Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE and PUNSUBSCRIBE commands.

  4. def unsubscribe(channels: String*): Future[Int]

    Stops listening for messages published to the given channels.

    Stops listening for messages published to the given channels.

    channels

    the names of the channels, if empty, unsubscribe from all channels

    returns

    the total number of subscribed channels and patterns

    Since

    2.0.0

    Note

    When no channels are specified, the client is unsubscribed from all the previously subscribed channels. In this case, a message for every unsubscribed channel will be sent to the client.