trait DurableStateBehavior[Command, State] extends DeferredBehavior[Command]
Further customization of the DurableStateBehavior
can be done with the methods defined here.
Not for user extension
API May Change
- Annotations
- @ApiMayChange() @DoNotInherit()
- Source
- DurableStateBehavior.scala
- Alphabetic
- By Inheritance
- DurableStateBehavior
- 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 onPersistFailure(backoffStrategy: BackoffSupervisorStrategy): DurableStateBehavior[Command, 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 state has been persisted.
This supervision is only around the
DurableStateBehavior
not any outer setup/withTimers block. If using restart, any actions e.g. scheduling timers, can be done on the PreRestartIf not specified the actor will be stopped on failure.
- abstract def persistenceId: PersistenceId
- abstract def receiveSignal(signalHandler: PartialFunction[(State, Signal), Unit]): DurableStateBehavior[Command, State]
Allows the
DurableStateBehavior
to react on signals.Allows the
DurableStateBehavior
to react on signals.The regular lifecycle signals can be handled as well as
DurableStateBehavior
specific signals (recovery related). Those are all subtypes of akka.persistence.typed.state.DurableStateSignal - 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]): DurableStateBehavior[Command, State]
Transform the state to another type before giving to the store.
Transform the state to another type before giving to the store. Can be used to transform older state types into the current state type e.g. when migrating from Persistent FSM to Typed DurableStateBehavior.
- abstract def withDurableStateStorePluginId(id: String): DurableStateBehavior[Command, State]
Change the
DurableStateStore
plugin id that this actor should use. - abstract def withStashCapacity(size: Int): DurableStateBehavior[Command, 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 withTag(tag: String): DurableStateBehavior[Command, State]
The tag that can used in persistence query
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 DurableStateBehavior[Command, State] toany2stringadd[DurableStateBehavior[Command, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DurableStateBehavior[Command, State], B)
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toArrowAssoc[DurableStateBehavior[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 asInstanceOf[T0]: T0
- Definition Classes
- Any
- val behavior: Behavior[Command]
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[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 ensuring(cond: (DurableStateBehavior[Command, State]) => Boolean, msg: => Any): DurableStateBehavior[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toEnsuring[DurableStateBehavior[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DurableStateBehavior[Command, State]) => Boolean): DurableStateBehavior[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toEnsuring[DurableStateBehavior[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DurableStateBehavior[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toEnsuring[DurableStateBehavior[Command, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DurableStateBehavior[Command, State]
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toEnsuring[DurableStateBehavior[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 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
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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 DurableStateBehavior[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
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toStringFormat[DurableStateBehavior[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): (DurableStateBehavior[Command, State], B)
- Implicit
- This member is added by an implicit conversion from DurableStateBehavior[Command, State] toArrowAssoc[DurableStateBehavior[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.