Packages

class RedisUri extends AnyRef

Contains connection details for the communication with standalone redis servers. Allows to provide the database, client name, password and timeouts and more.

You have different ways to create a RedisUri:

Example

//using an URI
RedisUri("redis://localhost:6379")

//using host and port
RedisUri("localhost", 6379)

//then you can pass custom options
RedisUri("localhost", 6379)
.withDatabase(1)
.withPassword("Alice123") //this will normally come from a stored secret
.withClientName("companyX")
Source
RedisUri.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedisUri
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RedisUri(uri: Either[String, (String, Int)], database: Option[Int] = None, password: Option[String] = None, ssl: Option[Boolean] = None, verifyPeer: Option[Boolean] = None, startTls: Option[Boolean] = None, timeout: Option[FiniteDuration] = None, sentinels: List[String] = List.empty, socket: Option[String] = None, sentinelMasterId: Option[String] = None, clientName: Option[String] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val clientName: Option[String]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val database: Option[Int]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. val password: Option[String]
  18. val sentinelMasterId: Option[String]
  19. val sentinels: List[String]
  20. val socket: Option[String]
  21. val ssl: Option[Boolean]
  22. val startTls: Option[Boolean]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val timeout: Option[FiniteDuration]
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. val uri: Either[String, (String, Int)]
  27. val verifyPeer: Option[Boolean]
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. def withClientName(clientName: String): RedisUri
  32. def withDatabase(database: Int): RedisUri
  33. def withPassword(password: String): RedisUri
  34. def withSentinelMasterId(sentinelMasterId: String): RedisUri
  35. def withSentinels(sentinels: List[String]): RedisUri
  36. def withSocket(socket: String): RedisUri
  37. def withSsl(ssl: Boolean): RedisUri
  38. def withStartTls(startTls: Boolean): RedisUri
  39. def withTimeout(timeout: FiniteDuration): RedisUri
  40. def withVerifyPeer(verifyPeer: Boolean): RedisUri

Inherited from AnyRef

Inherited from Any

Ungrouped