Inheritance diagram for BatchServiceClientMgr:

[legend]

Public Member Functions
virtual	~BatchServiceClientMgr ()

bool	isOK () const

Public Member Functions inherited from ServiceClientMgr
virtual	~ServiceClientMgr ()

BufferString	getLockFileFP (const Network::Service::ID) const

bool	isAlive (const Network::Service::ID) const

bool	isPresent (const Network::Service::ID) const

void	printInfo (const Network::Service::ID, const char desc=nullptr, od_ostream =nullptr) const

uiRetVal	sendAction (const Network::Service::ID, const char *) const

uiRetVal	sendRequest (const Network::Service::ID, const char *, const OD::JSON::Object &) const

BufferString	serviceName (const Network::Service::ID) const

Network::Service::SubID	serviceSubID (const Network::Service::ID) const

bool	stopService (const Network::Service::ID)

Public Member Functions inherited from ServiceMgrBase
virtual	~ServiceMgrBase ()

Network::Authority	getAuthority (bool islocal) const

bool	isOK (bool islocal) const

virtual void	stopServer (bool islocal)

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)

	NamedCallBacker (const NamedCallBacker &)

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const

bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const

void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

void	detachCB (const NotifierAccess &, const CallBack &) const

void	detachCB (const NotifierAccess *notif, const CallBack &cb) const

virtual bool	isCapsule () const

bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...

void	stopReceivingNotifications () const

virtual CallBacker *	trueCaller ()

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

const name_type &	name () const override

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

virtual void	setName (const char *nm)

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Static Public Member Functions
static BatchServiceClientMgr &	getMgr ()

static const char *	sKeyBatchRequest ()

static const char *	sKeyDoWork ()

static const char *	sKeyFinished ()

static const char *	sKeyKilled ()

static const char *	sKeyPaused ()

static const char *	sKeyResumed ()

static const char *	sKeyStoreInfo ()

Static Public Member Functions inherited from ServiceClientMgr
static bool	addApplicationAuthority (OS::MachineCommand &)

Static Public Member Functions inherited from ServiceMgrBase
static const char *	sKeyCloseEv ()

static const char *	sKeyDeregister ()

static const char *	sKeyEvent ()

static const char *	sKeyODServer ()

static const char *	sKeyPyEnvChangeEv ()

static const char *	sKeyRegister ()

static const char *	sKeyStatusEv ()

static const char *	sKeySurveyChangeEv ()

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Private Member Functions
	BatchServiceClientMgr ()

void	batchServiceAdded (CallBacker *)

void	batchServiceRemoved (CallBacker *)

void	batchServiceToBeAdded (CallBacker *)

bool	canClaimService (const Network::Service &) const override

bool	canParseAction (const char *, uiRetVal &) override

bool	canParseRequest (const OD::JSON::Object &, uiRetVal &) override

void	doAppClosing (CallBacker *) override

uiRetVal	doHandleAction (const char *action) override

uiRetVal	doHandleRequest (const OD::JSON::Object &) override

Friends
class	uiServiceClientMgr

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Protected Member Functions inherited from ServiceClientMgr
	ServiceClientMgr (const char *servicenm)

	ServiceClientMgr (const char *servicenm, bool assignport, Network::SpecAddr=Network::Any)

bool	checkService (const Network::Service::ID) const

void	closeApp () override

Network::Service *	getService (const Network::Service::ID)

const Network::Service *	getService (const Network::Service::ID) const

uiRetVal	sendAction (const Network::Service &, const char *) const

uiRetVal	sendRequest (const Network::Service &, const char *, const OD::JSON::Object &) const

Protected Member Functions inherited from ServiceMgrBase
	ServiceMgrBase (const char *servicenm)

	ServiceMgrBase (const char *servicenm, bool assignport, Network::SpecAddr=Network::Any)

bool	addLocalServer ()

bool	addTCPServer (bool assignport=true, Network::SpecAddr=Network::Any)

virtual void	doPyEnvChange (CallBacker *)

virtual void	doSurveyChanged (CallBacker *)

bool	isMainService () const

void	sendErr (uiRetVal &)

void	sendOK ()

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Static Protected Member Functions inherited from ServiceMgrBase
static bool	addApplicationAuthority (bool local, OS::MachineCommand &)

static void	debugMsg (const char *)

static void	getPythEnvRequestInfo (OD::JSON::Object &)

static uiRetVal	sendAction (const Network::Authority &, const char servicenm, const char action)

static uiRetVal	sendRequest (const Network::Authority &, const char servicenm, const char reqkey, const OD::JSON::Object &)

static const char *	sKeyClientAppCloseEv ()

static const ServiceMgrBase *	theMain ()

static const ServiceMgrBase *	theMain (bool local)

Protected Attributes inherited from ServiceClientMgr
ObjectSet< Network::Service >	services_

CNotifier< ServiceClientMgr, Network::Service * >	serviceToBeAdded

CNotifier< ServiceClientMgr, Network::Service * >	serviceToBeRemoved

Protected Attributes inherited from ServiceMgrBase
CNotifier< ServiceMgrBase, BufferString >	startHandleAction

CNotifier< ServiceMgrBase, const OD::JSON::Object * >	startHandleRequest

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

\ brief Base class for sending/receiving signals to/from running Batch programs. You must likely only need the manager for sending actions/requests to the batch programs. It also lists the keys that will be send by the batch program to keep us informed on its status.

<>

Constructor & Destructor Documentation

◆ ~BatchServiceClientMgr()

virtual BatchServiceClientMgr::~BatchServiceClientMgr ( )

virtual

◆ BatchServiceClientMgr()

BatchServiceClientMgr::BatchServiceClientMgr ( )

private

Member Function Documentation

◆ batchServiceAdded()

void BatchServiceClientMgr::batchServiceAdded ( CallBacker * )

private

◆ batchServiceRemoved()

void BatchServiceClientMgr::batchServiceRemoved ( CallBacker * )

private

◆ batchServiceToBeAdded()

void BatchServiceClientMgr::batchServiceToBeAdded ( CallBacker * )

private

◆ canClaimService()

bool BatchServiceClientMgr::canClaimService ( const Network::Service & ) const

overrideprivatevirtual

Implements ServiceClientMgr.

◆ canParseAction()

bool BatchServiceClientMgr::canParseAction	(	const char *	,
		uiRetVal &
	)

overrideprivatevirtual

Reimplemented from ServiceClientMgr.

◆ canParseRequest()

bool BatchServiceClientMgr::canParseRequest	(	const OD::JSON::Object &	,
		uiRetVal &
	)

overrideprivatevirtual

Reimplemented from ServiceClientMgr.

◆ doAppClosing()

void BatchServiceClientMgr::doAppClosing ( CallBacker * )

overrideprivatevirtual

Reimplemented from ServiceClientMgr.

◆ doHandleAction()

uiRetVal BatchServiceClientMgr::doHandleAction ( const char * action )

overrideprivatevirtual

Reimplemented from ServiceClientMgr.

◆ doHandleRequest()

uiRetVal BatchServiceClientMgr::doHandleRequest ( const OD::JSON::Object & )

overrideprivatevirtual

Reimplemented from ServiceClientMgr.

◆ getMgr()

static BatchServiceClientMgr& BatchServiceClientMgr::getMgr ( )

static

◆ isOK()

bool BatchServiceClientMgr::isOK ( ) const

◆ sKeyBatchRequest()

static const char* BatchServiceClientMgr::sKeyBatchRequest ( )

inlinestatic

◆ sKeyDoWork()

static const char* BatchServiceClientMgr::sKeyDoWork ( )

inlinestatic

◆ sKeyFinished()

static const char* BatchServiceClientMgr::sKeyFinished ( )

inlinestatic

◆ sKeyKilled()

static const char* BatchServiceClientMgr::sKeyKilled ( )

inlinestatic

◆ sKeyPaused()

static const char* BatchServiceClientMgr::sKeyPaused ( )

inlinestatic

◆ sKeyResumed()

static const char* BatchServiceClientMgr::sKeyResumed ( )

inlinestatic

◆ sKeyStoreInfo()

static const char* BatchServiceClientMgr::sKeyStoreInfo ( )

inlinestatic

Friends And Related Function Documentation

◆ uiServiceClientMgr

friend class uiServiceClientMgr

friend

Member Data Documentation

◆ batchEnded

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchEnded

◆ batchFinished

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchFinished

◆ batchHasStarted

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchHasStarted

◆ batchKilled

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchKilled

◆ batchPaused

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchPaused

◆ batchResumed

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchResumed

◆ batchStarted

CNotifier<BatchServiceClientMgr,Network::Service::ID> BatchServiceClientMgr::batchStarted

Public Attributes
CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchEnded

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchFinished

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchHasStarted

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchKilled

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchPaused

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchResumed

CNotifier< BatchServiceClientMgr, Network::Service::ID >	batchStarted

Public Attributes inherited from ServiceClientMgr
CNotifier< ServiceClientMgr, Network::Service::ID >	serviceAdded

CNotifier< ServiceClientMgr, Network::Service::ID >	serviceRemoved

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BatchServiceClientMgr()

◆ BatchServiceClientMgr()

Member Function Documentation

◆ batchServiceAdded()

◆ batchServiceRemoved()

◆ batchServiceToBeAdded()

◆ canClaimService()

◆ canParseAction()

◆ canParseRequest()

◆ doAppClosing()

◆ doHandleAction()

◆ doHandleRequest()

◆ getMgr()

◆ isOK()

◆ sKeyBatchRequest()

◆ sKeyDoWork()

◆ sKeyFinished()

◆ sKeyKilled()

◆ sKeyPaused()

◆ sKeyResumed()

◆ sKeyStoreInfo()

Friends And Related Function Documentation

◆ uiServiceClientMgr

Member Data Documentation

◆ batchEnded

◆ batchFinished

◆ batchHasStarted

◆ batchKilled

◆ batchPaused

◆ batchResumed

◆ batchStarted