com.gh.bmd.jrt.core.DefaultExecution 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.core;

import com.gh.bmd.jrt.channel.RoutineException;
import com.gh.bmd.jrt.core.DefaultInvocationChannel.InvocationManager;
import com.gh.bmd.jrt.invocation.Invocation;
import com.gh.bmd.jrt.log.Logger;
import com.gh.bmd.jrt.runner.Execution;
import com.gh.bmd.jrt.runner.TemplateExecution;

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

/**
 * Default implementation of an execution object.
 * 
 * Created by davide-maestroni on 9/24/14.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
class DefaultExecution implements Execution {

    private final Object mAbortMutex = new Object();

    private final InputIterator mInputIterator;

    private final InvocationManager mInvocationManager;

    private final Logger mLogger;

    private final Object mMutex = new Object();

    private final DefaultResultChannel mResultChannel;

    private AbortExecution mAbortExecution;

    private Invocation mInvocation;

    /**
     * Constructor.
     *
     * @param manager the invocation manager.
     * @param inputs  the input iterator.
     * @param result  the result channel.
     * @param logger  the logger instance.
     */
    @SuppressWarnings("ConstantConditions")
    DefaultExecution(@Nonnull final InvocationManager manager,
            @Nonnull final InputIterator inputs,
            @Nonnull final DefaultResultChannel result, @Nonnull final Logger logger) {

        if (manager == null) {

            throw new NullPointerException("the invocation manager must not be null");
        }

        if (inputs == null) {

            throw new NullPointerException("the input iterator must not be null");
        }

        if (result == null) {

            throw new NullPointerException("the result channel must not be null");
        }

        mInvocationManager = manager;
        mInputIterator = inputs;
        mResultChannel = result;
        mLogger = logger.subContextLogger(this);
    }

    /**
     * Returns the abort execution.
     *
     * @return the execution.
     */
    @Nonnull
    public Execution abort() {

        synchronized (mAbortMutex) {

            if (mAbortExecution == null) {

                mAbortExecution = new AbortExecution();
            }

            return mAbortExecution;
        }
    }

    public boolean mayBeCanceled() {

        return true;
    }

    public void run() {

        synchronized (mMutex) {

            final InputIterator inputIterator = mInputIterator;
            final InvocationManager manager = mInvocationManager;
            final DefaultResultChannel resultChannel = mResultChannel;
            Invocation invocation = null;

            try {

                inputIterator.onConsumeStart();
                mLogger.dbg("running execution");
                final boolean isComplete;

                try {

                    invocation = initInvocation();

                    while (inputIterator.hasInput()) {

                        invocation.onInput(inputIterator.nextInput(), resultChannel);
                    }

                } finally {

                    isComplete = inputIterator.onConsumeComplete();
                }

                if (isComplete) {

                    invocation.onResult(resultChannel);

                    try {

                        invocation.onTerminate();
                        manager.recycle(invocation);

                    } catch (final Throwable ignored) {

                        manager.discard(invocation);

                    } finally {

                        resultChannel.close();
                        inputIterator.onInvocationComplete();
                    }
                }

            } catch (final Throwable t) {

                if (invocation != null) {

                    resultChannel.abortImmediately(t);

                } else {

                    if (mInvocation != null) {

                        manager.discard(mInvocation);
                    }

                    resultChannel.close(t);
                }
            }
        }
    }

    @Nonnull
    private Invocation initInvocation() {

        final Invocation invocation;

        if (mInvocation != null) {

            invocation = mInvocation;

        } else {

            invocation = (mInvocation = mInvocationManager.create());
            mLogger.dbg("initializing invocation: %s", invocation);
            invocation.onInitialize();
        }

        return invocation;
    }

    /**
     * Interface defining an iterator of input data.
     *
     * @param  the input data type.
     */
    interface InputIterator {

        /**
         * Returns the exception identifying the abortion reason.
         *
         * @return the reason of the abortion.
         */
        @Nullable
        RoutineException getAbortException();

        /**
         * Checks if an input is available.
         *
         * @return whether an input is available.
         */
        boolean hasInput();

        /**
         * Checks if the input channel is aborting the execution.
         *
         * @return whether the execution is aborting.
         */
        boolean isAborting();

        /**
         * Gets the next input.
         *
         * @return the input.
         * @throws java.util.NoSuchElementException if no more inputs are available.
         */
        @Nullable
        INPUT nextInput();

        /**
         * Notifies that the execution abortion is complete.
         */
        void onAbortComplete();

        /**
         * Checks if the input has completed, that is, all the inputs have been consumed.
         *
         * @return whether the input has completed.
         */
        boolean onConsumeComplete();

        /**
         * Notifies that the available inputs are about to be consumed.
         */
        void onConsumeStart();

        /**
         * Notifies that the invocation execution is complete.
         */
        void onInvocationComplete();
    }

    /**
     * Abort execution implementation.
     */
    private class AbortExecution extends TemplateExecution {

        public void run() {

            synchronized (mMutex) {

                final InputIterator inputIterator = mInputIterator;

                if (!inputIterator.isAborting()) {

                    mLogger.wrn("avoiding aborting since input is already aborted");
                    return;
                }

                final InvocationManager manager = mInvocationManager;
                final DefaultResultChannel resultChannel = mResultChannel;
                final RoutineException exception = inputIterator.getAbortException();
                mLogger.dbg(exception, "aborting invocation");

                try {

                    final Invocation invocation = initInvocation();
                    invocation.onAbort(exception);
                    invocation.onTerminate();
                    manager.recycle(invocation);
                    resultChannel.close(exception);

                } catch (final Throwable t) {

                    if (mInvocation != null) {

                        manager.discard(mInvocation);
                    }

                    resultChannel.close(t);

                } finally {

                    inputIterator.onAbortComplete();
                }
            }
        }
    }
}