Packages

c

akka.persistence.typed.javadsl

EffectFactories

sealed class EffectFactories[Event, State] extends AnyRef

Factory methods for creating Effect directives - how a persistent actor reacts on a command. Created via EventSourcedBehavior.Effect.

Not for user extension

Annotations
@DoNotInherit()
Source
Effect.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EffectFactories
  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

Instance Constructors

  1. new EffectFactories()

Value Members

  1. 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.

  2. def none(): Effect[Event, State]

    Do not persist anything

  3. final def persist(events: List[Event]): Effect[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. If an afterCallBack is added through Effect#andThen that will invoked after all the events has been persisted.

  4. final def persist(event: Event): Effect[Event, State]

    Persist a single event

  5. 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. 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.

  6. def stash(): ReplyEffect[Event, State]

    Stash the current command.

    Stash the current command. Can be unstashed later with Effect.thenUnstashAll or EffectFactories.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 andThen.

  7. def stop(): Effect[Event, State]

    Stop this persistent actor

  8. def unhandled(): Effect[Event, State]

    This command is not handled, but it is not an error that it isn't.

  9. 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 another unstashAll.

    Side effects can be chained with andThen, but note that the side effect is run immediately and not after processing all unstashed commands.

    See also

    Effect.thenUnstashAll