opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/InternalCommand.java

   1 /*
   2  * Copyright (c) 2016 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.cluster.access.client;
   9
  10 import akka.dispatch.ControlMessage;
  11 import javax.annotation.Nonnull;
  12 import javax.annotation.Nullable;
  13
  14 /**
  15  * This interface is used to pass the unit of work via the actors mailbox. The command can alter behavior of the actor
  16  * by returning a new behavior. This work will be prioritized before other messages.
  17  *
  18  * @author Robert Varga
  19  */
  20 @FunctionalInterface
  21 public interface InternalCommand<T extends BackendInfo> extends ControlMessage {
  22     /**
  23      * Run command actions.
  24      *
  25      * @param currentBehavior Current Behavior
  26      * @return Next behavior to use in the client actor
  27      */
  28     @Nullable ClientActorBehavior<T> execute(@Nonnull ClientActorBehavior<T> currentBehavior);
  29 }