object Redis
The companion object provides additional friendly constructors.
- Alphabetic
- By Inheritance
- Redis
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- 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")
- 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.
- def apply(config: RedisConfig): Redis
Constructs a scredis.Redis instance from a scredis.RedisConfig.
Constructs a scredis.Redis instance from a scredis.RedisConfig.
- config
- returns
the constructed scredis.Redis
- 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
- def apply(host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, passwordOpt: Option[String] = RedisConfigDefaults.Redis.PasswordOpt, database: Int = RedisConfigDefaults.Redis.Database, nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = RedisConfigDefaults.IO.ConnectTimeout, receiveTimeoutOpt: Option[FiniteDuration] = RedisConfigDefaults.IO.ReceiveTimeoutOpt, maxWriteBatchSize: Int = RedisConfigDefaults.IO.MaxWriteBatchSize, tcpSendBufferSizeHint: Int = RedisConfigDefaults.IO.TCPSendBufferSizeHint, tcpReceiveBufferSizeHint: Int = RedisConfigDefaults.IO.TCPReceiveBufferSizeHint, actorSystemName: String = RedisConfigDefaults.IO.Akka.ActorSystemName, akkaListenerDispatcherPath: String = RedisConfigDefaults.IO.Akka.ListenerDispatcherPath, akkaIODispatcherPath: String = RedisConfigDefaults.IO.Akka.IODispatcherPath, akkaDecoderDispatcherPath: String = RedisConfigDefaults.IO.Akka.DecoderDispatcherPath, failCommandOnConnecting: Boolean = RedisConfigDefaults.Global.FailCommandOnConnecting): Redis
Constructs a scredis.Redis instance using provided parameters.
Constructs a scredis.Redis instance using provided parameters.
- 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
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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 invokingquit
.
- 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 invokingquit
.
- 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 invokingquit
.
- 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
- system
implicit
ActorSystem
- returns
the constructed scredis.Redis
- Note
The provided
ActorSystem
will not be shutdown after invokingquit
.
- 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 invokingquit
.
- def withActorSystem(host: String = RedisConfigDefaults.Redis.Host, port: Int = RedisConfigDefaults.Redis.Port, passwordOpt: Option[String] = RedisConfigDefaults.Redis.PasswordOpt, database: Int = RedisConfigDefaults.Redis.Database, nameOpt: Option[String] = RedisConfigDefaults.Redis.NameOpt, connectTimeout: FiniteDuration = RedisConfigDefaults.IO.ConnectTimeout, receiveTimeoutOpt: Option[FiniteDuration] = RedisConfigDefaults.IO.ReceiveTimeoutOpt, maxWriteBatchSize: Int = RedisConfigDefaults.IO.MaxWriteBatchSize, tcpSendBufferSizeHint: Int = RedisConfigDefaults.IO.TCPSendBufferSizeHint, tcpReceiveBufferSizeHint: Int = RedisConfigDefaults.IO.TCPReceiveBufferSizeHint, akkaListenerDispatcherPath: String = RedisConfigDefaults.IO.Akka.ListenerDispatcherPath, akkaIODispatcherPath: String = RedisConfigDefaults.IO.Akka.IODispatcherPath, akkaDecoderDispatcherPath: String = RedisConfigDefaults.IO.Akka.DecoderDispatcherPath, failCommandOnConnecting: Boolean = RedisConfigDefaults.Global.FailCommandOnConnecting)(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
- passwordOpt
optional server password
- 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 invokingquit
.