Packages

trait EventSourcedBehavior[Command, Event, State] extends DeferredBehavior[Command]

Further customization of the EventSourcedBehavior can be done with the methods defined here.

Not for user extension

Annotations
@DoNotInherit()
Source
EventSourcedBehavior.scala
Linear Supertypes
DeferredBehavior[Command], Behavior[Command], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventSourcedBehavior
  2. DeferredBehavior
  3. Behavior
  4. AnyRef
  5. Any
Implicitly
  1. by BehaviorDecorators
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(ctx: TypedActorContext[Command]): Behavior[Command]
    Definition Classes
    DeferredBehavior
  2. abstract def eventAdapter(adapter: EventAdapter[Event, _]): EventSourcedBehavior[Command, Event, State]

    Transform the event to another type before giving to the journal.

    Transform the event to another type before giving to the journal. Can be used to wrap events in types Journals understand but is of a different type than Event.

  3. abstract def onPersistFailure(backoffStrategy: BackoffSupervisorStrategy): EventSourcedBehavior[Command, Event, State]

    Back off strategy for persist failures.

    Back off strategy for persist failures.

    Specifically BackOff to prevent resume being used. Resume is not allowed as it will be unknown if the event has been persisted.

    If not specified the actor will be stopped on failure.

  4. abstract def persistenceId: PersistenceId
  5. abstract def receiveSignal(signalHandler: PartialFunction[(State, Signal), Unit]): EventSourcedBehavior[Command, Event, State]

    Allows the event sourced behavior to react on signals.

    Allows the event sourced behavior to react on signals.

    The regular lifecycle signals can be handled as well as Akka Persistence specific signals (snapshot and recovery related). Those are all subtypes of akka.persistence.typed.EventSourcedSignal

  6. abstract def signalHandler: PartialFunction[(State, Signal), Unit]

    returns

    The currently defined signal handler or an empty handler if no custom handler previously defined

  7. abstract def snapshotAdapter(adapter: SnapshotAdapter[State]): EventSourcedBehavior[Command, Event, State]

    Transform the state to another type before giving to the journal.

    Transform the state to another type before giving to the journal. Can be used to transform older state types into the current state type e.g. when migrating from Persistent FSM to Typed EventSourcedBehavior.

  8. abstract def snapshotWhen(predicate: (State, Event, Long) => Boolean): EventSourcedBehavior[Command, Event, State]

    Initiates a snapshot if the given predicate evaluates to true.

    Initiates a snapshot if the given predicate evaluates to true.

    Decide to store a snapshot based on the State, Event and sequenceNr when the event has been successfully persisted.

    When persisting multiple events at once the snapshot is triggered after all the events have been persisted.

    Snapshots triggered by snapshotWhen will not trigger deletes of old snapshots and events if EventSourcedBehavior.withRetention with RetentionCriteria.snapshotEvery is used together with snapshotWhen. Such deletes are only triggered by snapshots matching the numberOfEvents in the RetentionCriteria.

  9. abstract def withJournalPluginId(id: String): EventSourcedBehavior[Command, Event, State]

    Change the journal plugin id that this actor should use.

  10. abstract def withRecovery(recovery: Recovery): EventSourcedBehavior[Command, Event, State]

    Change the recovery strategy.

    Change the recovery strategy. By default, snapshots and events are recovered.

  11. abstract def withRetention(criteria: RetentionCriteria): EventSourcedBehavior[Command, Event, State]

    Criteria for retention/deletion of snapshots and events.

    Criteria for retention/deletion of snapshots and events. By default, retention is disabled and snapshots are not saved and deleted automatically.

  12. abstract def withSnapshotPluginId(id: String): EventSourcedBehavior[Command, Event, State]

    Change the snapshot store plugin id that this actor should use.

  13. abstract def withTagger(tagger: (Event) => Set[String]): EventSourcedBehavior[Command, Event, State]

    The tagger function should give event tags, which will be used in persistence query

  14. abstract def withSnapshotSelectionCriteria(selection: SnapshotSelectionCriteria): EventSourcedBehavior[Command, Event, State]

    Changes the snapshot selection criteria used by this behavior.

    Changes the snapshot selection criteria used by this behavior. By default the most recent snapshot is used, and the remaining state updates are recovered by replaying events from the sequence number up until which the snapshot reached.

    You may configure the behavior to skip replaying snapshots completely, in which case the recovery will be performed by replaying all events -- which may take a long time.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.5) use withRecovery(Recovery.withSnapshotSelectionCriteria(...))

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 EventSourcedBehavior[Command, Event, State] toany2stringadd[EventSourcedBehavior[Command, Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventSourcedBehavior[Command, Event, State], B)
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toArrowAssoc[EventSourcedBehavior[Command, Event, State]] 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. val behavior: Behavior[Command]
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toBehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (EventSourcedBehavior[Command, Event, State]) => Boolean, msg: => Any): EventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toEnsuring[EventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (EventSourcedBehavior[Command, Event, State]) => Boolean): EventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toEnsuring[EventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): EventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toEnsuring[EventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): EventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toEnsuring[EventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toStringFormat[EventSourcedBehavior[Command, Event, State]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def narrow[U <: Command]: Behavior[U]

    Narrow the type of this Behavior, which is always a safe operation.

    Narrow the type of this Behavior, which is always a safe operation. This method is necessary to implement the contravariant nature of Behavior (which cannot be expressed directly due to type inference problems).

    Definition Classes
    Behavior
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def transformMessages[Outer](matcher: PartialFunction[Outer, Command])(implicit arg0: ClassTag[Outer]): Behavior[Outer]

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy.

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy. Signals are not transformed.

    Example:

    val b: Behavior[Number] =
      Behaviors
        .receive[String] { (ctx, msg) =>
          println(msg)
          Behaviors.same
        }
        .transformMessages[Number] {
          case b: BigDecimal => s"BigDecimal($b)"
          case i: BigInt     => s"BigInteger($i)"
          // all other kinds of Number will be `unhandled`
        }

    The ClassTag for Outer ensures that only messages of this class or a subclass thereof will be intercepted. Other message types (e.g. a private protocol) will bypass the interceptor and be continue to the inner behavior untouched.

    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toBehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (EventSourcedBehavior[Command, Event, State], B)
    Implicit
    This member is added by an implicit conversion from EventSourcedBehavior[Command, Event, State] toArrowAssoc[EventSourcedBehavior[Command, Event, State]] 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 DeferredBehavior[Command]

Inherited from Behavior[Command]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BehaviorDecorators fromEventSourcedBehavior[Command, Event, State] to BehaviorDecorators[Command]

Inherited by implicit conversion any2stringadd fromEventSourcedBehavior[Command, Event, State] to any2stringadd[EventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion StringFormat fromEventSourcedBehavior[Command, Event, State] to StringFormat[EventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion Ensuring fromEventSourcedBehavior[Command, Event, State] to Ensuring[EventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion ArrowAssoc fromEventSourcedBehavior[Command, Event, State] to ArrowAssoc[EventSourcedBehavior[Command, Event, State]]

Ungrouped