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

Class ShardSnapshotActor

  • All Implemented Interfaces:
    akka.actor.Actor, org.opendaylight.controller.cluster.common.actor.ExecuteInSelfActor
    public final class ShardSnapshotActor
extends org.opendaylight.controller.cluster.common.actor.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

        akka.actor.AbstractActor.ActorContext, akka.actor.AbstractActor.Receive

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

        akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

    • Field Summary

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

        LOG

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void handleReceive​(Object message)  
      static akka.actor.Props props​(org.opendaylight.controller.cluster.io.InputOutputStreamFactory streamFactory)  
      static void requestSnapshot​(akka.actor.ActorRef snapshotActor, ShardDataTreeSnapshot snapshot, Optional<OutputStream> installSnapshotStream, akka.actor.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

    • Method Detail

      • handleReceive

        protected void handleReceive​(Object message)
        Specified by:
        handleReceive in class org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor

      • requestSnapshot

        public static void requestSnapshot​(akka.actor.ActorRef snapshotActor,
                                   ShardDataTreeSnapshot snapshot,
                                   Optional<OutputStream> installSnapshotStream,
                                   akka.actor.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 akka.actor.Props props​(org.opendaylight.controller.cluster.io.InputOutputStreamFactory streamFactory)