Base class for OpendTect Service Manager and external services/apps. More...

Inheritance diagram for ODServiceBase:

Protected Member Functions
	ODServiceBase (bool assignport=true)

bool	isMainService () const

virtual bool	doParseAction (const char *, uiRetVal &)
	Return true if the action was handled. More...

virtual bool	doParseRequest (const OD::JSON::Object &, uiRetVal &)
	Return true if the request was handled. More...

void	sendOK ()

void	sendErr (uiRetVal &)

virtual void	doSurveyChanged (CallBacker *)

virtual void	doAppClosing (CallBacker *)

virtual void	doPyEnvChange (CallBacker *)

virtual void	doConnClosed (CallBacker *)

virtual void	closeApp ()

Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Static Protected Member Functions
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 OD::JSON::Object *	getSubObj (const OD::JSON::Object &, const char *key)

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

Private Member Functions
mODTextTranslationClass(ODServiceBase) public bool	isOK () const

Network::Authority	getAuthority () const

virtual void	stopServer ()

void	setRetVal (const uiRetVal &uirv)

	ODServiceBase (const ODServiceBase &)=delete

	ODServiceBase (ODServiceBase &&)=delete

ODServiceBase &	operator= (const ODServiceBase &)=delete

ODServiceBase &	operator= (ODServiceBase &&)=delete

virtual void	startServer (PortNr_Type)

uiRetVal	doAction (const OD::JSON::Object &)

uiRetVal	doRequest (const OD::JSON::Object &)

uiRetVal	survChangedReq (const OD::JSON::Object &)

uiRetVal	pythEnvChangedReq (const OD::JSON::Object &)

uiRetVal	doPrepareForClose ()

void	newConnectionCB (CallBacker *)

void	packetArrivedCB (CallBacker *)

void	externalActionCB (CallBacker *)

void	externalRequestCB (CallBacker *)

void	connClosedCB (CallBacker *)

void	appClosingCB (CallBacker *)

void	surveyChangedCB (CallBacker *)

void	pyenvChangeCB (CallBacker *)

Static Private Member Functions
static const char *	sKeyAction ()

static const char *	sKeyError ()

static const char *	sKeyOK ()

static const char *	sKeyEvent ()

static const char *	sKeyRegister ()

static const char *	sKeyDeregister ()

static const char *	sKeyStart ()

static const char *	sKeyCloseEv ()

static const char *	sKeyHideEv ()

static const char *	sKeyPyEnvChangeEv ()

static const char *	sKeyRaiseEv ()

static const char *	sKeyStatusEv ()

static const char *	sKeySurveyChangeEv ()

static const char *	sKeyTransferCmplt ()

static const char *	sKeyProcessingDone ()

static const char *	sKeyODServer ()

static ODServiceBase *	theMain (ODServiceBase *newmain=nullptr)

Private Attributes
CNotifier< ODServiceBase, BufferString >	externalAction

CNotifier< ODServiceBase, const OD::JSON::Object * >	externalRequest

Network::RequestServer *	server_ = nullptr

bool	serverismine_ = true

Network::RequestConnection *	conn_ = nullptr

PtrMan< Network::RequestPacket >	packet_

bool	needclose_ = false

uiRetVal	uirv_

Additional Inherited Members
Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

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

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

void	detachCB (NotifierAccess &, const CallBack &)

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

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

Detailed Description

Base class for OpendTect Service Manager and external services/apps.

Constructor & Destructor Documentation

ODServiceBase::ODServiceBase ( bool assignport = true )

protected

ODServiceBase::ODServiceBase ( const ODServiceBase & )

privatedelete

ODServiceBase::ODServiceBase ( ODServiceBase && )

privatedelete

Member Function Documentation

void ODServiceBase::appClosingCB ( CallBacker * )

private

virtual void ODServiceBase::closeApp ( )

protectedvirtual

Reimplemented in uiODServiceMgr, and uiODService.

void ODServiceBase::connClosedCB ( CallBacker * )

private

uiRetVal ODServiceBase::doAction ( const OD::JSON::Object & )

private

virtual void ODServiceBase::doAppClosing ( CallBacker * )

protectedvirtual

Reimplemented in uiODServiceMgr, ODBatchService, and uiODService.

virtual void ODServiceBase::doConnClosed ( CallBacker * )

inlineprotectedvirtual

virtual bool ODServiceBase::doParseAction	(	const char *	,
		uiRetVal &
	)

protectedvirtual

Return true if the action was handled.

Reimplemented in uiODServiceMgr, uiODService, and ODBatchService.

virtual bool ODServiceBase::doParseRequest	(	const OD::JSON::Object &	,
		uiRetVal &
	)

protectedvirtual

Return true if the request was handled.

Reimplemented in uiODServiceMgr, and uiODService.

uiRetVal ODServiceBase::doPrepareForClose ( )

private

virtual void ODServiceBase::doPyEnvChange ( CallBacker * )

inlineprotectedvirtual

Reimplemented in uiODServiceMgr, and uiODService.

uiRetVal ODServiceBase::doRequest ( const OD::JSON::Object & )

private

virtual void ODServiceBase::doSurveyChanged ( CallBacker * )

inlineprotectedvirtual

Reimplemented in uiODServiceMgr.

void ODServiceBase::externalActionCB ( CallBacker * )

private

void ODServiceBase::externalRequestCB ( CallBacker * )

private

Network::Authority ODServiceBase::getAuthority ( ) const

private

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

staticprotected

static const OD::JSON::Object* ODServiceBase::getSubObj	(	const OD::JSON::Object &	,
		const char *	key
	)

staticprotected

bool ODServiceBase::isMainService ( ) const

protected

mODTextTranslationClass (ODServiceBase) public bool ODServiceBase::isOK ( ) const

private

void ODServiceBase::newConnectionCB ( CallBacker * )

private

ODServiceBase& ODServiceBase::operator= ( const ODServiceBase & )

privatedelete

ODServiceBase& ODServiceBase::operator= ( ODServiceBase && )

privatedelete

void ODServiceBase::packetArrivedCB ( CallBacker * )

private

void ODServiceBase::pyenvChangeCB ( CallBacker * )

private

uiRetVal ODServiceBase::pythEnvChangedReq ( const OD::JSON::Object & )

private

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

staticprotected

void ODServiceBase::sendErr ( uiRetVal & )

protected

void ODServiceBase::sendOK ( )

protected

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

staticprotected

Reimplement these functions to intercept packets intended for your service

void ODServiceBase::setRetVal ( const uiRetVal & uirv )

inlineprivate

static const char* ODServiceBase::sKeyAction ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyCloseEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyDeregister ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyError ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyEvent ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyHideEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyODServer ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyOK ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyProcessingDone ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyPyEnvChangeEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyRaiseEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyRegister ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyStart ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyStatusEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeySurveyChangeEv ( )

inlinestaticprivate

static const char* ODServiceBase::sKeyTransferCmplt ( )

inlinestaticprivate

virtual void ODServiceBase::startServer ( PortNr_Type )

privatevirtual

virtual void ODServiceBase::stopServer ( )

privatevirtual

uiRetVal ODServiceBase::survChangedReq ( const OD::JSON::Object & )

private

void ODServiceBase::surveyChangedCB ( CallBacker * )

private

static ODServiceBase* ODServiceBase::theMain ( ODServiceBase * newmain = nullptr )

staticprivate

Member Data Documentation

Network::RequestConnection* ODServiceBase::conn_ = nullptr

private

CNotifier<ODServiceBase,BufferString> ODServiceBase::externalAction

private

CNotifier<ODServiceBase,const OD::JSON::Object*> ODServiceBase::externalRequest

private

bool ODServiceBase::needclose_ = false

private

PtrMan<Network::RequestPacket> ODServiceBase::packet_

private

Network::RequestServer* ODServiceBase::server_ = nullptr

private

bool ODServiceBase::serverismine_ = true

private

uiRetVal ODServiceBase::uirv_

private

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation