trait TimerScheduler extends AnyRef
- Source
- TimerScheduler.scala
- Alphabetic
- By Inheritance
- TimerScheduler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- 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
nameand if a new timer with samenameis 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
- 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
nameand if a new timer with samenameis 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.