abstract class EventSourcedBehavior[Command, Event, State] extends DeferredBehavior[Command]
- Alphabetic
- By Inheritance
- EventSourcedBehavior
- DeferredBehavior
- Behavior
- AnyRef
- Any
- by BehaviorDecorators
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EventSourcedBehavior(persistenceId: PersistenceId, onPersistFailure: BackoffSupervisorStrategy)
If using onPersistFailure the supervision is only around the event sourced behavior not any outer setup/withTimers block.
If using onPersistFailure the 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 signal or on the RecoveryCompleted signal.
- persistenceId
stable unique identifier for the event sourced behavior
- onPersistFailure
BackoffSupervisionStrategy for persist failures
- new EventSourcedBehavior(persistenceId: PersistenceId)
- persistenceId
stable unique identifier for the event sourced behavior
Abstract Value Members
- abstract def commandHandler(): CommandHandler[Command, Event, State]
Implement by handling incoming commands and return an
Effect()
to persist or signal other effects of the command handling such as stopping the behavior or others.Implement by handling incoming commands and return an
Effect()
to persist or signal other effects of the command handling such as stopping the behavior or others.Use EventSourcedBehavior#newCommandHandlerBuilder to define the command handlers.
The command handlers are only invoked when the actor is running (i.e. not replaying). While the actor is persisting events, the incoming messages are stashed and only delivered to the handler once persisting them has completed.
- Attributes
- protected
- abstract def emptyState: State
Implement by returning the initial empty state object.
Implement by returning the initial empty state object. This object will be passed into this behaviors handlers, until a new state replaces it.
Also known as "zero state" or "neutral state".
- Attributes
- protected
- abstract def eventHandler(): EventHandler[State, Event]
Implement by applying the event to the current state in order to return a new state.
Implement by applying the event to the current state in order to return a new state.
Use EventSourcedBehavior#newEventHandlerBuilder to define the event handlers.
The event handlers are invoked during recovery as well as running operation of this behavior, in order to keep updating the state state.
For that reason it is strongly discouraged to perform side-effects in this handler; Side effects should be executed in
thenRun
orrecoveryCompleted
blocks.- Attributes
- protected
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 Effect: EffectFactories[Event, State]
Factory of effects.
Factory of effects.
Return effects from your handlers in order to instruct persistence on how to act on the incoming message (i.e. persist events).
- Attributes
- protected
- def apply(context: TypedActorContext[Command]): Behavior[Command]
INTERNAL API: DeferredBehavior init, not for user extension
INTERNAL API: DeferredBehavior init, not for user extension
- Definition Classes
- EventSourcedBehavior → DeferredBehavior
- Annotations
- @InternalApi()
- 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]) @native() @HotSpotIntrinsicCandidate()
- 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
- def eventAdapter(): EventAdapter[Event, _]
Transform the event in another type before giving to the journal.
Transform the event in 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
. - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def journalPluginId: String
Override and define the journal plugin id that this actor should use instead of the default.
- final def lastSequenceNumber(ctx: ActorContext[_]): Long
The last sequence number that was persisted, can only be called from inside the handlers of an
EventSourcedBehavior
- 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
- def newCommandHandlerBuilder(): CommandHandlerBuilder[Command, Event, State]
- returns
A new, mutable, command handler builder
- Attributes
- protected
- final def newEventHandlerBuilder(): EventHandlerBuilder[State, Event]
- returns
A new, mutable, event handler builder
- Attributes
- protected
- final def newSignalHandlerBuilder(): SignalHandlerBuilder[State]
- returns
A new, mutable signal handler builder
- Attributes
- protected
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val persistenceId: PersistenceId
- def recovery: Recovery
Override to change the strategy for recovery of snapshots and events.
Override to change the strategy for recovery of snapshots and events. By default, snapshots and events are recovered.
- def retentionCriteria: RetentionCriteria
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.
- def shouldSnapshot(state: State, event: Event, sequenceNr: Long): Boolean
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.retentionCriteria with RetentionCriteria.snapshotEvery is used together withshouldSnapshot
. Such deletes are only triggered by snapshots matching thenumberOfEvents
in the RetentionCriteria.- returns
true
if snapshot should be saved at the givenstate
,event
andsequenceNr
when the event has been successfully persisted
- def signalHandler(): SignalHandler[State]
Override to react on general lifecycle signals and persistence specific signals (subtypes of akka.persistence.typed.EventSourcedSignal).
Override to react on general lifecycle signals and persistence specific signals (subtypes of akka.persistence.typed.EventSourcedSignal).
Use EventSourcedBehavior#newSignalHandlerBuilder to define the signal handler.
- Attributes
- protected
- def snapshotAdapter(): SnapshotAdapter[State]
Transform the state into another type before giving it to and from the journal.
Transform the state into another type before giving it to and from the journal. Can be used to migrate from different state types e.g. when migration from PersistentFSM to Typed EventSourcedBehavior.
- def snapshotPluginId: String
Override and define the snapshot store plugin id that this actor should use instead of the default.
- def stashCapacity: Optional[Integer]
Override to define a custom stash capacity per entity.
Override to define a custom stash capacity per entity. If not defined, the default
akka.persistence.typed.stash-capacity
will be used. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tagsFor(state: State, event: Event): Set[String]
Return tags to store for the given event and state, the tags can then be used in persistence query.
Return tags to store for the given event and state, the tags can then 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.
- def tagsFor(event: Event): Set[String]
Return tags to store for the given event, the tags can then be used in persistence query.
Return tags to store for the given event, the tags can then be used in persistence query.
If State) is overriden this method is ignored.
- 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
- Deprecated
- 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 snapshotSelectionCriteria: SnapshotSelectionCriteria
Override and define the snapshot selection criteria used by this actor instead of the default.
Override and define the snapshot selection criteria used by this actor instead of the default. 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) override recovery instead
- 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.