Thread Class Reference

Thread is a wrapper around boost::thread which allows for the thread object to be created before it is actually started. More...

#include <Thread.h>

Inheritance diagram for Thread:

List of all members.

Public Member Functions
	Thread (std::string const &description="anonymous thread")
virtual	~Thread ()
virtual void	start ()
	Spawns the OS thread.
void	join ()
	Waits for the OS thread to terminate.
bool	isStarted () const
	Returns: true if start has been called (and subsequent join has not completed)
bool	isStopped () const
	Returns: opposite of isStarted()
boost::thread &	getBoostThread ()
	Accesses the underlying boost::thread, e.g.
std::string	getName ()
void	setName (std::string const &s)
Protected Member Functions
void	initAndRun ()
virtual void	run ()=0
virtual void	beforeRun ()
virtual void	afterRun ()
Protected Attributes
boost::thread *	pBoostThread
bool	bRunning
std::string	name

---

Detailed Description

Thread is a wrapper around boost::thread which allows for the thread object to be created before it is actually started.

Definition at line 41 of file Thread.h.

---

Constructor & Destructor Documentation

Thread::Thread

(

std::string const &

description = "anonymous thread"

)

[explicit]

Definition at line 36 of file Thread.cpp.

References bRunning, name, and pBoostThread.

{
    // TODO:  do something with description
    name = desc;
    pBoostThread = NULL;
    bRunning = false;
}

Thread::~Thread

(

)

[virtual]

Definition at line 44 of file Thread.cpp.

References bRunning, and pBoostThread.

{
    assert(!bRunning);
    assert(!pBoostThread);
}

---

Member Function Documentation

void Thread::initAndRun

(

)

[protected]

Definition at line 66 of file Thread.cpp.

References afterRun(), beforeRun(), and run().

Referenced by start().

{
    beforeRun();
    run();
    afterRun();
}

virtual void Thread::run

(

)

[protected, pure virtual]

Implemented in CheckpointThread, AioLinuxScheduler, AioPollingScheduler, AioSignalHandlerThread, IoCompletionPortThread, PooledThread, TimerThread, TestThread, and ResourceThread.

Referenced by initAndRun().

void Thread::beforeRun

(

)

[protected, virtual]

Definition at line 73 of file Thread.cpp.

References bRunning.

Referenced by initAndRun().

{
    bRunning = true;
}

void Thread::afterRun

(

)

[protected, virtual]

Definition at line 78 of file Thread.cpp.

References bRunning.

Referenced by initAndRun().

{
    bRunning = false;
}

void Thread::start

(

)

[virtual]

Spawns the OS thread.

Definition at line 50 of file Thread.cpp.

References initAndRun(), and pBoostThread.

Referenced by AioLinuxScheduler::AioLinuxScheduler(), AioPollingScheduler::AioPollingScheduler(), StatsTimer::start(), ResourceTest::testConcurrency(), and LocalConditionTest::testNotifyAll().

{
    pBoostThread = new boost::thread(
        boost::bind(&Thread::initAndRun,this));
}

void Thread::join

(

)

Waits for the OS thread to terminate.

Definition at line 56 of file Thread.cpp.

References pBoostThread.

Referenced by CheckpointThread::closeImpl(), TimerThread::stop(), AioPollingScheduler::stop(), AioLinuxScheduler::stop(), ResourceTest::testConcurrency(), and LocalConditionTest::testNotifyAll().

{
    assert(pBoostThread);
    boost::thread t;
    assert(*pBoostThread != t);
    pBoostThread->join();
    delete pBoostThread;
    pBoostThread = NULL;
}

bool Thread::isStarted

(

)

const [inline]

Returns:

true if start has been called (and subsequent join has not completed)

Reimplemented in AioLinuxScheduler.

Definition at line 71 of file Thread.h.

Referenced by CheckpointThread::closeImpl(), CacheImpl< PageT, VictimPolicyT >::closeImpl(), AioLinuxScheduler::isStarted(), and TimerThread::stop().

    {
        return pBoostThread ? true : false;
    }

bool Thread::isStopped

(

)

const [inline]

Returns:

opposite of isStarted()

Definition at line 79 of file Thread.h.

    {
        return !isStarted();
    }

boost::thread& Thread::getBoostThread

(

)

[inline]

Accesses the underlying boost::thread, e.g.

for use in a boost::thread_group. This thread must already be started.

Returns:

the underlying boost::thread

Definition at line 90 of file Thread.h.

    {
        assert(isStarted());
        return *pBoostThread;
    }

std::string Thread::getName

(

)

[inline]

Definition at line 96 of file Thread.h.

    {
        return name;
    }

void Thread::setName

(

std::string const &

s

)

[inline]

Definition at line 101 of file Thread.h.

    {
        name = s;
    }

---

Member Data Documentation

boost::thread* Thread::pBoostThread [protected]

Definition at line 44 of file Thread.h.

Referenced by join(), start(), Thread(), and ~Thread().

bool Thread::bRunning [protected]

Definition at line 45 of file Thread.h.

Referenced by afterRun(), beforeRun(), Thread(), and ~Thread().

std::string Thread::name [protected]

Definition at line 46 of file Thread.h.

Referenced by Thread().

---

The documentation for this class was generated from the following files:

• /home/pub/open/dev/fennel/synch/Thread.h
• /home/pub/open/dev/fennel/synch/Thread.cpp

---