abstract class DurableStateBehaviorWithEnforcedReplies[Command, State] extends DurableStateBehavior[Command, State]
A DurableStateBehavior that is enforcing that replies to commands are not forgotten.
There will be compilation errors if the returned effect isn't a ReplyEffect, which can be
created with Effects().reply
, Effects().noReply
, EffectBuilder.thenReply, or EffectBuilder.thenNoReply.
- Alphabetic
- By Inheritance
- DurableStateBehaviorWithEnforcedReplies
- DurableStateBehavior
- DeferredBehavior
- Behavior
- AnyRef
- Any
- by BehaviorDecorators
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DurableStateBehaviorWithEnforcedReplies(persistenceId: PersistenceId, backoffSupervisorStrategy: BackoffSupervisorStrategy)
- new DurableStateBehaviorWithEnforcedReplies(persistenceId: PersistenceId)
- new DurableStateBehaviorWithEnforcedReplies(persistenceId: PersistenceId, backoffSupervisorStrategy: Optional[BackoffSupervisorStrategy])
Abstract Value Members
- abstract def commandHandler(): CommandHandlerWithReply[Command, 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 DurableStateBehaviorWithEnforcedReplies#newCommandHandlerWithReplyBuilder to define the command handlers.
The command handlers are only invoked when the actor is running (i.e. not recovering). While the actor is persisting state, the incoming messages are stashed and only delivered to the handler once persisting them has completed.
- Attributes
- protected
- Definition Classes
- DurableStateBehaviorWithEnforcedReplies → DurableStateBehavior
- 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
- Definition Classes
- DurableStateBehavior
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 DurableStateBehaviorWithEnforcedReplies[Command, State] toany2stringadd[DurableStateBehaviorWithEnforcedReplies[Command, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DurableStateBehaviorWithEnforcedReplies[Command, State], B)
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toArrowAssoc[DurableStateBehaviorWithEnforcedReplies[Command, 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[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 state).
- Attributes
- protected
- Definition Classes
- DurableStateBehavior
- 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
- DurableStateBehavior → 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 DurableStateBehaviorWithEnforcedReplies[Command, 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 durableStateStorePluginId: String
Override and define the
DurableStateStore
plugin id that this actor should use instead of the default.Override and define the
DurableStateStore
plugin id that this actor should use instead of the default.- Definition Classes
- DurableStateBehavior
- def ensuring(cond: (DurableStateBehaviorWithEnforcedReplies[Command, State]) => Boolean, msg: => Any): DurableStateBehaviorWithEnforcedReplies[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toEnsuring[DurableStateBehaviorWithEnforcedReplies[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DurableStateBehaviorWithEnforcedReplies[Command, State]) => Boolean): DurableStateBehaviorWithEnforcedReplies[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toEnsuring[DurableStateBehaviorWithEnforcedReplies[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DurableStateBehaviorWithEnforcedReplies[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toEnsuring[DurableStateBehaviorWithEnforcedReplies[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DurableStateBehaviorWithEnforcedReplies[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toEnsuring[DurableStateBehaviorWithEnforcedReplies[Command, 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
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def lastSequenceNumber(ctx: ActorContext[_]): Long
The last sequence number that was persisted, can only be called from inside the handlers of a
DurableStateBehavior
The last sequence number that was persisted, can only be called from inside the handlers of a
DurableStateBehavior
- Definition Classes
- DurableStateBehavior
- 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, State]
Use DurableStateBehaviorWithEnforcedReplies#newCommandHandlerWithReplyBuilder instead, or extend DurableStateBehavior instead of DurableStateBehaviorWithEnforcedReplies.
Use DurableStateBehaviorWithEnforcedReplies#newCommandHandlerWithReplyBuilder instead, or extend DurableStateBehavior instead of DurableStateBehaviorWithEnforcedReplies.
- returns
A new, mutable, command handler builder
- Attributes
- protected
- Definition Classes
- DurableStateBehaviorWithEnforcedReplies → DurableStateBehavior
- Exceptions thrown
UnsupportedOperationException
use newCommandHandlerWithReplyBuilder instead
- def newCommandHandlerWithReplyBuilder(): CommandHandlerWithReplyBuilder[Command, State]
- returns
A new, mutable, command handler builder
- Attributes
- protected
- final def newSignalHandlerBuilder(): SignalHandlerBuilder[State]
- returns
A new, mutable signal handler builder
- Attributes
- protected
- Definition Classes
- DurableStateBehavior
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val persistenceId: PersistenceId
- Definition Classes
- DurableStateBehavior
- def signalHandler(): SignalHandler[State]
Override to react on general lifecycle signals and
DurableStateBehavior
specific signals (recovery related).Override to react on general lifecycle signals and
DurableStateBehavior
specific signals (recovery related). Those are all subtypes of akka.persistence.typed.state.DurableStateSignal.Use DurableStateBehavior#newSignalHandlerBuilder to define the signal handler.
- Attributes
- protected
- Definition Classes
- DurableStateBehavior
- def snapshotAdapter(): SnapshotAdapter[State]
Transform the state into another type before giving it to and from the store.
Transform the state into another type before giving it to and from the store. Can be used to migrate from different state types e.g. when migration from PersistentFSM to Typed DurableStateBehavior.
- Definition Classes
- DurableStateBehavior
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tag: String
The tag that can be used in persistence query.
The tag that can be used in persistence query.
- Definition Classes
- DurableStateBehavior
- 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 DurableStateBehaviorWithEnforcedReplies[Command, 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
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toStringFormat[DurableStateBehaviorWithEnforcedReplies[Command, 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): (DurableStateBehaviorWithEnforcedReplies[Command, State], B)
- Implicit
- This member is added by an implicit conversion from DurableStateBehaviorWithEnforcedReplies[Command, State] toArrowAssoc[DurableStateBehaviorWithEnforcedReplies[Command, 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.