Thread.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_LANG_THREAD_H_
#define _DECAF_LANG_THREAD_H_

#include <decaf/lang/exceptions/IllegalThreadStateException.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>
#include <decaf/lang/exceptions/InterruptedException.h>
#include <decaf/lang/exceptions/RuntimeException.h>
#include <decaf/lang/Exception.h>
#include <decaf/lang/Runnable.h>
#include <decaf/util/Config.h>

namespace decaf {
namespace internal {
namespace util {
namespace concurrent {
    class Threading;
    struct ThreadHandle;
}}}
namespace lang {

    class ThreadGroup;
    class ThreadProperties;

    class DECAF_API Thread : public Runnable {
    private:

        ThreadProperties* properties;

    public:

        static const int MIN_PRIORITY = 1;

        static const int NORM_PRIORITY = 5;

        static const int MAX_PRIORITY = 10;

        enum State {

            NEW = 0,

            RUNNABLE = 1,

            BLOCKED = 2,

            WAITING = 3,

            TIMED_WAITING = 4,

            SLEEPING = 5,

            TERMINATED = 6

        };

    public:

        class UncaughtExceptionHandler {
        public:

            virtual ~UncaughtExceptionHandler() {}

            virtual void uncaughtException(const Thread* thread, const Throwable& error) = 0;

        };

    private:

        Thread(const Thread&);
        Thread& operator=(const Thread&);

    public:

        Thread();

        Thread(Runnable* task);

        Thread(const std::string& name);

        Thread(Runnable* task, const std::string& name);

        Thread(Runnable* task, const std::string& name, long long stackSize);

        virtual ~Thread();

        virtual void start();

        virtual void join();

        virtual void join(long long millisecs);

        virtual void join(long long millisecs, int nanos);

        virtual void run();

        long long getId() const;

        std::string getName() const;

        void setName(const std::string& name);

        int getPriority() const;

        void setPriority(int value);

        UncaughtExceptionHandler* getUncaughtExceptionHandler() const;

        void setUncaughtExceptionHandler(UncaughtExceptionHandler* handler);

        std::string toString() const;

        bool isAlive() const;

        Thread::State getState() const;

        void interrupt();

        bool isInterrupted() const;

    public:

        static void sleep(long long millisecs);

        static void sleep(long long millisecs, int nanos);

        static void yield();

        static Thread* currentThread();

        static bool interrupted();

        static UncaughtExceptionHandler* getDefaultUncaughtExceptionHandler();

        static void setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler* handler);

    private:

        // Initialize the Threads internal state
        void initializeSelf(Runnable* task, const std::string& name, long long stackSize);

        // Creates a Thread instance for a ThreadProperties pointer, used for
        // wrapping OS threads
        Thread(decaf::internal::util::concurrent::ThreadHandle* osThread);

    private:

        // Allows the Threading class to get this thread objects handle.
        decaf::internal::util::concurrent::ThreadHandle* getHandle() const;

        // Allow some Decaf Classes greater access to the Thread class.
        friend class decaf::internal::util::concurrent::Threading;
        friend class ThreadGroup;

    };

}}

#endif /*_DECAF_LANG_THREAD_H_*/