Package org.opendaylight.controller.remote.rpc.registry

Class RpcRegistry

java.lang.Object

org.apache.pekko.actor.AbstractActor

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

org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering

org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor<RoutingTable>

org.opendaylight.controller.remote.rpc.registry.RpcRegistry

All Implemented Interfaces:

Actor, ExecuteInSelfActor

public class RpcRegistry
extends BucketStoreActor<RoutingTable>

Registry to look up cluster nodes that have registered for a given RPC.

It uses BucketStoreActor to maintain this cluster-wide information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RpcRegistry.AddOrUpdateRoutes
static final class	RpcRegistry.RemoteRpcEndpoint
static final class	RpcRegistry.RemoveRoutes
static final class	RpcRegistry.UpdateRemoteEndpoints

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$

Constructor Summary

Constructors

Constructor	Description
RpcRegistry(RemoteOpsProviderConfig config, Path directory, ActorRef rpcInvoker, ActorRef rpcRegistrar)

Method Summary

Modifier and Type	Method	Description
protected void	handleReceive(Object message)	Receive and handle an incoming message.
protected Logger	log()
protected void	onBucketRemoved(Address address, Bucket<RoutingTable> bucket)	Callback to subclasses invoked when a bucket is removed.
protected void	onBucketsUpdated(Map<Address,Bucket<RoutingTable>> buckets)	Callback to subclasses invoked when the set of remote buckets is updated.
void	postStop()
void	preStart()
static Props	props(RemoteOpsProviderConfig config, Path directory, ActorRef rpcInvoker, ActorRef rpcRegistrar)	Create a new props instance for instantiating an RpcRegistry actor.

Methods inherited from class org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreActor

getConfig, getLocalData, getRemoteBuckets, getSender, getVersions, updateLocalBucket

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

getActorNameOverride

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, 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

RpcRegistry

public RpcRegistry(RemoteOpsProviderConfig config,
 Path directory,
 ActorRef rpcInvoker,
 ActorRef rpcRegistrar)

Method Details

props

public static Props props(RemoteOpsProviderConfig config,
 Path directory,
 ActorRef rpcInvoker,
 ActorRef rpcRegistrar)

Create a new props instance for instantiating an RpcRegistry actor.

Parameters:

config - Provider configuration

directory - Persistence directory

rpcInvoker - Actor handling RPC invocation requests from remote nodes

rpcRegistrar - Local RPC provider interface, used to register routers to remote nodes

Returns:

A new Props instance

log

protected Logger log()

Specified by:

log in class BucketStoreActor<RoutingTable>

preStart

public void preStart()
              throws IOException

Specified by:

preStart in interface Actor

Overrides:

preStart in class BucketStoreActor<RoutingTable>

Throws:

IOException

postStop

public void postStop()
              throws Exception

Specified by:

postStop in interface Actor

Overrides:

postStop 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).

Overrides:

handleReceive in class BucketStoreActor<RoutingTable>

Parameters:

message - the incoming message

onBucketRemoved

protected void onBucketRemoved(Address address,
 Bucket<RoutingTable> bucket)

Description copied from class: BucketStoreActor

Callback to subclasses invoked when a bucket is removed.

Specified by:

onBucketRemoved in class BucketStoreActor<RoutingTable>

Parameters:

address - Remote address

bucket - Bucket removed

onBucketsUpdated

protected void onBucketsUpdated(Map<Address,Bucket<RoutingTable>> buckets)

Description copied from class: BucketStoreActor

Callback to subclasses invoked when the set of remote buckets is updated.

Specified by:

onBucketsUpdated in class BucketStoreActor<RoutingTable>

Parameters:

buckets - Map of address to new bucket. Never null, but can be empty.