class RedisOptions extends AnyRef
This object controls the connection setting to the Redis Server. There is no need to specify most of the settings since it has built the following sensible defaults:
* encoding
: UTF-8
* host
: localhost
* port
: 6379
* tcpKeepAlive
: true
* tcpNoDelay
: true
* binary
: false
However there are two extra properties that have no defaults since they are optional:
* auth
* select
The usage of this two extra properties is to setup required authentication and optionally the selection of the active database at connection time. If you define this extra properties on every connection to Redis server this client will perform the authentication handshake and database selection, however if you don't do this and call io.vertx.scala.redis.RedisClient yourself in case of connection failure the client will not be able to perform the correct authentication handshake.
- Alphabetic
- By Inheritance
- RedisOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RedisOptions(_asJava: redis.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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: redis.RedisOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @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] )
- def getAddress: String
- def getAuth: String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- def getEncoding: String
- def getHost: String
- def getPort: Int
- def getSelect: Int
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- def isBinary: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTcpKeepAlive: Boolean
- def isTcpNoDelay: Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
setAddress(value: String): RedisOptions
Set the eventbus address prefix for
PUB/SUB
. -
def
setAuth(value: String): RedisOptions
Set the password for authentication at connection time.
-
def
setBinary(value: Boolean): RedisOptions
Set the user defined character encoding, e.g.:
iso-8859-1
. -
def
setEncoding(value: String): RedisOptions
Set the user defined character encoding, e.g.:
iso-8859-1
. -
def
setHost(value: String): RedisOptions
Set the host name where the Redis server is listening.
-
def
setPort(value: Int): RedisOptions
Set the tcp port where the Redis server is listening.
-
def
setSelect(value: Int): RedisOptions
Set the database to select at connection time.
-
def
setTcpKeepAlive(value: Boolean): RedisOptions
Set the TCP KeepAlive option
-
def
setTcpNoDelay(value: Boolean): RedisOptions
Set the TCP NoDelay at the socket level.
-
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
- @throws( ... )