Packages

trait Effect[+Event, State] extends AnyRef

Instances are created through the factories in the Effect companion object.

Not for user extension.

Annotations
@DoNotInherit()
Source
Effect.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effect
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def andThen(chainedEffect: SideEffect[State]): Effect[Event, State]

    Run the given callback after the current Effect

  2. abstract def events: Seq[Event]
  3. abstract def thenNoReply(): 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 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.

  4. abstract def thenStop(): Effect[Event, State]

    The side effect is to stop the actor

  5. abstract def thenUnstashAll(): 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 another unstashAll.

Concrete Value Members

  1. final def andThen(chainedEffects: Seq[SideEffect[State]]): Effect[Event, State]

    Run the given callbacks sequentially after the current Effect

  2. def thenReply[ReplyMessage](cmd: ExpectingReply[ReplyMessage])(replyWithMessage: (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 EventSourcedBehavior.withEnforcedReplies. When withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also if withEnforcedReplies isn't used, but then the compiler will not help finding mistakes.

  3. final def thenRun(callback: (State) ⇒ Unit): Effect[Event, State]

    Run the given callback.

    Run the given callback. Callbacks are run sequentially.