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
- Protected
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 async[Event, State](effect: Future[Effect[Event, State]]): Effect[Event, State]
Asynchronous command handling.
Asynchronous command handling. The effect is run when the
Futurehas been completed. Any incoming commands are stashed and processed later, after current command, when theFuturehas been completed.This can for example be used for retrieval of external information before validating the command.
- def asyncReply[Event, State](effect: Future[ReplyEffect[Event, State]]): ReplyEffect[Event, State]
Same as Effect.async when the
EventSourcedBehavioris created with EventSourcedBehavior.withEnforcedReplies. - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
noReplycan 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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](replyTo: ActorRef[ReplyMessage])(replyWithMessage: ReplyMessage): ReplyEffect[Event, 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
cmd.replyTo.tell.It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the
EventSourcedBehavioris created with EventSourcedBehavior.withEnforcedReplies. WhenwithEnforcedRepliesis used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also ifwithEnforcedRepliesisn'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
unstashAlleffect 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])