class BlockingClient extends AkkaBlockingConnection with BlockingListCommands

Defines a Redis client supporting all blocking commands.

Linear Supertypes
BlockingListCommands, AkkaBlockingConnection, BlockingConnection, AbstractAkkaConnection, LazyLogging, Connection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlockingClient
  2. BlockingListCommands
  3. AkkaBlockingConnection
  4. BlockingConnection
  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 BlockingClient(configName: String, path: String)(implicit system: ActorSystem)

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

    Constructs a scredis.BlockingClient 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.BlockingClient

    Note

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

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

    Constructs a scredis.BlockingClient instance from a config file.

    Constructs a scredis.BlockingClient instance from a config file.

    configName

    config filename

    returns

    the constructed scredis.BlockingClient

    Note

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

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

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

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

    config

    com.typesafe.Config

    returns

    the constructed scredis.BlockingClient

    Note

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

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

    Constructs a scredis.BlockingClient instance from a scredis.RedisConfig

    Constructs a scredis.BlockingClient instance from a scredis.RedisConfig

    config

    scredis.RedisConfig

    returns

    the constructed scredis.BlockingClient

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

    host

    server address

    port

    server port

    passwordOpt

    optional server password

    database

    database index to select

    nameOpt

    optional client name (available since 2.6.9)

    connectTimeout

    connection 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)(implicit timeout: Duration): Try[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

  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 blPop[R](timeoutSeconds: Int, keys: String*)(implicit arg0: Reader[R]): Try[Option[(String, R)]]

    Removes and returns the first element in a list, or block until one is available.

    Removes and returns the first element in a list, or block until one is available.

    timeoutSeconds

    timeout in seconds, if zero, the command blocks indefinitely until an element is available

    keys

    list key(s)

    returns

    list of key to popped element pair, or None if timeout occurs

    Definition Classes
    BlockingListCommands
    Since

    2.0.0

    Exceptions thrown

    [[scredis.exceptions.RedisErrorResponseException]] if a key contains a non-list value

  4. def brPop[R](timeoutSeconds: Int, keys: String*)(implicit arg0: Reader[R]): Try[Option[(String, R)]]

    Removes and returns the last element in a list, or block until one is available.

    Removes and returns the last element in a list, or block until one is available.

    timeoutSeconds

    timeout in seconds, if zero, the command blocks indefinitely until an element is available in at least one of the provided lists

    keys

    list key(s)

    returns

    list of key to popped element pair, or None if timeout occurs

    Definition Classes
    BlockingListCommands
    Since

    2.0.0

    Exceptions thrown

    [[scredis.exceptions.RedisErrorResponseException]] if a key contains a non-list value

  5. def brPopLPush[R](sourceKey: String, destKey: String, timeoutSeconds: Int)(implicit arg0: Reader[R]): Try[Option[R]]

    Pops a value from a list, pushes it to another list and returns it, or block until one is available.

    Pops a value from a list, pushes it to another list and returns it, or block until one is available.

    sourceKey

    key of list to pop from

    destKey

    key of list to push to

    timeoutSeconds

    timeout in seconds, if zero, the command blocks indefinitely until an element is available in the list at sourceKey

    returns

    the element being popped from source and pushed to destination, or None if timeout occurs

    Definition Classes
    BlockingListCommands
    Since

    2.2.0

    Exceptions thrown

    [[scredis.exceptions.RedisErrorResponseException]] if sourceKey or destKey contain non-list values

  6. def clientSetName(name: String)(implicit timeout: Duration): Try[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

  7. implicit val dispatcher: ExecutionContextExecutor
    Definition Classes
    AbstractAkkaConnection → Connection
  8. val host: String
    Definition Classes
    AbstractAkkaConnection
  9. val port: Int
    Definition Classes
    AbstractAkkaConnection
  10. def quit()(implicit timeout: Duration): Try[Unit]

    Closes the connection.

    Closes the connection.

    Since

    1.0.0

  11. def select(database: Int)(implicit timeout: Duration): Try[Unit]

    Changes the selected database on the current client.

    Changes the selected database on the current client.

    Since

    1.0.0

    Exceptions thrown

    [[scredis.exceptions.RedisErrorResponseException]] if the database index is invalid