Class

akka.persistence.multidc.scaladsl

EffectFactories

Related Doc: package scaladsl

Permalink

class EffectFactories[Command, Event, State] extends AnyRef

Not intended for user extension. Access an instance through ReplicatedEntity#Effect.

Annotations
@DoNotInherit()
Linear Supertypes
Known Subclasses
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()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to any2stringadd[EffectFactories[Command, Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EffectFactories[Command, Event, State], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to ArrowAssoc[EffectFactories[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (EffectFactories[Command, Event, State]) ⇒ Boolean, msg: ⇒ Any): EffectFactories[Command, Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to Ensuring[EffectFactories[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EffectFactories[Command, Event, State]) ⇒ Boolean): EffectFactories[Command, Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to Ensuring[EffectFactories[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): EffectFactories[Command, Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to Ensuring[EffectFactories[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EffectFactories[Command, Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to Ensuring[EffectFactories[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to StringFormat[EffectFactories[Command, Event, State]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def none: Effect[Event, State]

    Permalink

    Signal completion of handling a command, without applying any external effects.

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def passivate(msg: Command): Effect[Event, State]

    Permalink

    Allows for graceful passivation of the replicated entity when used with Cluster Sharding, without the risk of dropping messages that are currently enqueued in its mailbox.

    Allows for graceful passivation of the replicated entity when used with Cluster Sharding, without the risk of dropping messages that are currently enqueued in its mailbox.

    Using sharding also triggers automatic passivation based on inactivity, see auto-passivate-after in reference.conf for more details.

    Passivation is often implemented in order to safely stop the replicated entity, and free up memory for use for other active entities. This can be done as direct effect of handling a Command or by defining receive timeout (context.setReceiveTimeout).

    If a message is already enqueued to the entity when it stops itself the enqueued message in the mailbox will be dropped. Passivation is implemented by notifying the entity's parent ShardRegion using a Passivate message, same as in Cluster Sharding.

    The specified wrapped stopMessage will be sent back to the entity, which is then supposed to stop itself. Incoming messages will be buffered by the ShardRegion between reception of Passivate and termination of the entity. Such buffered messages are thereafter delivered to a new incarnation of the entity.

    If the replicated entity is used without sharding the command is sent to the entity itself directly.

  24. def persist(eventOpt: Option[Event]): Effect[Event, State]

    Permalink

    If eventOpt contains an event, persist it or do nothing if empty.

  25. def persist[A <: Event, B <: Event, C <: Event](evt1: A, evt2: B, evt3: C): Effect[Event, State]

    Permalink

    Has the same behaviour as persist(List(evt1, evt2, evt3))

  26. def persist[A <: Event, B <: Event](evt1: A, evt2: B): Effect[Event, State]

    Permalink

    Has the same behaviour as persist(List(evt1, evt2))

  27. def persist(events: Seq[Event]): Effect[Event, State]

    Permalink

    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.

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

    Permalink

    Persist a single event

  29. def stop: Effect[Event, State]

    Permalink

    Stops the replicated entity after handling the current command.

    Stops the replicated entity after handling the current command. It still is possible to attach andThen callbacks, to be executed before the entity stops.

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. def unhandled: Effect[Event, State]

    Permalink
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def [B](y: B): (EffectFactories[Command, Event, State], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EffectFactories[Command, Event, State] to ArrowAssoc[EffectFactories[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EffectFactories[Command, Event, State] to any2stringadd[EffectFactories[Command, Event, State]]

Inherited by implicit conversion StringFormat from EffectFactories[Command, Event, State] to StringFormat[EffectFactories[Command, Event, State]]

Inherited by implicit conversion Ensuring from EffectFactories[Command, Event, State] to Ensuring[EffectFactories[Command, Event, State]]

Inherited by implicit conversion ArrowAssoc from EffectFactories[Command, Event, State] to ArrowAssoc[EffectFactories[Command, Event, State]]

Ungrouped