scredis

CommandOptions

final case class CommandOptions(timeout: Duration = RedisConfigDefaults.Client.Timeout, tries: Int = RedisConfigDefaults.Client.Tries, sleep: Option[FiniteDuration] = RedisConfigDefaults.Client.Sleep, force: Boolean = false) extends Product with Serializable

Contains the parameters associated to a command. This class can be implicitly passed when calling almost any command as to modify its behavior.

timeout

maximum duration for the execution of a command, can be infinite

tries

maximum number of times the command will be executed in case recoverable errors occur such as timeouts

sleep

duration of time to sleep between subsequent tries

force

if true and if automatic pipelining is enabled, forces the command to be executed immediately

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommandOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CommandOptions(timeout: Duration = RedisConfigDefaults.Client.Timeout, tries: Int = RedisConfigDefaults.Client.Tries, sleep: Option[FiniteDuration] = RedisConfigDefaults.Client.Sleep, force: Boolean = false)

    timeout

    maximum duration for the execution of a command, can be infinite

    tries

    maximum number of times the command will be executed in case recoverable errors occur such as timeouts

    sleep

    duration of time to sleep between subsequent tries

    force

    if true and if automatic pipelining is enabled, forces the command to be executed immediately

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. val force: Boolean

    if true and if automatic pipelining is enabled, forces the command to be executed immediately

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. val sleep: Option[FiniteDuration]

    duration of time to sleep between subsequent tries

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  18. val timeout: Duration

    maximum duration for the execution of a command, can be infinite

  19. val tries: Int

    maximum number of times the command will be executed in case recoverable errors occur such as timeouts

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped