IBR-DTNSuite  0.12
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ibrcommon::Thread Class Referenceabstract

#include <Thread.h>

Inheritance diagram for ibrcommon::Thread:
Inheritance graph
Collaboration diagram for ibrcommon::Thread:
Collaboration graph

Public Member Functions

virtual ~Thread ()=0
 
void reset () throw (ThreadException)
 
virtual void setup (void) throw ()
 
virtual void run (void)=0 throw ()
 
virtual void finally (void) throw ()
 
bool isFinalized () throw ()
 
bool operator== (const ibrcommon::Thread &other)
 

Static Public Member Functions

static size_t getNumberOfProcessors ()
 
static void yield (void)
 
static void sleep (time_t timeout)
 
static void concurrency (int level)
 

Protected Types

enum  THREAD_STATE {
  THREAD_CREATED = 1 << 0, THREAD_STARTED = 1 << 1, THREAD_INITIALIZED = 1 << 2, THREAD_RUNNING = 1 << 3,
  THREAD_CANCELLED = 1 << 4, THREAD_FINALIZING = 1 << 5, THREAD_JOINABLE = 1 << 6, THREAD_FINALIZED = 1 << 7
}
 

Protected Member Functions

 Thread (size_t stack=DEFAULT_STACKSIZE)
 
int kill (int sig)
 
void cancel () throw ()
 
virtual void __cancellation ()=0 throw ()
 

Static Protected Member Functions

static bool equal (pthread_t thread1, pthread_t thread2)
 
static void * __execute__ (void *obj) throw ()
 

Protected Attributes

ibrcommon::ThreadsafeState
< THREAD_STATE > 		_state
 
pthread_t tid
 
size_t stack
 
int priority
 
pthread_attr_t attr
 
bool _detached
 

Detailed Description

An abstract class for defining classes that operate as a thread. A derived thread class has a run method that is invoked with the newly created thread context, and can use the derived object to store all member data that needs to be associated with that context. This means the derived object can safely hold thread-specific data that is managed with the life of the object, rather than having to use the clumsy thread-specific data management and access functions found in thread support libraries.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 56 of file Thread.h.

Member Enumeration Documentation

enum ibrcommon::Thread::THREAD_STATE
protected
Enumerator
THREAD_CREATED 
THREAD_STARTED 
THREAD_INITIALIZED 
THREAD_RUNNING 
THREAD_CANCELLED 
THREAD_FINALIZING 
THREAD_JOINABLE 
THREAD_FINALIZED 

Definition at line 59 of file Thread.h.

Constructor & Destructor Documentation

ibrcommon::Thread::Thread ( size_t  stack = DEFAULT_STACKSIZE)
protected

Create a thread object that will have a preset stack size. If 0 is used, then the stack size is os defined/default.

Parameters
stacksize to use or 0 for default.

Definition at line 106 of file Thread.cpp.

ibrcommon::Thread::~Thread ( )
pure virtual

Destroy thread object, thread-specific data, and execution context.

Definition at line 151 of file Thread.cpp.

References attr.

Member Function Documentation

virtual void ibrcommon::Thread::__cancellation ( )
throw (
)
protectedpure virtual

Implemented in ibrcommon::LogWriter, dtn::daemon::NativeEventLoop, dtn::storage::SQLiteBundleStorage, dtn::dht::DHTNameService, dtn::net::EMailSmtpService, dtn::storage::DataStorage, dtn::net::TCPConnection, dtn::net::TCPConvergenceLayer, dtn::net::DownloadThread, dtn::routing::ProphetRoutingExtension, dtn::api::ClientHandler, dtn::net::DatagramConvergenceLayer, dtn::net::LOWPANConvergenceLayer, dtn::daemon::IndependentComponent, dtn::net::HTTPConvergenceLayer, ibrcommon::Timer, dtn::net::UDPConvergenceLayer, dtn::net::LOWPANConnection, dtn::api::ApiServer, dtn::net::IPNDAgent, dtn::core::FragmentManager, dtn::net::FileMonitor, dtn::routing::EpidemicRoutingExtension, dtn::net::DatagramConnection, dtn::routing::StaticRoutingExtension, ibrcommon::NetLinkManager, dtn::routing::FloodRoutingExtension, dtn::net::FileConvergenceLayer, dtn::routing::NeighborRoutingExtension, ibrcommon::SignalHandler, dtn::net::EMailImapService, ibrcommon::LinkMonitor, dtn::net::WifiP2PManager, and dtn::net::LOWPANConnectionSender.

Referenced by cancel().

void * ibrcommon::Thread::__execute__ ( void *  obj)
throw (
)
staticprotected

static execute thread method

Definition at line 72 of file Thread.cpp.

References _detached, _state, finally(), and run().

Referenced by ibrcommon::JoinableThread::start(), and ibrcommon::DetachedThread::start().

Here is the call graph for this function:

void ibrcommon::Thread::cancel ( )
throw (
)
protected

Cancel the running thread context.

Definition at line 181 of file Thread.cpp.

References __cancellation(), _state, ibrcommon::ThreadsafeState< T >::lock(), THREAD_CANCELLED, THREAD_CREATED, THREAD_FINALIZED, THREAD_FINALIZING, THREAD_JOINABLE, THREAD_RUNNING, and ibrcommon::ThreadsafeState< T >::Locked::wait().

Referenced by ibrcommon::JoinableThread::stop(), and ibrcommon::DetachedThread::stop().

Here is the call graph for this function:

void ibrcommon::Thread::concurrency ( int  level)
static

Set concurrency level of process. This is essentially a portable wrapper for pthread_setconcurrency.

Definition at line 127 of file Thread.cpp.

bool ibrcommon::Thread::equal ( pthread_t  thread1,
pthread_t  thread2 
)
staticprotected

Determine if two thread identifiers refer to the same thread.

Parameters
thread1to test.
thread2to test.
Returns
true if both are the same context.

Definition at line 210 of file Thread.cpp.

Referenced by ibrcommon::JoinableThread::join(), and operator==().

virtual void ibrcommon::Thread::finally ( void  )
throw (
)
inlinevirtual

This method is called when the run() method finishes.

Reimplemented in dtn::net::TCPConnection, dtn::api::ClientHandler, dtn::net::LOWPANConnection, and dtn::net::DatagramConnection.

Definition at line 133 of file Thread.h.

Referenced by __execute__().

size_t ibrcommon::Thread::getNumberOfProcessors ( )
static

Definition at line 47 of file Thread.cpp.

Referenced by dtn::daemon::Configuration::params().

bool ibrcommon::Thread::isFinalized ( )
throw (
)

Returns true if this thread was started and finalized before.

Definition at line 215 of file Thread.cpp.

References _state, and THREAD_FINALIZED.

int ibrcommon::Thread::kill ( int  sig)
protected

sends a signal to this thread

Parameters
sig
Returns

Definition at line 174 of file Thread.cpp.

References tid.

bool ibrcommon::Thread::operator== ( const ibrcommon::Thread &  other)
inline

Determine if two thread identifiers refer to the same thread.

Parameters
otherThe thread to compare.
Returns
True, if both threads are the same.

Definition at line 151 of file Thread.h.

References equal(), and tid.

Here is the call graph for this function:

void ibrcommon::Thread::reset ( )
throw (ThreadException
)

Reset this thread to initial state

Definition at line 156 of file Thread.cpp.

References _detached, _state, attr, ibrcommon::ThreadsafeState< T >::reset(), THREAD_CREATED, THREAD_FINALIZED, and tid.

Here is the call graph for this function:

virtual void ibrcommon::Thread::run ( void  )
throw (
)
pure virtual

Abstract interface for thread context run method.

Implemented in ibrcommon::LogWriter, dtn::daemon::NativeEventLoop, dtn::net::EMailSmtpService, dtn::storage::DataStorage, dtn::net::TCPConnection, dtn::net::DownloadThread, dtn::routing::ProphetRoutingExtension, dtn::api::ClientHandler, ibrcommon::Timer, dtn::daemon::IndependentComponent, dtn::net::LOWPANConnection, dtn::routing::EpidemicRoutingExtension, dtn::net::DatagramConnection, dtn::routing::StaticRoutingExtension, ibrcommon::NetLinkManager, dtn::routing::FloodRoutingExtension, dtn::routing::NeighborRoutingExtension, ibrcommon::LinkMonitor, ibrcommon::SignalHandler, dtn::net::EMailImapService, and dtn::net::LOWPANConnectionSender.

Referenced by __execute__().

virtual void ibrcommon::Thread::setup ( void  )
throw (
)
inlinevirtual

This method is called before the run.

Reimplemented in dtn::net::TCPConnection, dtn::api::ClientHandler, dtn::net::LOWPANConnection, and dtn::net::DatagramConnection.

Definition at line 123 of file Thread.h.

void ibrcommon::Thread::sleep ( time_t  timeout)
static

Sleep current thread for a specified time period.

Parameters
timeoutto sleep for in milliseconds.

Definition at line 134 of file Thread.cpp.

Referenced by dtn::api::ApiServer::componentDown(), dtn::net::WifiP2PManager::componentRun(), dtn::net::FileMonitor::componentRun(), dtn::net::HTTPConvergenceLayer::componentRun(), dtn::dht::DHTNameService::componentRun(), dtn::net::WifiP2PManager::connectionEstablished(), main(), and ibrcommon::LinkManager::raiseEvent().

void ibrcommon::Thread::yield ( void  )
static

Yield execution context of the current thread. This is a static and may be used anywhere.

Definition at line 116 of file Thread.cpp.

Referenced by dtn::net::IPNDAgent::componentRun(), dtn::net::UDPConvergenceLayer::componentRun(), dtn::api::ApiServer::componentRun(), dtn::net::HTTPConvergenceLayer::componentRun(), dtn::net::LOWPANConvergenceLayer::componentRun(), dtn::net::DatagramConvergenceLayer::componentRun(), dtn::net::TCPConvergenceLayer::componentRun(), ibrcommon::LinkMonitor::run(), dtn::routing::NeighborRoutingExtension::run(), dtn::routing::FloodRoutingExtension::run(), dtn::routing::StaticRoutingExtension::run(), dtn::routing::EpidemicRoutingExtension::run(), ibrcommon::Timer::run(), dtn::net::DownloadThread::run(), and dtn::net::TCPConnection::run().

Member Data Documentation

bool ibrcommon::Thread::_detached
protected

Definition at line 86 of file Thread.h.

Referenced by __execute__(), and reset().

ibrcommon::ThreadsafeState<THREAD_STATE> ibrcommon::Thread::_state
protected

Definition at line 71 of file Thread.h.

Referenced by __execute__(), cancel(), isFinalized(), ibrcommon::JoinableThread::isRunning(), ibrcommon::JoinableThread::join(), reset(), and ibrcommon::JoinableThread::~JoinableThread().

pthread_attr_t ibrcommon::Thread::attr
protected

Definition at line 83 of file Thread.h.

Referenced by reset(), and ~Thread().

int ibrcommon::Thread::priority
protected

Definition at line 80 of file Thread.h.

size_t ibrcommon::Thread::stack
protected

Definition at line 77 of file Thread.h.

pthread_t ibrcommon::Thread::tid
protected

Definition at line 74 of file Thread.h.

Referenced by ibrcommon::JoinableThread::join(), kill(), operator==(), and reset().

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