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
- Alphabetic
- By Inheritance
- EventSourcedBehavior
- DeferredBehavior
- Behavior
- AnyRef
- Any
- by BehaviorDecorators
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def apply(ctx: TypedActorContext[Command]): Behavior[Command]
- Definition Classes
- DeferredBehavior
- 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
. - 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.
This supervision is only around the event sourced behavior not any outer setup/withTimers block. If using restart, any actions e.g. scheduling timers, can be done on the PreRestart
If not specified the actor will be stopped on failure.
- abstract def persistenceId: PersistenceId
- 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
- abstract def signalHandler: PartialFunction[(State, Signal), Unit]
- returns
The currently defined signal handler or an empty handler if no custom handler previously defined
- 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.
- abstract def snapshotWhen(predicate: (State, Event, Long) => Boolean, deleteEventsOnSnapshot: Boolean): EventSourcedBehavior[Command, Event, State]
Can be used to delete events after
shouldSnapshot
.Can be used to delete events after
shouldSnapshot
.Can be used in combination with
EventSourcedBehavior.retentionCriteria
in a way that events are triggered up the the oldest snapshot based onRetentionCriteria.snapshotEvery
config. - 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 withsnapshotWhen
. Such deletes are only triggered by snapshots matching thenumberOfEvents
in the RetentionCriteria.Events can be deleted if
snapshotWhen(predicate, deleteEventsOnSnapshot = true)
is used. - abstract def withEventPublishing(enabled: Boolean): EventSourcedBehavior[Command, Event, State]
Publish events to the system event stream as akka.persistence.typed.PublishedEvent after they have been persisted
Publish events to the system event stream as akka.persistence.typed.PublishedEvent after they have been persisted
- Annotations
- @ApiMayChange()
- abstract def withJournalPluginId(id: String): EventSourcedBehavior[Command, Event, State]
Change the journal plugin id that this actor should use.
- abstract def withRecovery(recovery: Recovery): EventSourcedBehavior[Command, Event, State]
Change the recovery strategy.
Change the recovery strategy. By default, snapshots and events are recovered.
- abstract def withReplicatedEventInterceptor(interceptor: ReplicationInterceptor[State, Event]): EventSourcedBehavior[Command, Event, State]
Invoke this callback when an event from another replica arrives, delaying persisting the event until the returned future completes, if the future fails the actor is crashed.
Invoke this callback when an event from another replica arrives, delaying persisting the event until the returned future completes, if the future fails the actor is crashed.
Only used when the entity is replicated.
- Annotations
- @ApiMayChange()
- 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.
- abstract def withSnapshotPluginId(id: String): EventSourcedBehavior[Command, Event, State]
Change the snapshot store plugin id that this actor should use.
- abstract def withStashCapacity(size: Int): EventSourcedBehavior[Command, Event, State]
Define a custom stash capacity per entity.
Define a custom stash capacity per entity. If not defined, the default
akka.persistence.typed.stash-capacity
will be used. - 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 - abstract def withTaggerForState(tagger: (State, Event) => Set[String]): EventSourcedBehavior[Command, Event, State]
The
tagger
function should give event tags, which will be used in persistence query.The
tagger
function should give event tags, which will be used in persistence query. The state passed to the tagger allows for toggling a tag with one event but keep all events after it tagged based on a property or the type of the state. - 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
- 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 EventSourcedBehavior[Command, Event, State] toany2stringadd[EventSourcedBehavior[Command, Event, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- 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
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
forOuter
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
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
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 EventSourcedBehavior[Command, Event, State] toStringFormat[EventSourcedBehavior[Command, Event, State]] 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,formatted
resolves to the new method in String which has reversed parameters.
- 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.