Search Toolkit Book for CTlsBase
CTlBase –. More...
#include <corelib/ncbithr.hpp>
Inheritance diagram for CTlsBase:
Collaboration diagram for CTlsBase:
Classes | |
| struct | STlsData |
| Internal structure to store all three pointers in the same TLS. More... | |
Public Types | |
| enum | ENativeThreadCleanup { eDoCleanup , eSkipCleanup } |
| Flag indicating if cleanup function should be called when using native threads rather than CThread. More... | |
| enum | ECleanupMode { eCleanup_Toolkit , eCleanup_Native } |
| Flag telling which code has called TLS cleanup. More... | |
| typedef void(* | FCleanupBase) (void *value, void *cleanup_data) |
| 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... | |
Static Public Member Functions | |
| template<class TValue > | |
| static void | DefaultCleanup (TValue *value, void *) |
| 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 | |
| CTlsBase (bool auto_destroy) | |
| Constructor. More... | |
| ~CTlsBase (void) | |
| Destructor. More... | |
| void * | x_GetValue (void) const |
| Helper method to get stored thread data. More... | |
| void | x_SetValue (void *value, FCleanupBase cleanup, void *cleanup_data, ENativeThreadCleanup native) |
| Helper method to set thread data. More... | |
| void | x_Reset (void) |
| Helper method to reset thread data. More... | |
| void | x_Init (void) |
| Initialize thread data. More... | |
| void | x_Destroy (void) |
| Destroy thread data. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Private Member Functions | |
| STlsData * | x_GetTlsData (void) const |
| Helper method to get the STlsData*. More... | |
| bool | x_DeleteTlsData (ECleanupMode mode=eCleanup_Toolkit) |
| Deletes STlsData* structure and managed pointer Returns true if CTlsBase must be deregistered from current thread. More... | |
Static Private Member Functions | |
| static void | CleanupAndDeleteTlsData (void *data, ECleanupMode mode=eCleanup_Toolkit) |
| static void | CleanupTlsData (void *data, ECleanupMode mode=eCleanup_Toolkit) |
| static void | x_CleanupThreadCallback (void *ptr) |
Private Attributes | |
| TTlsKey | m_Key |
| bool | m_Initialized |
| Indicates if thread data initialized. More... | |
| bool | m_AutoDestroy |
| Indicates if object should be destroyed in destructor. More... | |
Friends | |
| class | CRef< CTlsBase > |
| class | CUsedTlsBases |
| class | CStaticTlsHelper |
Additional Inherited Members | |
| 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 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
CTlBase –.
Base class for CTls<> for storing thread-specific data.
Definition at line 65 of file ncbithr.hpp.
The documentation for this class was generated from the following files:
- include/corelib/ncbithr.hpp
- src/corelib/ncbithr.cpp
