org.opendaylight.controller.cluster.access.client.InternalCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation

Controller documentation

There is a newer version: 10.0.5

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.access.client;

import akka.dispatch.ControlMessage;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;

/**
 * This interface is used to pass the unit of work via the actors mailbox. The command can alter behavior of the actor
 * by returning a new behavior. This work will be prioritized before other messages.
 *
 * @author Robert Varga
 */
@FunctionalInterface
public interface InternalCommand extends ControlMessage {
    /**
     * Run command actions.
     *
     * @param currentBehavior Current Behavior
     * @return Next behavior to use in the client actor
     */
    @Nullable ClientActorBehavior execute(@NonNull ClientActorBehavior currentBehavior);
}