Home

C-Bits Package Documentation

Project Page

---

             

---

Thread.h

Go to the documentation of this file.

/* ====================================================================
 *              The CBITS Software License, Version 1.0
 *
 *               Copyright (c) 2002-2003 Bruce Lowery
 *                       All rights reserved
 *
 * Redistribution and use of this software, in source and binary forms, 
 * with or without modification, are permitted provided that the above 
 * copyright notice, this paragraph, and the following paragraph are 
 * retained in each source code file.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL BRUCE LOWERY OR OTHER CONTRIBUTORS 
 * TO THE CBITS LIBRARY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 */
#ifndef __THREAD_H__
#define __THREAD_H__

#include <cbits/Runnable.h>
#include <string>


#ifdef BUILD_DLL
#define EXPORT __declspec(dllexport)
#else
#define EXPORT
#endif


namespace cbits 
{

class EXPORT Thread
{

public:

    enum State
    {
        READY = 1,
        ALIVE = 2,
        DEAD  = 3
    };


    enum Priority
    {
        PRIORITY_1       = 1,
        PRIORITY_2       = 2,
        PRIORITY_3       = 3,
        PRIORITY_4       = 4,
        PRIORITY_5       = 5,
        PRIORITY_6       = 6,
        PRIORITY_7       = 7,
        PRIORITY_8       = 8,
        PRIORITY_9       = 9,
        MIN_PRIORITY     = PRIORITY_1,
        DEFAULT_PRIORITY = PRIORITY_5,
        MAX_PRIORITY     = PRIORITY_9
    };


    static Thread* create
    ( 
        Runnable* r,
        const Priority p = DEFAULT_PRIORITY 
    );


    static Thread* getCurrent();


    static void    yield();


    void start();


    const long getThreadID() const;


    void interrupt();


    static const bool isInterrupted();


    const bool join
    (
        const long msec=0
    );


    const State getState
    (
        const bool lockit = true
            /*
             * true if object should be locked 
             * while reading state.
             */
     ) const;


    void  setData
    ( 
        void* 
    ) const;


    void* getData() const;


    static void sleep
    ( 
        const long msec 
    );

    virtual ~Thread();


protected:

    Thread
    ( 
        Priority p = DEFAULT_PRIORITY 
    );


    Thread
    ( 
        Runnable* r, 

        Priority p = DEFAULT_PRIORITY 
    );


    Runnable* getTarget() const { return _target; }


    const State setState
    ( 
        State, 

        const bool lockit = true
    );


    void setError
    (
        const char* e
    ) const 
    { 
        _error = e; 
    }


    const std::string& getError() const 
    { 
        return _error;
    }


    const Priority getPriority() const 
    { 
        return _priority; 
    }


    virtual const bool impl_create_thread
    ( 
        const Priority 
    )  = 0;


    virtual const bool impl_start_thread() = 0;


    virtual const long impl_get_threadid() const = 0;


    virtual void impl_lock_obj() const = 0;


    virtual void impl_unlock_obj() const = 0;


    virtual void impl_interrupt() = 0;


    virtual const bool impl_join( const long msec ) = 0;


    virtual void impl_sleep( const long msec ) = 0;


private:

    mutable std::string  _error;

    Runnable* _target;

    Priority  _priority;

    State _state;

    mutable void*  _data;

    mutable bool _interrupted;
};

};

#endif

/*
 * $Id: Thread.h,v 1.10 2002/10/09 22:43:03 brulow Exp $
 *
 * History: (Add nothing manually below)
 * -----------------------------------------------------------------------
 *
 * $Log: Thread.h,v $
 * Revision 1.10  2002/10/09 22:43:03  brulow
 * Improve documentation
 *
 * Revision 1.9  2002/10/09 02:02:26  brulow
 * Improve package documentation
 *
 * Revision 1.8  2002/10/07 21:07:44  brulow
 * Add/improve documentation
 *
 * Revision 1.7  2002/10/06 04:13:01  brulow
 * Add unit thread pkg unit tests and fix thread pkg bugs.
 *
 * Revision 1.6  2002/10/05 15:48:50  brulow
 * Add 'sleep' to Thread interface;
 * Add synchronization between creator and new thread.
 *
 * Revision 1.5  2002/10/05 03:38:37  brulow
 * Fix bug in Thread package and unit test
 *
 * Revision 1.4  2002/10/04 23:51:14  brulow
 * Fix bug in property package unit test 7
 *
 * Revision 1.3  2002/10/04 03:02:17  brulow
 * Fix 'undefined virtual table' problem in ResourceLock_XX classes
 *
 * Revision 1.2  2002/10/03 15:09:23  brulow
 * Add footer
 *
 *
 */

---

Generated by

Hosted by