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
  13 /**
  14  * Marker interface for data which is able to be held in a {@link Bucket}.
  15  *
  16  * @author Robert Varga
  17  *
  18  * @param <T> Concrete BucketData type
  19  */
  20 public interface BucketData<T extends BucketData<T>> extends Copier<T> {
  21     /**
  22      * Return the {@link ActorRef} which should be tracked as the authoritative source of this bucket's data.
  23      * The bucket will be invalidated should the actor be reported as Terminated.
  24      *
  25      * @return Optional ActorRef.
  26      */
  27     Optional<ActorRef> getWatchActor();
  28 }