Package org.opendaylight.controller.cluster.datastore.actors

Class ShardSnapshotActor

java.lang.Object

akka.actor.AbstractActor

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

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

org.opendaylight.controller.cluster.datastore.actors.ShardSnapshotActor

All Implemented Interfaces:

Actor, ExecuteInSelfActor

public final class ShardSnapshotActor
extends AbstractUntypedActorWithMetering

This is an offload actor, which is given an isolated snapshot of the data tree. It performs the potentially time-consuming operation of serializing the snapshot.

Author:

Robert Varga

Nested Class Summary

Nested classes/interfaces inherited from class akka.actor.AbstractActor

AbstractActor.ActorContext, AbstractActor.Receive

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Field Summary

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

LOG

Method Summary

Modifier and Type	Method	Description
protected void	handleReceive(Object message)	Receive and handle an incoming message.
static Props	props(InputOutputStreamFactory streamFactory)
static void	requestSnapshot(ActorRef snapshotActor, ShardDataTreeSnapshot snapshot, Optional<OutputStream> installSnapshotStream, ActorRef replyTo)	Sends a request to a ShardSnapshotActor to process a snapshot and send a CaptureSnapshotReply.

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, ignoreMessage, isValidSender, unknownMessage

Methods inherited from class akka.actor.AbstractActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, emptyBehavior, getContext, getSelf, getSender, postRestart, postStop, preRestart, preRestart, preStart, receive, receiveBuilder, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Method Detail

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

requestSnapshot

public static void requestSnapshot(ActorRef snapshotActor,
                                   ShardDataTreeSnapshot snapshot,
                                   Optional<OutputStream> installSnapshotStream,
                                   ActorRef replyTo)

Sends a request to a ShardSnapshotActor to process a snapshot and send a CaptureSnapshotReply.

Parameters:

snapshotActor - the ShardSnapshotActor

snapshot - the snapshot to process

installSnapshotStream - Optional OutputStream that is present if the snapshot is to also be installed on a follower.

replyTo - the actor to which to send the CaptureSnapshotReply

props

public static Props props(InputOutputStreamFactory streamFactory)