Package org.apache.pekko.persistence.typed.scaladsl

Interface EffectBuilder<Event,State>

All Superinterfaces:
Effect<Event,State>
All Known Implementing Classes:
PersistNothing$, Stash$, Unhandled$
public interface EffectBuilder<Event,State> extends Effect<Event,State>
A command handler returns an Effect directive that defines what event or events to persist.

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

Additional side effects can be performed in the callback thenRun

Not for user extension.

  • Method Details

    • events

      scala.collection.immutable.Seq<Event> events()

    • thenNoReply

      ReplyEffect<Event,State> thenNoReply()
      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.

    • thenReply

      <ReplyMessage> ReplyEffect<Event,State> thenReply(ActorRef<ReplyMessage> replyTo, scala.Function1<State,ReplyMessage> replyWithMessage)
      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 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.

    • thenRun

      EffectBuilder<Event,State> thenRun(scala.Function1<State,scala.runtime.BoxedUnit> callback)
      Run the given callback. Callbacks are run sequentially.

    • thenStop

      EffectBuilder<Event,State> thenStop()
      The side effect is to stop the actor

    • thenUnstashAll

      Effect<Event,State> thenUnstashAll()
      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.