Search Toolkit Book for SNetScheduleAPIImpl

#include "netschedule_api_impl.hpp"
(Private to src/connect/services.)

Inheritance diagram for SNetScheduleAPIImpl:

Collaboration diagram for SNetScheduleAPIImpl:

Classes
struct	SServerParamsSync

Public Types
typedef CNetScheduleAPI::TQueueParams	TQueueParams

typedef map< string, string >	TAuthParams

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
	SNetScheduleAPIImpl (CSynRegistryBuilder registry_builder, const string &section, const string &service_name=kEmptyStr, const string &client_name=kEmptyStr, const string &queue_name=kEmptyStr, bool wn=false, bool try_config=true)

	SNetScheduleAPIImpl (SNetServerInPool server, SNetScheduleAPIImpl parent)

	~SNetScheduleAPIImpl ()

CNetScheduleServerListener *	GetListener ()

CNetScheduleAPI::EJobStatus	GetJobStatus (string cmd, const CNetScheduleJob &job, time_t job_exptime, ENetScheduleQueuePauseMode pause_mode)

const CNetScheduleAPI::SServerParams &	GetServerParams ()

void	GetQueueParams (const string &queue_name, TQueueParams &queue_params)

void	GetQueueParams (TQueueParams &queue_params)

CNetServer	GetServer (const string &job_key)

CNetServer	GetServer (const CNetScheduleJob &job)

template<class TJob >
string	ExecOnJobServer (const TJob &job, const string &cmd, ESwitch roe=eDefault)

bool	GetServerByNode (const string &ns_node, CNetServer *server)

void	AllocNotificationThread ()

void	StartNotificationThread ()

void	x_ClearNode ()

void	UpdateAuthString ()

void	UseOldStyleAuth ()

void	SetAuthParam (const string &param_name, const string &param_value)

CCompoundIDPool	GetCompoundIDPool ()

void	Init (CSynRegistry &registry, SRegSynonyms &sections)

void	InitAffinities (CSynRegistry &registry, const SRegSynonyms &sections)

string	MakeAuthString ()

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 Attributes
CNetScheduleAPI::EClientType	m_ClientType = CNetScheduleAPI::eCT_Auto

CRef< SNetScheduleSharedData >	m_SharedData

bool	m_RetryOnException

CNetService	m_Service

string	m_Queue

string	m_ProgramVersion

string	m_ClientNode

string	m_ClientSession

TAuthParams	m_AuthParams

struct SNetScheduleAPIImpl::SServerParamsSync	m_ServerParamsSync

CNetScheduleExecutor::EJobAffinityPreference	m_AffinityPreference = CNetScheduleExecutor::eAnyJob

list< string >	m_AffinityList

CNetScheduleGetJob::TAffinityLadder	m_AffinityLadder

string	m_JobGroup

unsigned	m_JobTtl = 0

bool	m_UseEmbeddedStorage

CCompoundIDPool	m_CompoundIDPool

CFastMutex	m_NotificationThreadMutex

CRef< SNetScheduleNotificationThread >	m_NotificationThread

CAtomicCounter_WithAutoInit	m_NotificationThreadStartStopCounter

Private Types
enum	EMode { fWnCompatible = (0 << 0) , fNonWnCompatible = (1 << 0) , fConfigLoading = (1 << 1) , fWorkerNode = fWnCompatible , fNetSchedule = fNonWnCompatible }

typedef int	TMode

Static Private Member Functions
static TMode	GetMode (bool wn, bool try_config)

Private Attributes
const TMode	m_Mode

Additional Inherited Members
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)

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...

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

Detailed Description

Definition at line 285 of file netschedule_api_impl.hpp.

Member Typedef Documentation

◆ TAuthParams

typedef map<string, string> SNetScheduleAPIImpl::TAuthParams

Definition at line 381 of file netschedule_api_impl.hpp.

◆ TMode

typedef int SNetScheduleAPIImpl::TMode

private

Definition at line 295 of file netschedule_api_impl.hpp.

◆ TQueueParams

typedef CNetScheduleAPI::TQueueParams SNetScheduleAPIImpl::TQueueParams

Definition at line 326 of file netschedule_api_impl.hpp.

Member Enumeration Documentation

◆ EMode

enum SNetScheduleAPIImpl::EMode

private

Enumerator
fWnCompatible
fNonWnCompatible
fConfigLoading
fWorkerNode
fNetSchedule

Definition at line 288 of file netschedule_api_impl.hpp.

Constructor & Destructor Documentation

◆ SNetScheduleAPIImpl() [1/2]

SNetScheduleAPIImpl::SNetScheduleAPIImpl	(	CSynRegistryBuilder	registry_builder,
		const string &	section,
		const string &	service_name = `kEmptyStr`,
		const string &	client_name = `kEmptyStr`,
		const string &	queue_name = `kEmptyStr`,
		bool	wn = `false`,
		bool	try_config = `true`
	)

Definition at line 712 of file netschedule_api.cpp.

References SNetServiceImpl::Create(), fNonWnCompatible, Init(), kNetScheduleAPIDriverName, m_Mode, m_Service, and m_SharedData.

Referenced by CNetScheduleAPICF::CreateInstance(), CNetScheduleAPIExt::CreateNoCfgLoad(), CNetScheduleAPIExt::CreateWnCompat(), and CNetScheduleAPIExt::GetServer().

◆ SNetScheduleAPIImpl() [2/2]

SNetScheduleAPIImpl::SNetScheduleAPIImpl	(	SNetServerInPool *	server,
		SNetScheduleAPIImpl *	parent
	)

Definition at line 726 of file netschedule_api.cpp.

◆ ~SNetScheduleAPIImpl()

SNetScheduleAPIImpl::~SNetScheduleAPIImpl ( )

Definition at line 333 of file netschedule_api.cpp.

References CAtomicCounter::Add(), CThread::Join(), m_NotificationThread, m_NotificationThreadMutex, m_NotificationThreadStartStopCounter, SNetScheduleNotificationThread::m_Receiver, SNetScheduleNotificationThread::m_StopThread, NULL, SNetScheduleNotificationReceiver::port, and CDatagramSocket::Send().

Member Function Documentation

◆ AllocNotificationThread()

void SNetScheduleAPIImpl::AllocNotificationThread ( )

Definition at line 319 of file netschedule_api.cpp.

References m_NotificationThread, m_NotificationThreadMutex, and NULL.

◆ ExecOnJobServer()

template<class TJob >

string SNetScheduleAPIImpl::ExecOnJobServer	(	const TJob &	job,
		const string &	cmd,
		ESwitch	roe = `eDefault`
	)

inline

Definition at line 342 of file netschedule_api_impl.hpp.

References cmd, eDefault, and eOn.

Referenced by GetJobStatus(), and CNetScheduleNotificationHandler::RequestJobWatching().

◆ GetCompoundIDPool()

CCompoundIDPool SNetScheduleAPIImpl::GetCompoundIDPool ( void )

inline

Definition at line 362 of file netschedule_api_impl.hpp.

Referenced by SGridWorkerNodeImpl::OfflineRun().

◆ GetJobStatus()

CNetScheduleAPI::EJobStatus SNetScheduleAPIImpl::GetJobStatus	(	string	cmd,
		const CNetScheduleJob &	job,
		time_t *	job_exptime,
		ENetScheduleQueuePauseMode *	pause_mode
	)