Packages

t

kalix.scalasdk.timer

TimerScheduler

trait TimerScheduler extends AnyRef

Source
TimerScheduler.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimerScheduler
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def cancel(name: String): Future[Done]

    Cancel an existing timer.

    Cancel an existing timer. This completes successfully if not timer is registered for the passed name.

  2. abstract def startSingleTimer[I, O](name: String, delay: FiniteDuration, maxRetries: Int, deferredCall: DeferredCall[I, O]): Future[Done]

    Schedule a single timer in Kalix.

    Schedule a single timer in Kalix. Timers allow for scheduling calls in the future. For example, to verify that some process have been completed or not.

    Timers are persisted and are guaranteed to run at least once.

    When a timer is triggered, the scheduled call is executed. If successfully executed, the timer completes and is automatically removed. In case of a failure, the timer is rescheduled with a delay of 3 seconds. This process repeats until the call succeeds or the maxRetries limit is reached.

    Each timer has a name and if a new timer with same name is registered the previous is cancelled.

    name

    unique name for the timer

    delay

    delay, starting from now, in which the timer should be triggered

    maxRetries

    Retry up to this many times

    deferredCall

    a call to component that will be executed when the timer is triggered

  3. abstract def startSingleTimer[I, O](name: String, delay: FiniteDuration, deferredCall: DeferredCall[I, O]): Future[Done]

    Schedule a single timer in Kalix.

    Schedule a single timer in Kalix. Timers allow for scheduling calls in the future. For example, to verify that some process have been completed or not.

    Timers are persisted and are guaranteed to run at least once.

    When a timer is triggered, the scheduled call is executed. If successfully executed, the timer completes and is automatically removed. In case of a failure, the timer is rescheduled with an exponentially increasing delay, starting at 3 seconds with a max delay of 30 seconds. This process repeats until the call succeeds.

    Each timer has a name and if a new timer with same name is registered the previous is cancelled.

    name

    unique name for the timer

    delay

    delay, starting from now, in which the timer should be triggered

    deferredCall

    a call to component that will be executed when the timer is triggered

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TimerScheduler toany2stringadd[TimerScheduler] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TimerScheduler, B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler toArrowAssoc[TimerScheduler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (TimerScheduler) => Boolean, msg: => Any): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TimerScheduler) => Boolean): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TimerScheduler toStringFormat[TimerScheduler] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (TimerScheduler, B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler toArrowAssoc[TimerScheduler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTimerScheduler to any2stringadd[TimerScheduler]

Inherited by implicit conversion StringFormat fromTimerScheduler to StringFormat[TimerScheduler]

Inherited by implicit conversion Ensuring fromTimerScheduler to Ensuring[TimerScheduler]

Inherited by implicit conversion ArrowAssoc fromTimerScheduler to ArrowAssoc[TimerScheduler]

Ungrouped