sealed class EffectFactories[State] extends AnyRef
Factory methods for creating Effect directives - how a DurableStateBehavior
reacts on a command.
Created via DurableStateBehavior.Effect.
Not for user extension
API May Change
- Annotations
- @ApiMayChange() @DoNotInherit()
- Source
- Effect.scala
- Alphabetic
- By Inheritance
- EffectFactories
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EffectFactories()
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 EffectFactories[State] toany2stringadd[EffectFactories[State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EffectFactories[State], B)
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toArrowAssoc[EffectFactories[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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (EffectFactories[State]) => Boolean, msg: => Any): EffectFactories[State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toEnsuring[EffectFactories[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EffectFactories[State]) => Boolean): EffectFactories[State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toEnsuring[EffectFactories[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EffectFactories[State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toEnsuring[EffectFactories[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EffectFactories[State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toEnsuring[EffectFactories[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 ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noReply(): ReplyEffect[State]
When DurableStateBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
When DurableStateBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This
noReply
can be used as a conscious decision that a reply shouldn't be sent for a specific command or the reply will be sent later. - def none(): EffectBuilder[State]
Do not persist anything
Do not persist anything
Side effects can be chained with
thenRun
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def persist(state: State): EffectBuilder[State]
Persist new state.
Persist new state.
Side effects can be chained with
thenRun
. - def reply[ReplyMessage](replyTo: ActorRef[ReplyMessage], replyWithMessage: ReplyMessage): ReplyEffect[State]
Send a reply message to the command.
Send a reply message to the command. The type of the reply message must conform to the type specified by the passed replyTo
ActorRef
.This has the same semantics as
replyTo.tell
.It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the
DurableStateBehavior
is created with DurableStateBehaviorWithEnforcedReplies. WhenwithEnforcedReplies
is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also ifwithEnforcedReplies
isn't used, but then the compiler will not help finding mistakes. - def stash(): ReplyEffect[State]
Stash the current command.
Stash the current command. Can be unstashed later with
Effect.thenUnstashAll
orEffectFactories.unstashAll
.Note that the stashed commands are kept in an in-memory buffer, so in case of a crash they will not be processed. They will also be discarded if the actor is restarted (or stopped) due to that an exception was thrown from processing a command or side effect after persisting. The stash buffer is preserved for persist failures if an
onPersistFailure
backoff supervisor strategy is defined.Side effects can be chained with
thenRun
. - def stop(): EffectBuilder[State]
Stop this persistent actor
Stop this persistent actor
Side effects can be chained with
thenRun
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unhandled(): EffectBuilder[State]
This command is not handled, but it is not an error that it isn't.
This command is not handled, but it is not an error that it isn't.
Side effects can be chained with
thenRun
- def unstashAll(): Effect[State]
Unstash the commands that were stashed with
EffectFactories.stash
.Unstash the commands that were stashed with
EffectFactories.stash
.It's allowed to stash messages while unstashing. Those newly added commands will not be processed by this
unstashAll
effect and have to be unstashed by anotherunstashAll
.- See also
- 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 EffectFactories[State] toStringFormat[EffectFactories[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): (EffectFactories[State], B)
- Implicit
- This member is added by an implicit conversion from EffectFactories[State] toArrowAssoc[EffectFactories[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.