io.engineblock.activityapi.output.Output 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.output;

import io.engineblock.activityapi.cyclelog.buffers.results.CycleResult;
import io.engineblock.activityapi.cyclelog.buffers.results.CycleResultsSegment;

/**
 * A cycle marker is simply a type that knows how to do something
 * useful with the result of a particular cycle.
 * Outputs are required to be thread-safe.
 */
public interface Output extends AutoCloseable {

    /**
     * Mark the result of the numbered cycle with an integer value.
     * The meaning of the value provided is contextual to the way it is used.
     * (Each process will have its own status tables, etc.)
     *
     * @param completedCycle The cycle number being marked.
     * @param result the result ordinal
     * @return true on success, false if the marking should be retried differently
     */
    boolean onCycleResult(long completedCycle, int result);

    default boolean onCycleResult(CycleResult result) {
        return this.onCycleResult(result.getCycle(),result.getResult());
    }

    default void onCycleResultSegment(CycleResultsSegment segment) {
        segment.forEach(s -> onCycleResult(s.getCycle(),s.getResult()));
    }

    default void close() throws Exception {
    }
}