thread.h

This software aims to create an applet and panel tools to manage a wireless interface card, such as

//
// Thread.h
//
// $Id: //poco/Main/Foundation/include/Foundation/Thread.h#5 $
//
// Definition of the Thread class.
//
// Copyright (c) 2004, Guenter Obiltschnig/Applied Informatics.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Redistributions in any form must be accompanied by information on
//    how to obtain complete source code for this software and any
//    accompanying software that uses this software.  The source code
//    must either be included in the distribution or be available for no
//    more than the cost of distribution plus a nominal fee, and must be
//    freely redistributable under reasonable conditions.  For an
//    executable file, complete source code means the source code for all
//    modules it contains.  It does not include source code for modules or
//    files that typically accompany the major components of the operating
//    system on which the executable file runs.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS 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 THE
// COPYRIGHT OWNER OR CONTRIBUTORS 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 Foundation_Thread_INCLUDED
#define Foundation_Thread_INCLUDED


#ifndef Foundation_Foundation_INCLUDED
#include "Foundation/Foundation.h"
#endif


#if defined(POCO_OS_FAMILY_WINDOWS)
#include "Foundation/Thread_WIN32.h"
#else
#include "Foundation/Thread_POSIX.h"
#endif


Foundation_BEGIN


class Runnable;
class ThreadLocalStorage;


class Foundation_API Thread: private ThreadImp
	/// This class implements a platform-independent
	/// wrapper to an operating system thread.
{
public:	
	enum Priority
		/// Thread priorities.
	{
		PRIO_LOWEST  = PRIO_LOWEST_IMP, /// The lowest thread priority.
		PRIO_LOW     = PRIO_LOW_IMP,    /// A lower than normal thread priority.
		PRIO_NORMAL  = PRIO_NORMAL_IMP, /// The normal thread priority.
		PRIO_HIGH    = PRIO_HIGH_IMP,   /// A higher than normal thread priority.
		PRIO_HIGHEST = PRIO_HIGHEST_IMP /// The highest thread priority.
	};

	Thread();
		/// Creates a thread. Call start() to start it.
		
	Thread(const std::string& name);
		/// Creates a named thread. Call start() to start it.
		
	~Thread();
		/// Destroys the thread.

	const std::string& name() const;
		/// Returns the name of the thread.

	void setPriority(Priority prio);
		/// Sets the thread's priority.

	Priority getPriority() const;
		/// Returns the thread's priority.

	void start(Runnable& target);
		/// Starts the thread with the given target.

	void join();
		/// Waits until the thread completes execution.	
		/// If multiple threads try to join the same
		/// thread, the result is undefined.

	bool isRunning() const;
		/// Returns true if the thread is running.

	static void sleep(long milliseconds);
		/// Suspends the current thread for the specified
		/// amount of time.

	static void yield();
		/// Yields cpu to other threads.

	static Thread* current();
		/// Returns the Thread object for the currently active thread.
		/// If the current thread is the main thread, 0 is returned.

protected:
	ThreadLocalStorage& tls();
		/// Returns a reference to the thread's local storage.

	void clearTLS();
		/// Clears the thread's local storage.

	static std::string uniqueName();
		/// Creates a unique name for a thread.

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

	std::string         _name;
	ThreadLocalStorage* _pTLS;

	friend class ThreadLocalStorage;
};


//
// inlines
//
inline const std::string& Thread::name() const
{
	return _name;
}


inline bool Thread::isRunning() const
{
	return isRunningImp();
}


inline void Thread::sleep(long milliseconds)
{
	sleepImp(milliseconds);
}


inline void Thread::yield()
{
	yieldImp();
}


inline Thread* Thread::current()
{
	return static_cast<Thread*>(currentImp());
}


Foundation_END


#endif // Foundation_Thread_INCLUDED