io.engineblock.activityapi.input.Input 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.input;

import io.engineblock.activityapi.cycletracking.buffers.cycles.CycleSegment;

/**
 * The core input type, which is essentially an iterator pattern
 * over segment iterators. Input should not implement this interface
 * directly, but should implement one of either {@link SegmentedInput}
 * or {@link ContiguousInput}, but not both.
 */
public interface Input {

    /**
     * Return the next InputSegment available, or null if
     * none were available. This method is required to be thread safe.
     * All implementations of this method are required to be thread-safe.
     * @param segmentLength The number of cycles (not necessarily contiguous) in the segment.
     * @return a segment, or null if none available.
     */
    CycleSegment getInputSegment(int segmentLength);
}