abstract class Effect[+Event, State] extends AnyRef
A command handler returns an Effect
directive that defines what event or events to persist.
Additional side effects can be performed in the callback andThen
Instances of Effect
are available through factories EventSourcedBehavior.Effect.
Not intended for user extension.
- Self Type
- EffectImpl[Event, State]
- Annotations
- @DoNotInherit()
- Source
- Effect.scala
- Alphabetic
- By Inheritance
- Effect
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Effect()
Abstract Value Members
-
abstract
def
andThen(chainedEffect: SideEffect[State]): Effect[Event, State]
Run the given callback after the current Effect
-
abstract
def
thenNoReply(): ReplyEffect[Event, State]
When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This
thenNoReply
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. -
abstract
def
thenStop(): Effect[Event, State]
The side effect is to stop the actor
-
abstract
def
thenUnstashAll(): Effect[Event, 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
.
Concrete Value Members
-
def
thenReply[ReplyMessage](cmd: ExpectingReply[ReplyMessage], replyWithMessage: Function[State, ReplyMessage]): ReplyEffect[Event, State]
Send a reply message to the command, which implements ExpectingReply.
Send a reply message to the command, which implements ExpectingReply. The type of the reply message must conform to the type specified in ExpectingReply.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 with EventSourcedBehaviorWithEnforcedReplies. 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. -
final
def
thenRun(callback: japi.function.Effect): Effect[Event, State]
Run the given callback.
Run the given callback. Callbacks are run sequentially.
-
final
def
thenRun(callback: Procedure[State]): Effect[Event, State]
Run the given callback.
Run the given callback. Callbacks are run sequentially.