Class

org.squbs.pattern.timeoutpolicy

FixedTimeoutPolicy

Related Doc: package timeoutpolicy

Permalink

class FixedTimeoutPolicy extends TimeoutPolicy

The timeout policy for a fixed timeout.

Linear Supertypes
TimeoutPolicy, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixedTimeoutPolicy
  2. TimeoutPolicy
  3. LazyLogging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FixedTimeoutPolicy(name: Option[String], initial: FiniteDuration, startOverCount: Int)(implicit ec: ExecutionContext)

    Permalink

    name

    name of the policy

    initial

    initial(also max) value of the timeout duration

    startOverCount

    max total transaction count for start over the statistics

    ec

    implicit parameter of ExecutionContext

Type Members

  1. class TimeoutTransaction extends AnyRef

    Permalink

    The TimeoutTransaction allows for demarcating a unit of execution where time is measured.

    The TimeoutTransaction allows for demarcating a unit of execution where time is measured.

    Definition Classes
    TimeoutPolicy

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def execute[T](f: TimedFn[T]): T

    Permalink
    Definition Classes
    TimeoutPolicy
  9. def execute[T](f: (FiniteDuration) ⇒ T): T

    Permalink

    Executes a piece of logic without a timeout transaction

    Executes a piece of logic without a timeout transaction

    T

    The return type of the function f, and therefore the return type of this execution

    f

    The logic to be executed, taking the intended wait time as an input

    returns

    The output of the function f

    Definition Classes
    TimeoutPolicy
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  15. def metrics: Metrics

    Permalink

    The metrics reference holding the stats of past transactions.

    The metrics reference holding the stats of past transactions.

    Definition Classes
    TimeoutPolicy
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def reset(initial: Option[FiniteDuration]): Unit

    Permalink
    Definition Classes
    TimeoutPolicy
  20. def reset(): Unit

    Permalink
    Definition Classes
    TimeoutPolicy
  21. def reset(initial: Option[FiniteDuration] = None, newStartOverCount: Int): Metrics

    Permalink

    reset the policy, return the previous metrics

    reset the policy, return the previous metrics

    initial

    new initial value

    newStartOverCount

    new start over count

    returns

    statistics of before the reset operation

    Definition Classes
    TimeoutPolicy
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. def transaction: TimeoutTransaction

    Permalink

    Obtains a new TimeoutTransaction object.

    Obtains a new TimeoutTransaction object.

    returns

    The newly created TimeoutTransaction object associated with this TimeoutPolicy.

    Definition Classes
    TimeoutPolicy
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def waitTime: FiniteDuration

    Permalink
    Definition Classes
    FixedTimeoutPolicyTimeoutPolicy

Inherited from TimeoutPolicy

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped