com.github.dm.jrt.channel.IOChannel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation
Parallel programming on the go
There is a newer version: 5.9.0
/*
 * 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 com.github.dm.jrt.channel;

import com.github.dm.jrt.util.TimeDuration;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.concurrent.TimeUnit;

/**
 * Interface defining a channel which is both an input and an output.
 * 
 * An I/O channel is useful to make other asynchronous tasks communicate with a routine.

 * The channel output can be passed to a routine input channel in order to feed it with data coming
 * asynchronously from other sources. Note however that, in any case, the {@code close()} method
 * must be called in order to correctly terminate the invocation lifecycle.
 * 

 * Created by davide-maestroni on 09/24/2015.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public interface IOChannel extends InputChannel, OutputChannel {

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel after(@NotNull TimeDuration delay);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel after(long delay, @NotNull TimeUnit timeUnit);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel now();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel orderByCall();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel orderByChance();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel orderByDelay();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel pass(@Nullable OutputChannel channel);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel pass(@Nullable Iterable inputs);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel pass(@Nullable IN input);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel pass(@Nullable IN... inputs);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel afterMax(@NotNull TimeDuration timeout);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel afterMax(long timeout, @NotNull TimeUnit timeUnit);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel allInto(@NotNull Collection results);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel eventuallyAbort();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel eventuallyExit();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel eventuallyThrow();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel immediately();

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel passTo(@NotNull OutputConsumer consumer);

    /**
     * {@inheritDoc}
     */
    @NotNull
    IOChannel skip(int count);

    /**
     * Returns this channel as an input one.
     *
     * @return this channel.
     */
    @NotNull
    InputChannel asInput();

    /**
     * Returns this channel as an output one.
     *
     * @return this channel.
     */
    @NotNull
    OutputChannel asOutput();

    /**
     * Closes the channel input.

     * If the channel is already closed, this method has no effect.
     * 
     * Note that this method must be always called when done with the channel.
     *
     * @return this channel.
     */
    @NotNull
    IOChannel close();
}