Package org.opendaylight.controller.cluster.notifications

Class RoleChangeNotifier

java.lang.Object

org.apache.pekko.actor.AbstractActor

org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor

org.opendaylight.controller.cluster.notifications.RoleChangeNotifier

All Implemented Interfaces:

AutoCloseable, Actor, ExecuteInSelfActor

public class RoleChangeNotifier
extends AbstractUntypedActor
implements AutoCloseable

The RoleChangeNotifier is responsible for receiving Raft role and leader state change messages and notifying the listeners (within the same node), which are registered with it.

The RoleChangeNotifier is instantiated by the Shard and injected into the RaftActor.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.actor.AbstractActor

AbstractActor.ActorContext, AbstractActor.Receive

Nested classes/interfaces inherited from interface org.apache.pekko.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Field Summary

Fields inherited from class org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor

LOG

Constructor Summary

Constructors

Constructor	Description
RoleChangeNotifier(String memberId)

Method Summary

Modifier and Type	Method	Description
void	close()
static Props	getProps(String memberId)
final ActorRef	getSender()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	handleReceive(Object message)	Receive and handle an incoming message.
void	preStart()

Methods inherited from class org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor

createReceive, executeInSelf, getContext, ignoreMessage, isValidSender, unknownMessage

Methods inherited from class org.apache.pekko.actor.AbstractActor

context, emptyBehavior, getSelf, org$apache$pekko$actor$Actor$_setter_$context_$eq, org$apache$pekko$actor$Actor$_setter_$self_$eq, postRestart, postStop, preRestart, preRestart, receive, receiveBuilder, self, supervisorStrategy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, sender, unhandled

Constructor Details

RoleChangeNotifier

public RoleChangeNotifier(String memberId)

Method Details

getProps

public static Props getProps(String memberId)

getSender

@Deprecated(since="11.0.0",
            forRemoval=true)
public final ActorRef getSender()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

getSender in class AbstractActor

preStart

public void preStart()
              throws Exception

Specified by:

preStart in interface Actor

Overrides:

preStart in class AbstractActor

Throws:

Exception

handleReceive

protected void handleReceive(Object message)

Description copied from class: AbstractUntypedActor

Receive and handle an incoming message. If the implementation does not handle this particular message, it should call AbstractUntypedActor.ignoreMessage(Object) or AbstractUntypedActor.unknownMessage(Object).

Specified by:

handleReceive in class AbstractUntypedActor

Parameters:

message - the incoming message

close

public void close()

Specified by:

close in interface AutoCloseable