akka.stream

TimerTransformer

abstract class TimerTransformer[-T, +U] extends Transformer[T, U]

Transformer with support for scheduling keyed (named) timer events.

Source
TimerTransformer.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TimerTransformer
  2. Transformer
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TimerTransformer()

Abstract Value Members

  1. abstract def onNext(element: T): Seq[U]

    Invoked for each element to produce a (possibly empty) sequence of output elements.

    Invoked for each element to produce a (possibly empty) sequence of output elements.

    Definition Classes
    Transformer
  2. abstract def onTimer(timerKey: Any): Seq[U]

    Will be called when the scheduled timer is triggered.

    Will be called when the scheduled timer is triggered.

    timerKey

    key of the scheduled timer

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 information
    This member is added by an implicit conversion from TimerTransformer[T, U] to any2stringadd[TimerTransformer[T, U]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TimerTransformer[T, U], B)

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to ArrowAssoc[TimerTransformer[T, U]] 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 cancelTimer(timerKey: Any): Unit

    Cancel timer, ensuring that the #onTimer is not subsequently called.

    Cancel timer, ensuring that the #onTimer is not subsequently called.

    timerKey

    key of the timer to cancel

  8. def cleanup(): Unit

    Invoked after normal completion or error.

    Invoked after normal completion or error.

    Definition Classes
    Transformer
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (TimerTransformer[T, U]) ⇒ Boolean, msg: ⇒ Any): TimerTransformer[T, U]

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to Ensuring[TimerTransformer[T, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TimerTransformer[T, U]) ⇒ Boolean): TimerTransformer[T, U]

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to Ensuring[TimerTransformer[T, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): TimerTransformer[T, U]

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to Ensuring[TimerTransformer[T, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TimerTransformer[T, U]

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to Ensuring[TimerTransformer[T, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to StringFormat[TimerTransformer[T, U]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  20. def isComplete: Boolean

    Invoked after handing off the elements produced from one input element to the downstream consumers to determine whether to end stream processing at this point; in that case the upstream subscription is canceled.

    Invoked after handing off the elements produced from one input element to the downstream consumers to determine whether to end stream processing at this point; in that case the upstream subscription is canceled.

    Definition Classes
    Transformer
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def isTimerActive(timerKey: Any): Boolean

    Inquire whether the timer is still active.

    Inquire whether the timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer that was already triggered.

  23. def name: String

    Name of this transformation step.

    Name of this transformation step. Used as part of the actor name. Facilitates debugging and logging.

    Definition Classes
    Transformer
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def onError(cause: Throwable): Unit

    Invoked when failure is signaled from upstream.

    Invoked when failure is signaled from upstream. If this method throws an exception, then onError is immediately propagated downstream. If this method completes normally then Transformer#onTermination is invoked as a final step, passing the original cause.

    Definition Classes
    Transformer
  28. def onTermination(e: Option[Throwable]): Seq[U]

    Invoked before the Transformer terminates (either normal completion or after an onError) to produce a (possibly empty) sequence of elements in response to the end-of-stream event.

    Invoked before the Transformer terminates (either normal completion or after an onError) to produce a (possibly empty) sequence of elements in response to the end-of-stream event.

    This method is only called if Transformer#onError does not throw an exception. The default implementation of Transformer#onError throws the received cause forcing the error to propagate downstream immediately.

    e

    Contains a non-empty option with the error causing the termination or an empty option if the Transformer was completed normally

    Definition Classes
    Transformer
  29. def scheduleOnce(timerKey: Any, delay: FiniteDuration): Unit

    Schedule timer to call #onTimer after given delay.

    Schedule timer to call #onTimer after given delay. Any existing timer with the same key will automatically be canceled before adding the new timer.

  30. def schedulePeriodically(timerKey: Any, interval: FiniteDuration): Unit

    Schedule timer to call #onTimer periodically with the given interval.

    Schedule timer to call #onTimer periodically with the given interval. Any existing timer with the same key will automatically be canceled before adding the new timer.

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

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def [B](y: B): (TimerTransformer[T, U], B)

    Implicit information
    This member is added by an implicit conversion from TimerTransformer[T, U] to ArrowAssoc[TimerTransformer[T, U]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Transformer[T, U]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TimerTransformer[T, U] to any2stringadd[TimerTransformer[T, U]]

Inherited by implicit conversion StringFormat from TimerTransformer[T, U] to StringFormat[TimerTransformer[T, U]]

Inherited by implicit conversion Ensuring from TimerTransformer[T, U] to Ensuring[TimerTransformer[T, U]]

Inherited by implicit conversion ArrowAssoc from TimerTransformer[T, U] to ArrowAssoc[TimerTransformer[T, U]]

Ungrouped