object BlockingClient

The companion object provides additional friendly constructors.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlockingClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def apply(configName: String, path: String)(implicit system: ActorSystem): BlockingClient

    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. def apply(configName: String)(implicit system: ActorSystem): BlockingClient

    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

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

    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

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

    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. def apply(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): BlockingClient

    Creates a scredis.BlockingClient

    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