Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package lightbend
    Definition Classes
    com
  • package lagom
    Definition Classes
    lightbend
  • package scaladsl
    Definition Classes
    lagom
  • package persistence
    Definition Classes
    scaladsl
  • abstract class PersistentEntity extends AnyRef

    A PersistentEntity has a stable entity identifier, with which it can be accessed from anywhere in the cluster.

    A PersistentEntity has a stable entity identifier, with which it can be accessed from anywhere in the cluster. It is run by an actor and the state is persistent using event sourcing.

    initialState and behavior are abstract methods that your concrete subclass must implement. The behavior is defined as a set of actions given a state. The actions are functions to process incoming commands and persisted events.

    The PersistentEntity receives commands of type Command that can be validated before persisting state changes as events of type Event. The functions that process incoming commands are registered in the Actions using onCommand of the Actions.

    A command may also be read-only and only perform some side-effect, such as replying to the request. Such command handlers are registered using onReadOnlyCommand of the Actions. Replies are sent with the reply method of the context that is passed to the command handler function.

    A command handler returns a Persist directive that defines what event or events, if any, to persist. Use the thenPersist, thenPersistAll or done methods of the context that is passed to the command handler function to create the Persist directive.

    When an event has been persisted successfully the state of type State is updated by applying the event to the current state. The functions for updating the state are registered with the onEvent method of the Actions. The event handler returns the new state. The state must be immutable, so you return a new instance of the state. Current state is passed as parameter to the event handler. The same event handlers are also used when the entity is started up to recover its state from the stored events.

    After persisting an event, external side effects can be performed in the afterPersist function that can be defined when creating the Persist directive. A typical side effect is to reply to the request to confirm that it was performed successfully. Replies are sent with the reply method of the context that is passed to the command handler function.

    The command handlers may emit zero, one or many events. When many events are emitted, they are stored atomically and in the same order they were emitted. Only after persisting all the events external side effects will be performed.

    The event handlers are typically only updating the state, but they may also change the behavior of the entity in the sense that new functions for processing commands and events may be defined for a given state. This is useful when implementing finite state machine (FSM) like entities.

    When the entity is started the state is recovered by replaying stored events. To reduce this recovery time the entity may start the recovery from a snapshot of the state and then only replaying the events that were stored after the snapshot. Such snapshots are automatically saved after a configured number of persisted events.

    Definition Classes
    persistence
  • Actions
  • Command
  • CommandContext
  • Event
  • Persist
  • ReadOnlyCommandContext
  • State

class Actions extends (State) ⇒ Actions

Actions consists of functions to process incoming commands and persisted events. Actions is an immutable class.

Source
PersistentEntity.scala
Linear Supertypes
(State) ⇒ Actions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Actions
  2. Function1
  3. AnyRef
  4. 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 Actions(eventHandler: EventHandler, commandHandlers: Map[Class[_], CommandHandler])

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 Actions to any2stringadd[Actions] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Actions, B)
    Implicit
    This member is added by an implicit conversion from Actions to ArrowAssoc[Actions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[A](g: (Actions) ⇒ A): (State) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. def apply(state: State): Actions

    Extends State => Actions so that it can be used directly in PersistentEntity#behavior when there is only one set of actions independent of state.

    Extends State => Actions so that it can be used directly in PersistentEntity#behavior when there is only one set of actions independent of state.

    Definition Classes
    Actions → Function1
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val commandHandlers: Map[Class[_], CommandHandler]
  11. def compose[A](g: (A) ⇒ State): (A) ⇒ Actions
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. def ensuring(cond: (Actions) ⇒ Boolean, msg: ⇒ Any): Actions
    Implicit
    This member is added by an implicit conversion from Actions to Ensuring[Actions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Actions) ⇒ Boolean): Actions
    Implicit
    This member is added by an implicit conversion from Actions to Ensuring[Actions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): Actions
    Implicit
    This member is added by an implicit conversion from Actions to Ensuring[Actions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Actions
    Implicit
    This member is added by an implicit conversion from Actions to Ensuring[Actions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. val eventHandler: EventHandler
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Actions to StringFormat[Actions] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def onCommand[C <: Command with ReplyType[Reply], Reply](handler: PartialFunction[(Command, CommandContext[Reply], State), Persist])(implicit arg0: ClassTag[C]): Actions

    Add a command handler.

    Add a command handler. For each command class the handler is a PartialFunction. Adding a handler for a command class that was previously defined will replace the previous handler for that class. It is possible to combine handlers from two different Actions with #orElse method.

  28. def onEvent(handler: EventHandler): Actions

    Add an event handler.

    Add an event handler. Each handler is a PartialFunction and they will be tried in the order they were added, i.e. they are combined with orElse.

  29. def onReadOnlyCommand[C <: Command with ReplyType[Reply], Reply](handler: PartialFunction[(Command, ReadOnlyCommandContext[Reply], State), Unit])(implicit arg0: ClassTag[C]): Actions

    Add a command handler that will not persist any events.

    Add a command handler that will not persist any events. This is a convenience method to #onCommand. For each command class the handler is a PartialFunction. Adding a handler for a command class that was previously defined will replace the previous handler for that class. It is possible to combine handlers from two different Actions with #orElse method.

  30. def orElse(b: Actions): Actions

    Append eventHandler and commandHandlers from b to the handlers of this Actions.

    Append eventHandler and commandHandlers from b to the handlers of this Actions.

    Event handlers are combined with orElse of the partial functions.

    Command handlers for a specific command class that are defined in both b and this Actions will be combined with orElse of the partial functions.

  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    Function1 → 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( ... ) @native()
  36. def →[B](y: B): (Actions, B)
    Implicit
    This member is added by an implicit conversion from Actions to ArrowAssoc[Actions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from (State) ⇒ Actions

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Actions to any2stringadd[Actions]

Inherited by implicit conversion StringFormat from Actions to StringFormat[Actions]

Inherited by implicit conversion Ensuring from Actions to Ensuring[Actions]

Inherited by implicit conversion ArrowAssoc from Actions to ArrowAssoc[Actions]

Ungrouped