Nektar::Thread Namespace Reference

Classes
class	ThreadJob
	Base class for tasks to be sent to the ThreadManager to run. More...
class	ThreadManager
	The interface class for the controller for worker threads and jobs. More...
class	ThreadMaster
class	ThreadStartupManager
	A default ThreadManager. More...
class	ThreadManagerBoost
	Implementation of ThreadManager using Boost threads. More...
class	ThreadWorkerBoost
	Implementation class for ThreadManagerBoost. More...

Typedefs
typedef std::shared_ptr< ThreadManager >	ThreadManagerSharedPtr
typedef LibUtilities::NekFactory< std::string, ThreadManager, unsigned int >	ThreadManagerFactory
typedef boost::unique_lock< boost::shared_mutex >	WriteLock
typedef boost::shared_lock< boost::shared_mutex >	ReadLock
typedef boost::unique_lock< boost::mutex >	Lock

Enumerations
enum	SchedType { e_guided , e_dynamic }
	Identifies the algorithm for scheduling. More...

Functions
ThreadManagerFactory &	GetThreadManagerFactory ()
ThreadMaster &	GetThreadMaster ()

Typedef Documentation

Lock

typedef boost::unique_lock<boost::mutex> Nektar::Thread::Lock

Definition at line 51 of file ThreadBoost.h.

ReadLock

typedef boost::shared_lock<boost::shared_mutex> Nektar::Thread::ReadLock

Definition at line 321 of file Thread.h.

ThreadManagerFactory

typedef LibUtilities::NekFactory<std::string, ThreadManager, unsigned int> Nektar::Thread::ThreadManagerFactory

Definition at line 74 of file Thread.h.

ThreadManagerSharedPtr

typedef std::shared_ptr<ThreadManager> Nektar::Thread::ThreadManagerSharedPtr

Definition at line 72 of file Thread.h.

WriteLock

typedef boost::unique_lock<boost::shared_mutex> Nektar::Thread::WriteLock

Definition at line 320 of file Thread.h.

Enumeration Type Documentation

SchedType

enum Nektar::Thread::SchedType

Identifies the algorithm for scheduling.

Currently there are two strategies to determine the number of jobs. e_static always loads m_chunkSize jobs onto each worker, e_guided uses a simple algorithm that loads a larger proportion of jobs onto the worker as the size of the queue list is large, but scales down to no fewer than m_chunkSize as the queue empties.

See also

ThreadManager::SetChunkSize()

Enumerator
e_guided
e_dynamic

Definition at line 65 of file Thread.h.

{
    e_guided,
    e_dynamic
};

Function Documentation

GetThreadManagerFactory()

ThreadManagerFactory & Nektar::Thread::GetThreadManagerFactory

(

)

Definition at line 49 of file Thread.cpp.

{
    static ThreadManagerFactory instance;
    return instance;
}

Referenced by Nektar::Thread::ThreadMaster::CreateInstance().

GetThreadMaster()

ThreadMaster & Nektar::Thread::GetThreadMaster

(

)

Definition at line 132 of file Thread.cpp.

{
    static ThreadMaster instance;
    return instance;
}