class SubscriberClient extends SubscriberAkkaConnection with SubscriberCommands

Defines a Pub/Sub Redis client capable of subscribing to channels/patterns.

Linear Supertypes
SubscriberCommands, SubscriberAkkaConnection, SubscriberConnection, AbstractAkkaConnection, LazyLogging, Connection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscriberClient
  2. SubscriberCommands
  3. SubscriberAkkaConnection
  4. SubscriberConnection
  5. AbstractAkkaConnection
  6. LazyLogging
  7. Connection
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SubscriberClient(configName: String, path: String)(implicit system: ActorSystem)

    Constructs a scredis.SubscriberClient instance from a config file and using the provided path.

    Constructs a scredis.SubscriberClient instance from a config file and using the provided path.

    configName

    config filename

    path

    path pointing to the scredis config object

    returns

    the constructed scredis.SubscriberClient

    Note

    The path must include to the scredis object, e.g. x.y.scredis

  2. new SubscriberClient(configName: String)(implicit system: ActorSystem)

    Constructs a scredis.SubscriberClient instance from a config file.

    Constructs a scredis.SubscriberClient instance from a config file.

    configName

    config filename

    returns

    the constructed scredis.SubscriberClient

    Note

    The config file must contain the scredis object at its root. This constructor is equivalent to 

    new Client(configName, "scredis")
  3. new SubscriberClient(config: Config)(implicit system: ActorSystem)

    Constructs a scredis.SubscriberClient instance from a com.typesafe.Config

    Constructs a scredis.SubscriberClient instance from a com.typesafe.Config

    config

    com.typesafe.Config

    returns

    the constructed scredis.SubscriberClient

    Note

    The config must contain the scredis object at its root. This constructor is equivalent to 

    new Client(config, "scredis")
  4. new SubscriberClient(config: RedisConfig)(implicit system: ActorSystem)

    Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig

    Constructs a scredis.SubscriberClient instance from a scredis.RedisConfig

    config

    scredis.RedisConfig

    returns

    the constructed scredis.SubscriberClient

  5. new SubscriberClient(host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, passwordOpt: Option[String] = ..., nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = ..., receiveTimeoutOpt: Option[FiniteDuration] = ..., maxWriteBatchSize: Int = ..., tcpSendBufferSizeHint: Int = ..., tcpReceiveBufferSizeHint: Int = ..., akkaListenerDispatcherPath: String = ..., akkaIODispatcherPath: String = ..., akkaDecoderDispatcherPath: String = ...)(implicit system: ActorSystem)

    host

    server address

    port

    server port

    passwordOpt

    optional server password

    nameOpt

    optional client name (available since 2.6.9)

    connectTimeout

    connection timeout

    receiveTimeoutOpt

    optional batch receive timeout

    maxWriteBatchSize

    max number of bytes to send as part of a batch

    tcpSendBufferSizeHint

    size hint of the tcp send buffer, in bytes

    tcpReceiveBufferSizeHint

    size hint of the tcp receive buffer, in bytes

    akkaListenerDispatcherPath

    path to listener dispatcher definition

    akkaIODispatcherPath

    path to io dispatcher definition

    akkaDecoderDispatcherPath

    path to decoder dispatcher definition

Value Members

  1. def auth(password: String): Future[Unit]

    Authenticates to the server.

    Authenticates to the server.

    password

    the server password

    Since

    1.0.0

    Exceptions thrown

    [[scredis.exceptions.RedisErrorResponseException]] if authentication failed

    Note

    Use the empty string to re-authenticate with no password.

  2. def awaitTermination(timeout: Duration = Duration.Inf): Unit

    Waits for all the internal actors to be shutdown.

    Waits for all the internal actors to be shutdown.

    timeout

    amount of time to wait

    Definition Classes
    AbstractAkkaConnection
    Note

    This method is usually called after issuing a QUIT command

  3. def clientSetName(name: String): Future[Unit]

    Sets the current client name.

    Sets the current client name. If the empty string is provided, the name will be unset.

    name

    name to associate the client to, if empty, unsets the client name

    Since

    2.6.9

  4. implicit val dispatcher: ExecutionContextExecutor
    Definition Classes
    AbstractAkkaConnection → Connection
  5. val host: String
    Definition Classes
    AbstractAkkaConnection
  6. 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

    Definition Classes
    SubscriberCommands
    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.

  7. 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

    Definition Classes
    SubscriberCommands
    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.

  8. val port: Int
    Definition Classes
    AbstractAkkaConnection
  9. def quit(): Future[Unit]

    Unsubscribes from all subscribed channels/patterns and then closes the connection.

  10. 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

    Definition Classes
    SubscriberCommands
    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.

  11. 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

    Definition Classes
    SubscriberCommands
    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.