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

Instance Constructors

  1. new EffectFactories()

Value Members

  1. def async(effect: [Effect[Event, State]]): Effect[Event, State]

    Asynchronous command handling.

    Asynchronous command handling. The effect is run when the CompletionStage has been completed. Any incoming commands are stashed and processed later, after current command, when the CompletionStage has been completed.

    This can for example be used for retrieval of external information before validating the command.

  2. def asyncReply(effect: [ReplyEffect[Event, State]]): ReplyEffect[Event, State]

    Same as EffectFactories.async when the EventSourcedBehavior is created with EventSourcedBehaviorWithEnforcedReplies.

  3. def noReply(): ReplyEffect[Event, State]

    When is used there will be compilation errors if the returned effect isn't a ReplyEffect.

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

  4. def none(): EffectBuilder[Event, State]

    Do not persist anything

  5. final def persist(events: List[Event]): EffectBuilder[Event, State]

    Persist multiple events.

    Persist multiple events. If callback is added through EffectBuilder.thenRun that will invoked after all the events has been persisted.

  6. final def persist(event: Event): EffectBuilder[Event, State]

    Persist a single event.

  7. final def persistWithMetadata(eventsWithMetadata: [EventWithMetadata[Event]]): EffectBuilder[Event, State]

    Persist multiple events and additional metadata together with the events.

    Persist multiple events and additional metadata together with the events. If callback is added through EffectBuilder.thenRun that will invoked after all the events has been persisted.

  8. final def persistWithMetadata(eventWithMetadata: EventWithMetadata[Event]): EffectBuilder[Event, State]

    Persist a single event and additional metadata together with the event.

  9. def reply[ReplyMessage](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 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.

  10. 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 thenRun.

  11. def stop(): EffectBuilder[Event, State]

    Stop this persistent actor

  12. def unhandled(): EffectBuilder[Event, State]

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

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

    See also

    EffectBuilder.thenUnstashAll