Package akka.persistence.typed.scaladsl
Interface EffectBuilder<Event,State>
-
- All Superinterfaces:
Effect<Event,State>
- All Known Implementing Classes:
CompositeEffect
,EffectImpl
,Persist
,PersistAll
,PersistNothing$
,Stash$
,Unhandled$
public interface EffectBuilder<Event,State> extends Effect<Event,State>
Run the given callback. Callbacks are run sequentially.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description scala.collection.immutable.Seq<Event>
events()
ReplyEffect<Event,State>
thenNoReply()
WhenEventSourcedBehavior.withEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
.<ReplyMessage>
ReplyEffect<Event,State>thenReply(ExpectingReply<ReplyMessage> cmd, scala.Function1<State,ReplyMessage> replyWithMessage)
Send a reply message to the command, which implementsExpectingReply
.EffectBuilder<Event,State>
thenRun(scala.Function1<State,scala.runtime.BoxedUnit> callback)
Run the given callback.EffectBuilder<Event,State>
thenStop()
The side effect is to stop the actorEffect<Event,State>
thenUnstashAll()
Unstash the commands that were stashed withEffect.stash
.
-
-
-
Method Detail
-
events
scala.collection.immutable.Seq<Event> events()
-
thenNoReply
ReplyEffect<Event,State> thenNoReply()
WhenEventSourcedBehavior.withEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
. ThisthenNoReply
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.- Returns:
- (undocumented)
-
thenReply
<ReplyMessage> ReplyEffect<Event,State> thenReply(ExpectingReply<ReplyMessage> cmd, scala.Function1<State,ReplyMessage> replyWithMessage)
Send a reply message to the command, which implementsExpectingReply
. The type of the reply message must conform to the type specified inExpectingReply.replyTo
ActorRef
.This has the same semantics as
cmd.replyTo.tell
.It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the
EventSourcedBehavior
is created withEventSourcedBehavior.withEnforcedReplies
. 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.- Parameters:
cmd
- (undocumented)replyWithMessage
- (undocumented)- Returns:
- (undocumented)
-
thenRun
EffectBuilder<Event,State> thenRun(scala.Function1<State,scala.runtime.BoxedUnit> callback)
Run the given callback. Callbacks are run sequentially.- Parameters:
callback
- (undocumented)- Returns:
- (undocumented)
-
thenStop
EffectBuilder<Event,State> thenStop()
The side effect is to stop the actor
-
thenUnstashAll
Effect<Event,State> thenUnstashAll()
Unstash the commands that were stashed withEffect.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
.- Returns:
- (undocumented)
-
-