NCBI C++ ToolKit
Public Member Functions | Private Member Functions | List of all members
CStatRotator Class Reference

Search Toolkit Book for CStatRotator

#include "nc_stat.hpp"
(Private to src/app/netcache.)

+ Inheritance diagram for CStatRotator:
+ Collaboration diagram for CStatRotator:

Public Member Functions

 CStatRotator (void)
virtual ~CStatRotator (void)
void CalcNextRun (void)
- Public Member Functions inherited from CSrvTask
 CSrvTask (void)
void SetRunnable (bool boost=false)
 Set this task "runnable", i.e. More...
void RunAfter (Uint4 delay_sec)
 This call is basically equivalent to SetRunnable() but with guarantee that task will be scheduled for execution no earlier than delay_sec later (approximately, can be up to a second less if measured in absolute wall time). More...
virtual void Terminate (void)
 Stops task's execution and deletes it. More...
void SetPriority (Uint4 prty)
 Set and retrieve task's priority. More...
Uint4 GetPriority (void)
void CreateNewDiagCtx (void)
 Create new diagnostic context for this task to work in. More...
void SetDiagCtx (CRequestContext *ctx)
 Set diagnostic context for this task to work in. More...
CRequestContextGetDiagCtx (void)
 Get current diagnostic context for the task. More...
void ReleaseDiagCtx (void)
 Releases current diagnostic context of the task. More...
virtual ~CSrvTask (void)
virtual void InternalRunSlice (TSrvThreadNum thr_num)
 This is the real time slice execution method called from TaskServer. More...

Private Member Functions

virtual void ExecuteSlice (TSrvThreadNum thr_num)
 This is the main method to do all work this task should do. More...

Additional Inherited Members

- Static Public Member Functions inherited from CSrvTask
static void PrintState (CSrvSocketTask &task)
- Public Attributes inherited from CSrvTask
TSrvTaskListHook m_TaskListHook
 Hook to put this task into TSrvTaskList. More...
TSrvThreadNum m_LastThread
 Thread number where this task was executed last time. More...
TSrvTaskFlags m_TaskFlags
 Bit-OR of flags for this task. More...
int m_LastActive
 Time (in seconds) when the task was active last time, i.e. More...
Uint4 m_Priority
 Task's priority. More...
 Current diagnostic context for this task. More...
CRequestContext ** m_DiagChain
 Nested diagnostic contexts of this task. More...
size_t m_DiagChainSize
 Timer ticket assigned to this task when it calls RunAfter(). More...
CSrvTaskTerminator m_Terminator
 Object that will delete this task after call to Terminate(). More...

Detailed Description

Definition at line 183 of file nc_stat.hpp.

Constructor & Destructor Documentation

◆ CStatRotator()

CStatRotator::CStatRotator ( void  )

Definition at line 1170 of file nc_stat.cpp.

◆ ~CStatRotator()

CStatRotator::~CStatRotator ( void  )

Definition at line 1177 of file nc_stat.cpp.

Member Function Documentation

◆ CalcNextRun()

void CStatRotator::CalcNextRun ( void  )

Definition at line 1181 of file nc_stat.cpp.

References CSrvTime::CurSecs(), kMinStatPeriod, CSrvTask::RunAfter(), and t.

Referenced by ExecuteSlice(), and CNCStat::Initialize().

◆ ExecuteSlice()

void CStatRotator::ExecuteSlice ( TSrvThreadNum  thr_num)

This is the main method to do all work this task should do.

This method will be called periodically while somebody calls SetRunnable() or RunAfter() on this task. But number of calls to this method won't match number of calls to SetRunnable() – if several calls to SetRunnable() are made before ExecuteSlice() had a chance to execute it will be called only once. Task's code inside ExecuteSlice() should understand itself how much work it needs to do and call SetRunnable() again if needed (or do all the work before returning from ExecuteSlice()). Parameter thr_num is number of thread on which ExecuteSlice() is called.

Implements CSrvTask.

Definition at line 1192 of file nc_stat.cpp.

References CalcNextRun(), CSrvTime::CurSecs(), i, CTaskServer::IsInShutdown(), kMinStatPeriod, s_CollectCurStats(), and s_LastRotateSecs.

The documentation for this class was generated from the following files:
Modified on Tue May 21 10:58:02 2024 by rev. 669887