104 lines
1.9 KiB
C++
104 lines
1.9 KiB
C++
/*
|
|
* Modification History
|
|
*
|
|
* 2002-April-4 Jason Rohrer
|
|
* Created.
|
|
* Changed to reflect the fact that the base class
|
|
* destructor is called *after* the derived class destructor.
|
|
*
|
|
* 2003-September-5 Jason Rohrer
|
|
* Moved into minorGems.
|
|
*
|
|
* 2004-November-19 Jason Rohrer
|
|
* Changed to virtual inheritance from Thread class.
|
|
*
|
|
* 2005-January-9 Jason Rohrer
|
|
* Changed to sleep on a semaphore to make sleep interruptable by stop.
|
|
*/
|
|
|
|
|
|
|
|
#ifndef STOP_SIGNAL_THREAD_INCLUDED
|
|
#define STOP_SIGNAL_THREAD_INCLUDED
|
|
|
|
|
|
|
|
#include "minorGems/system/Thread.h"
|
|
#include "minorGems/system/MutexLock.h"
|
|
#include "minorGems/system/BinarySemaphore.h"
|
|
|
|
|
|
|
|
/**
|
|
* Abstract subclass of thread that has a stop signal.
|
|
*
|
|
* Note that subclasses MUST check the isStopped() function
|
|
* periodically in their run() function for this class to work
|
|
* properly.
|
|
*
|
|
* @author Jason Rohrer
|
|
*/
|
|
class StopSignalThread : public virtual Thread {
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
* Only destroys this thread.
|
|
* Does not stop or join.
|
|
*/
|
|
virtual ~StopSignalThread();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
StopSignalThread();
|
|
|
|
|
|
|
|
// overrides Thread::sleep to make it interruptable by our stop call
|
|
virtual void sleep( unsigned long inTimeInMilliseconds );
|
|
|
|
|
|
|
|
/**
|
|
* Signals this thread to stop, interrupting it if it is sleeping.
|
|
*
|
|
* Thread safe.
|
|
*
|
|
* Thread must be joined after this call returns.
|
|
*/
|
|
void stop();
|
|
|
|
|
|
|
|
/**
|
|
* Gets whether this thread has been signaled to stop.
|
|
*
|
|
* Thread safe.
|
|
*
|
|
* @return true if this thread should stop.
|
|
*/
|
|
char isStopped();
|
|
|
|
|
|
|
|
private:
|
|
|
|
MutexLock *mStopLock;
|
|
char mStopped;
|
|
|
|
BinarySemaphore *mSleepSemaphore;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|