Search Toolkit Book for CUsageReportJob

#include <connect/ncbi_usage_report.hpp>

Inheritance diagram for CUsageReportJob:

Collaboration diagram for CUsageReportJob:

Public Types
enum	EState { eCreated , eQueued , eRunning , eCompleted , eFailed , eCanceled , eRejected }
	Job state. 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 Types inherited from IAppJob
enum	EJobState { eInvalid , eRunning , eCompleted , eFailed , eCanceled , eSuspended }
	Job states (describe FSM) More...

Public Member Functions
	CUsageReportJob (void)
	Default constructor. More...

virtual	~CUsageReportJob (void)
	Destructor. More...

EState	GetState ()
	Return current job state. More...

virtual void	OnStateChange (EState)
	Callback for async reporting. More...

	CUsageReportJob (const CUsageReportJob &other)
	Copy constructor. More...

CUsageReportJob &	operator= (const CUsageReportJob &other)
	Copy assignment operator. More...

	CUsageReportJob (const CReportParams &params)

IAppJob implementation
virtual EJobState	Run ()
	Function that does all the useful work, called by the Engine. More...

virtual CConstIRef< IAppJobProgress >	GetProgress ()
	return progress object, the function shall be synchronized internally. More...

virtual CRef< CObject >	GetResult ()
	Returns the Job Result. More...

virtual CConstIRef< IAppJobError >	GetError ()
	Returns IAppJobError object describing internal error that caused the Job to fail. More...

virtual string	GetDescr () const
	Returns a human readable description of the Job (optional) More...

virtual void	RequestCancel ()
	RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...

virtual bool	IsCanceled () const

Public Member Functions inherited from CUsageReportParameters
	CUsageReportParameters (void)

CUsageReportParameters &	Add (const string &name, const string &value)
	Add argument Name must contain only alphanumeric chars or '_'. More...

CUsageReportParameters &	Add (const string &name, const char *value)

template<typename TValue >
CUsageReportParameters &	Add (const string &name, TValue value)

string	ToString () const
	Convert parameters to string. URL-encode all values. More...

	CUsageReportParameters (const CUsageReportParameters &other)
	Copy constructor. More...

CUsageReportParameters &	operator= (const CUsageReportParameters &other)
	Copy assignment operator. 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

Public Member Functions inherited from IAppJob
virtual	~IAppJob ()

virtual bool	BeforeRun ()
	Function will be called on the main thread before execution of Run Should not do any lengthy work returns true to continue job execution on worker thread false to quit execution with status - failed. More...

Static Public Member Functions
static bool	IsEnabled ()
	Indicates whether usage statistics collection is enabled. More...

static void	SetEnabled (bool enable=true)
	Switch usage statistics collection on/off. More...

static void	SaveSettings ()

static void	LoadSettings ()

static void	ReportUsage (CReportParams &params)

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
void	x_SetState (EState state)
	Set new job state. More...

void	x_CopyFrom (const CUsageReportJob &other)
	Copy data from 'other' job. More...

Protected Member Functions inherited from CUsageReportParameters
void	x_CopyFrom (const CUsageReportParameters &other)
	Copy parameters to another objects. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Static Private Member Functions
static string	x_GetOS ()

static string	x_GetGbenchVersion ()

Private Attributes
EState	m_State
	Job state. More...

bool	m_Canceled

string	m_URL

Static Private Attributes
static bool	m_IsEnabled = true

static volatile unsigned	m_FailedAttempts = 0

static std::mutex	m_VersionStringMutex
	version string access mutex More...

Friends
class	CUsageReport

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

CUsageReportJob::

Job to log usage information to applog through stat.

Extended version of CUsageReportParameters. Can be used the same way in regards of adding parameters, but also allow to be overloaded to control reporting status for asynchronous calls.

This is a base class, that DO NOTHING on failed or rejected reports. If you want some additional functionality you need to derive yours own class from it and override the OnStateChange() method and. For derived class you can also need to define a copy constructor. But in the case of primitive members only default copy constructor should works.

Note: This class is not MT safe by default, concurrent access to the same object may cause data races.

See also: CUsageReportParameters, CUsageReport

Definition at line 298 of file ncbi_usage_report.hpp.

Constructor & Destructor Documentation

◆ CUsageReportJob()

CUsageReportJob::CUsageReportJob ( const CReportParams & params )

Definition at line 116 of file usage_report_job.cpp.

References m_URL, and CReportParams::ToString().

Member Function Documentation

◆ GetDescr()

virtual string CUsageReportJob::GetDescr ( ) const

inlinevirtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 83 of file usage_report_job.hpp.

References NcbiEmptyString.

◆ GetError()

virtual CConstIRef<IAppJobError> CUsageReportJob::GetError ( )

inlinevirtual

Returns IAppJobError object describing internal error that caused the Job to fail.

Result shall be returned only if the Job did fail.

Implements IAppJob.

Definition at line 82 of file usage_report_job.hpp.

◆ GetProgress()

virtual CConstIRef<IAppJobProgress> CUsageReportJob::GetProgress ( )

inlinevirtual

return progress object, the function shall be synchronized internally.

the returned object should not be modified by the job (job shall create a new instance of Progress object on every GetProgress() invocation).

Implements IAppJob.

Definition at line 80 of file usage_report_job.hpp.

◆ GetResult()

virtual CRef<CObject> CUsageReportJob::GetResult ( )

inlinevirtual

Returns the Job Result.

Derive your own object from CObject and return it from your Job class. Result shall be returned only if Job finished succesfully.

Implements IAppJob.

Definition at line 81 of file usage_report_job.hpp.

◆ IsCanceled()

virtual bool CUsageReportJob::IsCanceled ( ) const

inlinevirtual

Implements IAppJob.

Definition at line 85 of file usage_report_job.hpp.

References m_Canceled.

◆ IsEnabled()

bool CUsageReportJob::IsEnabled ( void )

static

Indicates whether usage statistics collection is enabled.

Definition at line 136 of file usage_report_job.cpp.

References m_FailedAttempts, and m_IsEnabled.

◆ LoadSettings()

void CUsageReportJob::LoadSettings ( )

static

Definition at line 170 of file usage_report_job.cpp.

References CGuiRegistry::GetBool(), CGuiRegistry::GetInstance(), kRegistryKey, and m_IsEnabled.

◆ ReportUsage()

void CUsageReportJob::ReportUsage ( CReportParams & params )

static

Definition at line 146 of file usage_report_job.cpp.

References CReportParams::Add(), CUsageReportJob(), CAppJobDispatcher::GetInstance(), LOG_POST, m_FailedAttempts, CException::ReportAll(), CAppJobDispatcher::StartJob(), Warning(), x_GetGbenchVersion(), and x_GetOS().

◆ RequestCancel()

virtual void CUsageReportJob::RequestCancel ( )

inlinevirtual

RequestCancel() is called to notify the Job that it shall exit Run() function ASAP.

The function shall be synchronized internally.

Implements IAppJob.

Definition at line 84 of file usage_report_job.hpp.

References m_Canceled.

◆ Run()

IAppJob::EJobState CUsageReportJob::Run ( )

virtual

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Definition at line 123 of file usage_report_job.cpp.

References IAppJob::eCompleted, IAppJob::eFailed, CHttpSession_Base::Get(), CHttpResponse::GetStatusCode(), m_FailedAttempts, and m_URL.

◆ SaveSettings()

void CUsageReportJob::SaveSettings ( )

static

Definition at line 164 of file usage_report_job.cpp.

References CGuiRegistry::GetInstance(), kRegistryKey, m_IsEnabled, and CGuiRegistry::Set().

◆ SetEnabled()

void CUsageReportJob::SetEnabled ( bool enable = true )

static

Switch usage statistics collection on/off.

Definition at line 141 of file usage_report_job.cpp.

References m_IsEnabled.

◆ x_GetGbenchVersion()

string CUsageReportJob::x_GetGbenchVersion ( )

staticprivate

Definition at line 189 of file usage_report_job.cpp.

References CGBenchVersion::eMajor, CGBenchVersion::eMinor, CGBenchVersion::ePatchLevel, and m_VersionStringMutex.

Referenced by ReportUsage().

◆ x_GetOS()

string CUsageReportJob::x_GetOS ( )

staticprivate

Definition at line 176 of file usage_report_job.cpp.

References string.

Referenced by ReportUsage().

Member Data Documentation

◆ m_Canceled

bool CUsageReportJob::m_Canceled

private

Definition at line 104 of file usage_report_job.hpp.

Referenced by IsCanceled(), and RequestCancel().

◆ m_FailedAttempts

volatile unsigned CUsageReportJob::m_FailedAttempts = 0

staticprivate

Definition at line 107 of file usage_report_job.hpp.

Referenced by IsEnabled(), ReportUsage(), and Run().

◆ m_IsEnabled

bool CUsageReportJob::m_IsEnabled = true

staticprivate

Definition at line 106 of file usage_report_job.hpp.

Referenced by IsEnabled(), LoadSettings(), SaveSettings(), and SetEnabled().

◆ m_URL

string CUsageReportJob::m_URL

private

Definition at line 105 of file usage_report_job.hpp.

Referenced by CUsageReportJob(), and Run().

◆ m_VersionStringMutex

std::mutex CUsageReportJob::m_VersionStringMutex

staticprivate

version string access mutex

Definition at line 108 of file usage_report_job.hpp.

Referenced by x_GetGbenchVersion().

The documentation for this class was generated from the following files:

include/connect/ncbi_usage_report.hpp
include/gui/objutils/usage_report_job.hpp
src/connect/ncbi_usage_report.cpp
src/gui/objutils/usage_report_job.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CUsageReportJob()

Member Function Documentation

◆ GetDescr()

◆ GetError()

◆ GetProgress()

◆ GetResult()

◆ IsCanceled()

◆ IsEnabled()

◆ LoadSettings()

◆ ReportUsage()

◆ RequestCancel()

◆ Run()

◆ SaveSettings()

◆ SetEnabled()

◆ x_GetGbenchVersion()

◆ x_GetOS()

Member Data Documentation

◆ m_Canceled

◆ m_FailedAttempts

◆ m_IsEnabled

◆ m_URL

◆ m_VersionStringMutex