object Redis

The companion object provides additional friendly constructors.

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

Value Members

  1. def apply(configName: String, path: String): Redis

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

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

    Note

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

  2. def apply(configName: String): Redis

    Constructs a scredis.Redis instance from a config file.

    Constructs a scredis.Redis instance from a config file.

    configName

    config filename

    returns

    the constructed scredis.Redis

    Note

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

    Redis(configName, "scredis")
  3. def apply(config: Config): Redis

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

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

    config

    com.typesafe.Config

    returns

    the constructed scredis.Redis

    Note

    The config must contain the scredis object at its root.

  4. def apply(subscription: Subscription): Redis
  5. def apply(config: RedisConfig): Redis

    Constructs a scredis.Redis instance from a scredis.RedisConfig.

    Constructs a scredis.Redis instance from a scredis.RedisConfig.

    config

    scredis.RedisConfig

    returns

    the constructed scredis.Redis

  6. def apply(): Redis

    Constructs a scredis.Redis instance using the default config.

    Constructs a scredis.Redis instance using the default config.

    returns

    the constructed scredis.Redis

  7. def apply(host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, authOpt: Option[AuthConfig] = RedisConfigDefaults.Redis.AuthOpt, database: Int = RedisConfigDefaults.Redis.Database, nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = ..., receiveTimeoutOpt: Option[FiniteDuration] = ..., maxWriteBatchSize: Int = ..., tcpSendBufferSizeHint: Int = ..., tcpReceiveBufferSizeHint: Int = ..., actorSystemName: String = ..., akkaListenerDispatcherPath: String = ..., akkaIODispatcherPath: String = ..., akkaDecoderDispatcherPath: String = ..., failCommandOnConnecting: Boolean = ...): Redis

    Constructs a scredis.Redis instance using provided parameters.

    Constructs a scredis.Redis instance using provided parameters.

    host

    server address

    port

    server port

    authOpt

    optional server authorization credentials

    database

    database index to select

    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

    actorSystemName

    name of the actor system

    akkaListenerDispatcherPath

    path to listener dispatcher definition

    akkaIODispatcherPath

    path to io dispatcher definition

    akkaDecoderDispatcherPath

    path to decoder dispatcher definition

    returns

    the constructed scredis.Redis

  8. def withActorSystem(configName: String, path: String)(implicit system: ActorSystem): Redis

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

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

    configName

    config filename

    path

    path pointing to the scredis config object

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

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

    ,

    The provided ActorSystem will not be shutdown after invoking quit.

  9. def withActorSystem(configName: String)(implicit system: ActorSystem): Redis

    Constructs a scredis.Redis instance from a config file.

    Constructs a scredis.Redis instance from a config file.

    configName

    config filename

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

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

    Redis(configName, "scredis")
    ,

    The provided ActorSystem will not be shutdown after invoking quit.

  10. def withActorSystem(config: Config)(implicit system: ActorSystem): Redis

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

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

    config

    com.typesafe.Config

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

    The config must contain the scredis object at its root.

    ,

    The provided ActorSystem will not be shutdown after invoking quit.

  11. def withActorSystem(config: RedisConfig)(implicit system: ActorSystem): Redis

    Constructs a scredis.Redis instance from a scredis.RedisConfig.

    Constructs a scredis.Redis instance from a scredis.RedisConfig.

    config

    scredis.RedisConfig

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

    The provided ActorSystem will not be shutdown after invoking quit.

  12. def withActorSystem()(implicit system: ActorSystem): Redis

    Constructs a scredis.Redis instance using the default config.

    Constructs a scredis.Redis instance using the default config.

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

    The provided ActorSystem will not be shutdown after invoking quit.

  13. def withActorSystem(host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, authOpt: Option[AuthConfig] = RedisConfigDefaults.Redis.AuthOpt, database: Int = RedisConfigDefaults.Redis.Database, nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = ..., receiveTimeoutOpt: Option[FiniteDuration] = ..., maxWriteBatchSize: Int = ..., tcpSendBufferSizeHint: Int = ..., tcpReceiveBufferSizeHint: Int = ..., akkaListenerDispatcherPath: String = ..., akkaIODispatcherPath: String = ..., akkaDecoderDispatcherPath: String = ..., failCommandOnConnecting: Boolean = ..., subscription: Subscription = ...)(implicit system: ActorSystem): Redis

    Constructs a scredis.Redis instance using provided parameters.

    Constructs a scredis.Redis instance using provided parameters.

    host

    server address

    port

    server port

    authOpt

    optional server authorization credentials

    database

    database index to select

    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

    system

    implicit ActorSystem

    returns

    the constructed scredis.Redis

    Note

    The provided ActorSystem will not be shutdown after invoking quit.