object Effect
Factory methods for creating Effect directives - how an event sourced actor reacts on a command.
- Source
- Effect.scala
- Alphabetic
- By Inheritance
- Effect
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- 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[Event, State]: ReplyEffect[Event, State]
When EventSourcedBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
When EventSourcedBehavior.withEnforcedReplies 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[Event, State]: EffectBuilder[Event, 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()
-
def
persist[Event, State](events: Seq[Event]): EffectBuilder[Event, State]
Persist multiple events
Persist multiple events
Side effects can be chained with
thenRun
-
def
persist[Event, A <: Event, B <: Event, State](evt1: A, evt2: B, events: Event*): EffectBuilder[Event, State]
Persist multiple events
Persist multiple events
Side effects can be chained with
thenRun
-
def
persist[Event, State](event: Event): EffectBuilder[Event, State]
Persist a single event
Persist a single event
Side effects can be chained with
thenRun
-
def
reply[ReplyMessage, Event, State](cmd: ExpectingReply[ReplyMessage])(replyWithMessage: 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 EventSourcedBehavior.withEnforcedReplies. 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[Event, State](): ReplyEffect[Event, State]
Stash the current command.
Stash the current command. Can be unstashed later with Effect.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 a backoff supervisor strategy is defined with EventSourcedBehavior.onPersistFailure.
Side effects can be chained with
thenRun
-
def
stop[Event, State](): EffectBuilder[Event, State]
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[Event, State]: EffectBuilder[Event, 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[Event, State](): Effect[Event, State]
Unstash the commands that were stashed with Effect.stash.
Unstash the commands that were stashed with Effect.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
Effect.thenUnstashAll
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )