class RedisOptions extends AnyRef
Redis Client Configuration options.
- Alphabetic
- By Inheritance
- RedisOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RedisOptions(_asJava: redis.client.RedisOptions)
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
addConnectionString(value: String): RedisOptions
Adds a connection string (endpoint) to use while connecting to the redis server.
Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
Does not support rediss (redis over ssl scheme) for now.
-
def
addEndpoint(value: String): RedisOptions
Set the endpoints to use while connecting to the redis server.
Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: redis.client.RedisOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): 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[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getEndpoint: String
- def getEndpoints: Buffer[String]
- def getMasterName: String
- def getMaxNestedArrays: Int
- def getMaxPoolSize: Int
- def getMaxPoolWaiting: Int
- def getMaxWaitingHandlers: Int
- def getNetClientOptions: NetClientOptions
- def getPoolCleanerInterval: Int
- def getPoolRecycleTimeout: Int
- def getRole: RedisRole
- def getType: RedisClientType
- def getUseSlave: RedisSlaves
-
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()
-
def
setConnectionString(value: String): RedisOptions
Sets a single connection string (endpoint) to use while connecting to the redis server.
Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings.
Does not support rediss (redis over ssl scheme) for now.
-
def
setEndpoint(value: String): RedisOptions
Sets a single connection string to use while connecting to the redis server.
Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings.
- def setEndpoints(value: Buffer[String]): RedisOptions
-
def
setMasterName(value: String): RedisOptions
Set the master name (only considered in HA mode).
-
def
setMaxNestedArrays(value: Int): RedisOptions
Tune how much nested arrays are allowed on a redis response.
Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
-
def
setMaxPoolSize(value: Int): RedisOptions
Tune the maximum size of the connection pool.
Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)
-
def
setMaxPoolWaiting(value: Int): RedisOptions
Tune the maximum waiting requests for a connection from the pool.
-
def
setMaxWaitingHandlers(value: Int): RedisOptions
The client will always work on pipeline mode, this means that messages can start queueing.
The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.
-
def
setNetClientOptions(value: NetClientOptions): RedisOptions
Set the net client options to be used while connecting to the redis server.
Set the net client options to be used while connecting to the redis server. Use this to tune your connection.
-
def
setPoolCleanerInterval(value: Int): RedisOptions
Tune how often in milliseconds should the connection pool cleaner execute.
-
def
setPoolRecycleTimeout(value: Int): RedisOptions
Tune when a connection should be recycled in milliseconds.
-
def
setRole(value: RedisRole): RedisOptions
Set the role name (only considered in HA mode).
-
def
setType(value: RedisClientType): RedisOptions
Set the desired client type to be created.
-
def
setUseSlave(value: RedisSlaves): RedisOptions
Set whether or not to use slave nodes (only considered in Cluster mode).
-
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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )