akka.persistence.multidc.scaladsl

Class EffectFactories<Command,Event,State>

java.lang.Object

akka.persistence.multidc.scaladsl.EffectFactories<Command,Event,State>

Direct Known Subclasses:

Effect$

public class EffectFactories<Command,Event,State>
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
EffectFactories()

Method Summary

Modifier and Type	Method and Description
Effect<Event,State>	none() Signal completion of handling a command, without applying any external effects.
Effect<Event,State>	passivate(Command msg) 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.
<A extends Event,B extends Event> Effect<Event,State>	persist(A evt1, B evt2) Has the same behaviour as persist(List(evt1, evt2))
<A extends Event,B extends Event,C extends Event> Effect<Event,State>	persist(A evt1, B evt2, C evt3) Has the same behaviour as persist(List(evt1, evt2, evt3))
Effect<Event,State>	persist(Event event) Persist a single event
Effect<Event,State>	persist(scala.Option<Event> eventOpt) If eventOpt contains an event, persist it or do nothing if empty.
Effect<Event,State>	persist(scala.collection.immutable.Seq<Event> events) Persist all of a the given events.
Effect<Event,State>	stop() Stops the replicated entity after handling the current command.
Effect<Event,State>	unhandled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EffectFactories

public EffectFactories()

Method Detail

none

public Effect<Event,State> none()

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

Returns:

(undocumented)

passivate

public Effect<Event,State> passivate(Command msg)

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.

Parameters:

msg - (undocumented)

Returns:

(undocumented)

persist

public Effect<Event,State> persist(Event event)

Persist a single event

Parameters:

event - (undocumented)

Returns:

(undocumented)

persist

public Effect<Event,State> persist(scala.collection.immutable.Seq<Event> 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(scala.Function1<State, scala.runtime.BoxedUnit>) that will invoked after all the events has been persisted.

Parameters:

events - (undocumented)

Returns:

(undocumented)

persist

public <A extends Event,B extends Event> Effect<Event,State> persist(A evt1,
                                                                     B evt2)

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

Parameters:

evt1 - (undocumented)

evt2 - (undocumented)

Returns:

(undocumented)

persist

public <A extends Event,B extends Event,C extends Event> Effect<Event,State> persist(A evt1,
                                                                                     B evt2,
                                                                                     C evt3)

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

Parameters:

evt1 - (undocumented)

evt2 - (undocumented)

evt3 - (undocumented)

Returns:

(undocumented)

persist

public Effect<Event,State> persist(scala.Option<Event> eventOpt)

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

Parameters:

eventOpt - (undocumented)

Returns:

(undocumented)

stop

public Effect<Event,State> stop()

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

Returns:

(undocumented)

unhandled

public Effect<Event,State> unhandled()