PubSubCommands

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

7. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

8. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

9. final def getClass(): Class[_]

   

   Definition Classes

   AnyRef → Any

10. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

11. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

12. def isSubscribed: Boolean

    

    Determines whether the client is listening to some channels or patterns.

    Determines whether the client is listening to some channels or patterns.

    returns

    true if the client is listening for some channels or patterns, false otherwise

13. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

14. final def notify(): Unit

    

    Definition Classes

    AnyRef

15. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

16. def pSubscribe(pattern: String, patterns: String*)(pf: PartialFunction[PubSubMessage, Any]): Unit

    

    Listens for messages published to channels matching the given patterns.

    Listens for messages published to channels matching the given patterns.

    pattern

    the first pattern

    patterns

    additional patterns

    pf

    partial function handling received messages

    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.

17. def pUnsubscribe(patterns: String*): Unit

    

    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

    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.

18. def publish(channel: String, message: String)(implicit opts: CommandOptions = DefaultCommandOptions): Long

    

    Publishes a message to a channel.

    Publishes a message to a channel.

    channel

    the name of the channel

    message

    the message payload

    returns

    the number of clients that received the message

    Since

    2.0.0

19. def subscribe(channel: String, channels: String*)(pf: PartialFunction[PubSubMessage, Any]): Unit

    

    Listens for messages published to the given channels.

    Listens for messages published to the given channels.

    channel

    the name of the first channel

    channels

    additional names of channels to listen to

    pf

    partial function handling received messages

    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.

20. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

21. def toString(): String

    

    Definition Classes

    AnyRef → Any

22. def unsubscribe(channels: String*): Unit

    

    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

    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.

23. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

24. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

25. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )