ExecutorService.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

#ifndef _DECAF_UTIL_CONCURRENT_EXECUTORSERVICE_H_
#define _DECAF_UTIL_CONCURRENT_EXECUTORSERVICE_H_

#include <decaf/util/Config.h>

#include <decaf/lang/Runnable.h>
#include <decaf/util/ArrayList.h>
#include <decaf/util/concurrent/Future.h>
#include <decaf/util/concurrent/FutureTask.h>
#include <decaf/util/concurrent/Executor.h>
#include <decaf/util/concurrent/TimeUnit.h>
#include <decaf/lang/exceptions/InterruptedException.h>

namespace decaf {
namespace util {
namespace concurrent {

    class DECAF_API ExecutorService : public Executor {
    public:

        virtual ~ExecutorService() {}

        virtual bool awaitTermination(long long timeout, const TimeUnit& unit) = 0;

        virtual void shutdown() = 0;

        virtual ArrayList<decaf::lang::Runnable*> shutdownNow() = 0;

        virtual bool isShutdown() const = 0;

        virtual bool isTerminated() const = 0;

        template<typename E>
        Future<E>* submit(Callable<E>* task, bool takeOwnership = true) {

            // Creates a new FutureTask to wrap the target task, and then creates a clone
            // that will act as the proxy to return to the caller.
            Pointer< FutureTask<E> > newTask(new FutureTask<E>(task, takeOwnership));
            Pointer< FutureTask<E> > proxy(newTask->clone());

            try {
                // Its safe to submit and allow the task to be executed only after creating
                // the proxy so that if its run on the current thread and destroyed the
                // proxy still holds a vlid reference to the inner FutureTask data keeping it
                // from being destroyed before the caller has a chance to call get().
                this->doSubmit(newTask.get());

                // No exception so we can release our ref, the executor owns it now.
                newTask.release();

                return proxy.release();
            } catch(decaf::util::concurrent::RejectedExecutionException& ex) {
                // Policy will delete the submitted task
                newTask.release();
                ex.setMark(__FILE__, __LINE__);
                throw;
            }
            DECAF_CATCH_RETHROW(decaf::lang::exceptions::NullPointerException)
            DECAF_CATCHALL_THROW(decaf::lang::Exception)
        }

        template<typename E>
        Future<E>* submit(decaf::lang::Runnable* task, const E& result, bool takeOwnership = true) {

            // Creates a new FutureTask to wrap the target task, and then creates a clone
            // that will act as the proxy to return to the caller.
            Pointer< FutureTask<E> > newTask(new FutureTask<E>(task, result, takeOwnership));
            Pointer< FutureTask<E> > proxy(newTask->clone());

            try {
                // Its safe to submit and allow the task to be executed only after creating
                // the proxy so that if its run on the current thread and destroyed the
                // proxy still holds a vlid reference to the inner FutureTask data keeping it
                // from being destroyed before the caller has a chance to call get().
                this->doSubmit(newTask.get());

                // No exception so we can release our reference, the executor owns it now.
                newTask.release();

                return proxy.release();
            } catch(decaf::util::concurrent::RejectedExecutionException& ex) {
                // Policy will delete the submitted task
                newTask.release();
                ex.setMark(__FILE__, __LINE__);
                throw;
            }
            DECAF_CATCH_RETHROW(decaf::lang::exceptions::NullPointerException)
            DECAF_CATCHALL_THROW(decaf::lang::Exception)
        }

        template<typename E>
        Future<E>* submit(decaf::lang::Runnable* task, bool takeOwnership = true) {

            // Creates a new FutureTask to wrap the target task, and then creates a clone
            // that will act as the proxy to return to the caller.
            Pointer< FutureTask<E> > newTask(new FutureTask<E>(task, E(), takeOwnership));
            Pointer< FutureTask<E> > proxy(newTask->clone());

            try {
                // Its safe to submit and allow the task to be executed only after creating
                // the proxy so that if its run on the current thread and destroyed the
                // proxy still holds a vlid reference to the inner FutureTask data keeping it
                // from being destroyed before the caller has a chance to call get().
                this->doSubmit(newTask.get());

                // No exception so we can release our ref, the executor owns it now.
                newTask.release();

                return proxy.release();
            } catch(decaf::util::concurrent::RejectedExecutionException& ex) {
                // Policy will delete the submitted task
                newTask.release();
                ex.setMark(__FILE__, __LINE__);
                throw;
            }
            DECAF_CATCH_RETHROW(decaf::lang::exceptions::NullPointerException)
            DECAF_CATCHALL_THROW(decaf::lang::Exception)
        }

    protected:

        virtual void doSubmit(FutureType* future) = 0;

    };

}}}

#endif /* _DECAF_UTIL_CONCURRENT_EXECUTORSERVICE_H_ */