akka.cluster

Class ClusterDomainEventPublisher

java.lang.Object

akka.cluster.ClusterDomainEventPublisher

All Implemented Interfaces:

Actor, ActorLogging, RequiresMessageQueue<UnboundedMessageQueueSemantics>

public final class ClusterDomainEventPublisher
extends java.lang.Object
implements Actor, ActorLogging, RequiresMessageQueue<UnboundedMessageQueueSemantics>

INTERNAL API. Responsible for domain event subscriptions and publishing of domain events to event bus.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
ClusterDomainEventPublisher()

Method Summary

Modifier and Type	Method and Description
void	clearState()
ActorContext	context() Stores the context for this actor, including self, and sender.
EventStream	eventStream()
Gossip	latestGossip()
void	postStop() User overridable callback.
void	preRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message) User overridable callback: '''By default it disposes of all children and then calls postStop().'''
void	publish(java.lang.Object event)
void	publishChanges(Gossip newGossip)
void	publishDiff(Gossip oldGossip, Gossip newGossip, scala.Function1<java.lang.Object,scala.runtime.BoxedUnit> pub)
void	publishInternalStats(ClusterEvent.CurrentInternalStats currentStats)
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
ActorRef	self() The 'self' field holds the ActorRef for this actor.
UniqueAddress	selfUniqueAddress()
void	sendCurrentClusterState(ActorRef receiver) The current snapshot state corresponding to latest gossip to mimic what you would have seen if you were listening to the events.
void	subscribe(ActorRef subscriber, ClusterEvent.SubscriptionInitialStateMode initMode, scala.collection.immutable.Set<java.lang.Class<?>> to)
void	unsubscribe(ActorRef subscriber, scala.Option<java.lang.Class<?>> to)

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, preStart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

ClusterDomainEventPublisher

public ClusterDomainEventPublisher()

Method Detail

context

public ActorContext context()

Description copied from interface: Actor

Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a UntypedActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

selfUniqueAddress

public UniqueAddress selfUniqueAddress()

latestGossip

public Gossip latestGossip()

preRestart

public void preRestart(java.lang.Throwable reason,
                       scala.Option<java.lang.Object> message)

Description copied from interface: Actor

User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Specified by:

preRestart in interface Actor

Parameters:

reason - the Throwable that caused the restart to happen

message - optionally the current message the actor processed when failing, if applicable

Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

postStop

public void postStop()

Description copied from interface: Actor

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Specified by:

postStop in interface Actor

receive

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Returns:

(undocumented)

eventStream

public EventStream eventStream()

sendCurrentClusterState

public void sendCurrentClusterState(ActorRef receiver)

The current snapshot state corresponding to latest gossip to mimic what you would have seen if you were listening to the events.

Parameters:

receiver - (undocumented)

subscribe

public void subscribe(ActorRef subscriber,
                      ClusterEvent.SubscriptionInitialStateMode initMode,
                      scala.collection.immutable.Set<java.lang.Class<?>> to)

unsubscribe

public void unsubscribe(ActorRef subscriber,
                        scala.Option<java.lang.Class<?>> to)

publishChanges

public void publishChanges(Gossip newGossip)

publishDiff

public void publishDiff(Gossip oldGossip,
                        Gossip newGossip,
                        scala.Function1<java.lang.Object,scala.runtime.BoxedUnit> pub)

publishInternalStats

public void publishInternalStats(ClusterEvent.CurrentInternalStats currentStats)

publish

public void publish(java.lang.Object event)

clearState

public void clearState()