com.gh.bmd.jrt.channel.TransportChannel 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.gh.bmd.jrt.channel;

import com.gh.bmd.jrt.time.TimeDuration;

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

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Interface defining a transport channel.
 * 
 * A transport 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 close()
 * method must be called to correctly terminate the invocation lifecycle.
 * 

 * Created by davide-maestroni on 10/25/14.
 *
 * @param  the data type.
 */
public interface TransportChannel {

    /**
     * Returns the input end of this channel.
     *
     * @return the input channel.
     */
    @Nonnull
    TransportInput input();

    /**
     * Returns the output end of this channel.
     *
     * @return the output channel.
     */
    @Nonnull
    TransportOutput output();

    /**
     * Interface defining a transport channel input.
     *
     * @param  the input data type.
     */
    interface TransportInput extends InputChannel {

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput after(@Nonnull TimeDuration delay);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput after(long delay, @Nonnull TimeUnit timeUnit);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput now();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput pass(@Nullable OutputChannel channel);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput pass(@Nullable Iterable inputs);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput pass(@Nullable INPUT input);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportInput pass(@Nullable INPUT... inputs);

        /**
         * Closes the channel input.

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

    /**
     * Interface defining a transport channel output.
     *
     * @param  the output data type.
     */
    interface TransportOutput extends OutputChannel {

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput afterMax(@Nonnull TimeDuration timeout);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput afterMax(long timeout, @Nonnull TimeUnit timeUnit);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput bind(@Nonnull OutputConsumer consumer);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput eventually();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput eventuallyAbort();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput eventuallyDeadlock();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput eventuallyExit();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput immediately();

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput readAllInto(@Nonnull Collection results);

        /**
         * {@inheritDoc}
         */
        @Nonnull
        TransportOutput unbind(@Nullable OutputConsumer consumer);
    }
}