Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCHspStreamWriteThread.html below:
NCBI C++ ToolKit: CHspStreamWriteThread Class Reference
Search Toolkit Book for CHspStreamWriteThread
#include "hspstream_test_util.hpp"
(Private to src/algo/blast/unit_tests/api.)
CHspStreamWriteThread (BlastHSPStream *hsp_stream, int index, int nthreads, int total, int nqueries) ~CHspStreamWriteThread () 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...
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...
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 virtual void * Main (void) 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 () virtual void DeleteThis (void) Virtual method "deleting" this object. More...
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...
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 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 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 void EnableDebugDump (bool on) 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...
Definition at line 46 of file hspstream_test_util.hpp.
◆ CHspStreamWriteThread() ◆ ~CHspStreamWriteThread() ◆ Main() void * CHspStreamWriteThread::Main ( void ) protectedvirtual
Derived (user-created) class must provide a real thread function.
Implements CThread.
Definition at line 64 of file hspstream_test_util.cpp.
References abort(), ASSERT, BlastHSPStreamWrite(), kBlastHSPStream_Success, m_iIndex, m_iNumQueries, m_iNumThreads, m_ipHspStream, m_iTotal, NULL, and setupHSPList().
◆ OnExit() void CHspStreamWriteThread::OnExit ( void ) protectedvirtual
Override this to execute finalization code.
Unlike destructor, this code will be executed before thread termination and as a part of the thread.
Reimplemented from CThread.
Definition at line 82 of file hspstream_test_util.cpp.
◆ m_iIndex int CHspStreamWriteThread::m_iIndex private ◆ m_iNumQueries int CHspStreamWriteThread::m_iNumQueries private ◆ m_iNumThreads int CHspStreamWriteThread::m_iNumThreads private ◆ m_ipHspStream ◆ m_iTotal int CHspStreamWriteThread::m_iTotal private
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4