sealed class EffectFactories[Event, State] extends AnyRef
Factory methods for creating Effect directives - how an event sourced actor reacts on a command. Created via EventSourcedBehavior.Effect.
Not for user extension
- Annotations
- @DoNotInherit()
- Source
- Effect.scala
- Alphabetic
- By Inheritance
- EffectFactories
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new EffectFactories()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to any2stringadd[EffectFactories[Event, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (EffectFactories[Event, State], B)
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to ArrowAssoc[EffectFactories[Event, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
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( ... )
-
def
ensuring(cond: (EffectFactories[Event, State]) ⇒ Boolean, msg: ⇒ Any): EffectFactories[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to Ensuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (EffectFactories[Event, State]) ⇒ Boolean): EffectFactories[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to Ensuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): EffectFactories[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to Ensuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): EffectFactories[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to Ensuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to StringFormat[EffectFactories[Event, State]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
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(): 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
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(): EffectBuilder[Event, State]
Do not persist anything
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
persist(events: List[Event]): EffectBuilder[Event, State]
Persist all of a the given events.
Persist all of a the given events. Each event will be applied through
applyEffect
separately but not until all events has been persisted. Ifcallback
is added through Effect#thenRun that will invoked after all the events has been persisted. -
final
def
persist(event: Event): EffectBuilder[Event, State]
Persist a single event
-
def
reply[ReplyMessage](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 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. -
def
stash(): ReplyEffect[Event, State]
Stash the current command.
Stash the current command. Can be unstashed later with
Effect.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
. -
def
stop(): EffectBuilder[Event, State]
Stop this persistent actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unhandled(): EffectBuilder[Event, State]
This command is not handled, but it is not an error that it isn't.
-
def
unstashAll(): 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
.- 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( ... )
-
def
→[B](y: B): (EffectFactories[Event, State], B)
- Implicit
- This member is added by an implicit conversion from EffectFactories[Event, State] to ArrowAssoc[EffectFactories[Event, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc