Search Toolkit Book for CThread
#include <corelib/ncbithr.hpp>
Inheritance diagram for CThread:
Collaboration diagram for CThread:
Public Types | |
| enum | ERunMode { fRunDefault = 0x00 , fRunDetached = 0x01 , fRunBound = 0x10 , fRunUnbound = 0x20 , fRunNice = 0x40 , fRunAllowST = 0x100 , fRunCloneRequestContext = 0x200 } |
| Which mode should the thread run in. More... | |
| typedef int | TRunMode |
| Bitwise OR'd flags for thread creation passed to Run(). More... | |
| typedef unsigned int | TID |
| Get ID of current thread. More... | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CThread (void) | |
| Constructor. More... | |
| bool | Run (TRunMode flags=fRunDefault) |
| Run the thread. More... | |
| void | Detach (void) |
| Inform the thread that user does not need to wait for its termination. More... | |
| void | Join (void **exit_data=0) |
| Wait for the thread termination. More... | |
| bool | Discard (void) |
| If the thread has not been Run() yet, then schedule the thread object for destruction, and return TRUE. More... | |
| bool | IsTerminated (void) const |
| Check if the thread has been terminated. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Static Public Member Functions | |
| static void | Exit (void *exit_data) |
| Cancel current thread. More... | |
| static TID | GetSelf (void) |
| static bool | IsMain (void) |
| static CThread * | GetCurrentThread (void) |
| Get current CThread object (or NULL, if main thread) More... | |
| static void | GetSystemID (TThreadSystemID *id) |
| Get system ID of the current thread - for internal use only. More... | |
| static unsigned int | GetThreadsCount () |
| Get total amount of threads This amount does not contain main thread. More... | |
| static void | SetCurrentThreadName (const CTempString &) |
| Set name for the current thread. More... | |
| static void | InitializeMainThreadId (void) |
| Initialize main thread's TID. More... | |
| static bool | IsAppExiting (void) |
| Check if the application is exiting (entered the destructor). More... | |
| static void | SetWaitForAllThreadsTimeout (const CTimeout &timeout) |
| Set timeout for stopping all threads on application exit. More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
Protected Member Functions | |
| virtual void * | Main (void)=0 |
| Derived (user-created) class must provide a real thread function. More... | |
| virtual void | OnExit (void) |
| Override this to execute finalization code. More... | |
| virtual | ~CThread (void) |
| To be called only internally! NOTE: destructor of the derived (user-provided) class should be declared "protected", too! More... | |
| TThreadHandle | GetThreadHandle () |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Private Member Functions | |
| void | x_InitializeThreadId (void) |
| initalize new thread id, must be called from Wrapper(). More... | |
| CThread (const CThread &) | |
| Prohibit copying and assigning. More... | |
| CThread & | operator= (const CThread &) |
Static Private Member Functions | |
| static TWrapperRes | Wrapper (TWrapperArg arg) |
| Function to use (internally) as the thread's startup function. More... | |
| static bool | WaitForAllThreads (void) |
Private Attributes | |
| TThreadHandle | m_Handle |
| platform-dependent thread handle More... | |
| bool | m_IsRun |
| if Run() was called for the thread More... | |
| bool | m_IsDetached |
| if the thread is detached More... | |
| bool | m_IsJoined |
| if Join() was called for the thread More... | |
| bool | m_IsTerminated |
| if Exit() was called for the thread More... | |
| CRef< CThread > | m_SelfRef |
| "this" – to avoid premature destruction More... | |
| void * | m_ExitData |
| as returned by Main() or passed to Exit() More... | |
| CRef< CRequestContext > | m_ParentRequestContext |
Static Private Attributes | |
| static bool | sm_IsExiting = false |
| static CTimeout | sm_WaitForThreadsTimeout = CTimeout(0.1) |
| static atomic< unsigned int > | sm_ThreadsCount |
| Total amount of threads. More... | |
Friends | |
| class | CRef< CThread > |
| class | CTlsBase |
| class | CNcbiApplicationAPI |
| TWrapperRes | ThreadWrapperCaller (TWrapperArg arg) |
Additional Inherited Members | |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
Detailed Description
CThread –.
Thread wrapper class.
Base class for user-defined threads. Creates the new thread, then calls user-provided Main() function. The thread then can be detached or joined. In any case, explicit destruction of the thread is prohibited.
Definition at line 527 of file ncbithr.hpp.
The documentation for this class was generated from the following files:
- include/corelib/ncbithr.hpp
- src/corelib/ncbithr.cpp
