io.engineblock.activityapi.core.Action Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eb-api Show documentation

The driver API for engineblock; Provides the interfaces needed to build drivers that can be loaded by engineblock core

There is a newer version: 2.12.65

/*
 *
 *    Copyright 2016 jshook
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 * /
 */
package io.engineblock.activityapi.core;

/**
 * An action is the core logic that occurs within an activity.
 * Within a thread slot, a motor will continuously ask an action to process its input.
 */
@FunctionalInterface
public interface Action {

    /**
     * Apply a work function to an input value, producing an int status code.
     * The meaning of status codes is activity specific, however the values Integer.MIN_VALUE,
     * and Integer.MAX_VALUE are reserved.
     *
     * @param value a long input
     * @return an int status
     */
    int runCycle(long value);

    default void init() {
    }
}