Class EffectFactories<State>
- java.lang.Object
-
- akka.persistence.typed.state.javadsl.EffectFactories<State>
-
- Direct Known Subclasses:
EffectFactories$
public class EffectFactories<State> extends java.lang.Object
Factory methods for creatingEffect
directives - how aDurableStateBehavior
reacts on a command. Created viaDurableStateBehavior.Effect
.Not for user extension
API May Change
-
-
Constructor Summary
Constructors Constructor Description EffectFactories()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EffectBuilder<State>
delete()
Delete the persisted state.EffectBuilder<State>
none()
Do not persist anythingReplyEffect<State>
noReply()
WhenDurableStateBehaviorWithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
.EffectBuilder<State>
persist(State state)
Persist new state.<ReplyMessage>
ReplyEffect<State>reply(ActorRef<ReplyMessage> replyTo, ReplyMessage replyWithMessage)
Send a reply message to the command.ReplyEffect<State>
stash()
Stash the current command.EffectBuilder<State>
stop()
Stop this persistent actorEffectBuilder<State>
unhandled()
This command is not handled, but it is not an error that it isn't.Effect<State>
unstashAll()
Unstash the commands that were stashed withEffectFactories.stash
.
-
-
-
Method Detail
-
persist
public final EffectBuilder<State> persist(State state)
Persist new state.Side effects can be chained with
thenRun
.
-
delete
public EffectBuilder<State> delete()
Delete the persisted state.Side effects can be chained with
thenRun
.
-
none
public EffectBuilder<State> none()
Do not persist anythingSide effects can be chained with
thenRun
-
stop
public EffectBuilder<State> stop()
Stop this persistent actorSide effects can be chained with
thenRun
-
unhandled
public EffectBuilder<State> unhandled()
This command is not handled, but it is not an error that it isn't.Side effects can be chained with
thenRun
-
stash
public ReplyEffect<State> stash()
Stash the current command. Can be unstashed later withEffect.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
.
-
unstashAll
public Effect<State> unstashAll()
Unstash the commands that were stashed withEffectFactories.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:
EffectBuilder.thenUnstashAll
-
reply
public <ReplyMessage> ReplyEffect<State> reply(ActorRef<ReplyMessage> replyTo, ReplyMessage replyWithMessage)
Send a reply message to the command. The type of the reply message must conform to the type specified by the passed replyToActorRef
.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 withDurableStateBehaviorWithEnforcedReplies
. WhenwithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
. The reply message will be sent also ifwithEnforcedReplies
isn't used, but then the compiler will not help finding mistakes.
-
noReply
public ReplyEffect<State> noReply()
WhenDurableStateBehaviorWithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
. ThisnoReply
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.
-
-