opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/BucketData.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.remote.rpc.registry.gossip;
   9
  10 import akka.actor.ActorRef;
  11 import java.util.Optional;
  12 import org.opendaylight.yangtools.concepts.Immutable;
  13
  14 /**
  15  * Marker interface for data which is able to be held in a {@link Bucket}.
  16  *
  17  * @author Robert Varga
  18  *
  19  * @param <T> Concrete BucketData type
  20  */
  21 public interface BucketData<T extends BucketData<T>> extends Immutable {
  22     /**
  23      * Return the {@link ActorRef} which should be tracked as the authoritative source of this bucket's data.
  24      * The bucket will be invalidated should the actor be reported as Terminated.
  25      *
  26      * @return Optional ActorRef.
  27      */
  28     Optional<ActorRef> getWatchActor();
  29 }