Class

com.lightbend.lagom.scaladsl.persistence.ReadSideProcessor

ReadSideHandler

Related Doc: package ReadSideProcessor

Permalink

abstract class ReadSideHandler[Event <: AggregateEvent[Event]] extends AnyRef

An read side offset processor.

This is responsible for the actual read side handling, including handling offsets and the events themselves.

Source
ReadSideProcessor.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadSideHandler
  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. All

Instance Constructors

  1. new ReadSideHandler()

    Permalink

Abstract Value Members

  1. abstract def handle(): Flow[EventStreamElement[Event], Done, NotUsed]

    Permalink

    Flow to handle the events.

    Flow to handle the events.

    If the handler does any blocking, this flow should be configured to use a dispatcher that is configured to allow for that blocking.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to any2stringadd[ReadSideHandler[Event]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ReadSideHandler[Event], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to ArrowAssoc[ReadSideHandler[Event]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def ensuring(cond: (ReadSideHandler[Event]) ⇒ Boolean, msg: ⇒ Any): ReadSideHandler[Event]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (ReadSideHandler[Event]) ⇒ Boolean): ReadSideHandler[Event]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ReadSideHandler[Event]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): ReadSideHandler[Event]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

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

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to StringFormat[ReadSideHandler[Event]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  17. def globalPrepare(): Future[Done]

    Permalink

    Prepare the database for all processors.

    Prepare the database for all processors.

    This will be invoked at system startup. It is guaranteed to only be invoked once at a time across the entire cluster, and so is safe to be used to perform actions like creating tables, that could cause problems if done from multiple nodes.

    It will be invoked again if it fails, and it may be invoked multiple times as nodes of the cluster go up or down. Unless the entire system is restarted, there is no way to guarantee that it will be invoked at a particular time - in particular, it should not be used for doing upgrades unless the entire system is restarted and a new cluster built from scratch.

    returns

    A Future that is redeemed when preparation is finished.

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def prepare(tag: AggregateEventTag[Event]): Future[Offset]

    Permalink

    Prepare this processor.

    Prepare this processor.

    The primary purpose of this method is to load the last offset that was processed, so that read side processing can continue from that offset.

    This also provides an opportunity for processors to do any initialisation activities, such as creating or updating database tables, or migrating data.

    This will be invoked at least once for each tag, and may be invoked multiple times, such as in the event of failure.

    tag

    The tag to get the offset for.

    returns

    A Future that is redeemed when preparation is finished.

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (ReadSideHandler[Event], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ReadSideHandler[Event] to ArrowAssoc[ReadSideHandler[Event]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ReadSideHandler[Event] to any2stringadd[ReadSideHandler[Event]]

Inherited by implicit conversion StringFormat from ReadSideHandler[Event] to StringFormat[ReadSideHandler[Event]]

Inherited by implicit conversion Ensuring from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]]

Inherited by implicit conversion ArrowAssoc from ReadSideHandler[Event] to ArrowAssoc[ReadSideHandler[Event]]

Ungrouped