src/main/decaf/lang/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 util{
namespace concurrent{
namespace locks{
    class LockSupport;
}}}
namespace lang{

    class Runtime;
    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 ) throw() = 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 );

        virtual ~Thread();

        virtual void start();

        virtual void join();

        virtual void join( long long millisecs );

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

        virtual void run();

        std::string getName() const;

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

        int getPriority() const;

        void setPriority( int value );

        void setDaemon(bool value);

        bool isDaemon() const;

        const UncaughtExceptionHandler* getUncaughtExceptionHandler() const;

        void setUncaughtExceptionHandler( UncaughtExceptionHandler* handler );

        std::string toString() const;

        bool isAlive() const;

        Thread::State getState() const;

    public:

        static void sleep( long long millisecs );

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

        static void yield();

        static long long getId();

        static Thread* currentThread();

    private:

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

        // Create a Thread Facade for threads not created by the Decaf Library.
        static Thread* createForeignThreadInstance( const std::string& name );

        // Called by the Decaf Runtime at startup to allow the Platform Threading
        // code to initialize any necessary Threading constructs needed to support
        // the features of this class.
        static void initThreading();

        // Called by the Decf Runtime at Shutdown to allow the Platform Threading
        // code to return any resources that were allocated at startup for the
        // Threading library.
        static void shutdownThreading();

        // Called from LockSupport to Park a Thread (suspend it from execution)
        static void park( Thread* thread );

        // Called from LockSupport to Park a Thread (suspend it from execution)
        static void park( Thread* thread, long long mills, long long nanos );

        // Called from LockSupport to UnPark a Thread (resume its execution status).
        static void unpark( Thread* thread );

        // Allow some Decaf Classes greater access to the Threading model.
        friend class decaf::util::concurrent::locks::LockSupport;
        friend class decaf::lang::Runtime;

    };

}}

#endif /*_DECAF_LANG_THREAD_H_*/