The gateway for dmt client communications. More...

Inheritance diagram for dtm.ClientInterfaceService.ClientInterfaceService:

Collaboration diagram for dtm.ClientInterfaceService.ClientInterfaceService:

Public Member Functions
def	__init__ (self, configParser, connectBuilderLight)
	constructor initialise all connections and event handlers More...

def	onTaskManagerRoute (self, event)
	handler to route all event to TaksManager More...

def	onEEManagerRoute (self, event)
	handler to route all event to EEManager More...

def	onDTMClientRoute (self, event)
	handler to route all response event to DTMClient More...

def	registreEvent (self, event)
	add event in map of processing events More...

def	getRequestEvent (self, event)
	get request event from processEvents map More...

def	unregisteEvent (self, event)
	delete event in map of processing events More...

Public Member Functions inherited from app.BaseServerManager.BaseServerManager
def	__init__ (self, poller_manager=None, admin_connection=None, conectionLightBuilder=None, exceptionForward=False, dumpStatVars=True)
	constructor More...

def	addConnection (self, name, connection)

def	setEventHandler (self, eventType, handler)
	set event handler rewrite the current handler for eventType More...

def	send (self, connect_name, event)
	send event More...

def	reply (self, event, reply_event)
	wrapper for sending event in reply for event More...

def	poll (self)
	poll function polling connections receive as multipart msg, the second argument is pickled pyobj More...

def	process (self, event)
	process event call the event handler method that was set by user or on_unhandled_event method if not set More...

def	run (self)

def	is_connection_registered (self, name)
	check is a connection was registered in a instance of BaseServerManager i object More...

def	on_poll_timeout (self)
	function will call every time when ConnectionTimeout exception arrive More...

def	on_unhandled_event (self, event)
	function will call every time when arrive doesn't set handler for event type of event.evenType More...

def	build_poller_list (self)

def	clear_poller (self)

def	onAdminState (self, event)
	onAdminState event handler process admin SHUTDOWN command More...

def	onAdminFetchStatData (self, event)
	onAdminState event handler process admin command More...

def	onAdminSuspend (self, event)
	onAdminState event handler process admin command More...

def	getStatDataFields (self, fields)
	getStatDataFields returns stat data from storage More...

def	getSystemStat (self)
	getSystemStat returns stat data for system indicators: RAMV, RAMR and CPU More...

def	getConfigVarsFields (self, fields)
	getConfigVarsFields returns config vars from storage More...

def	onAdminGetConfigVars (self, event)
	onAdminGetConfigVars event handler process getConfigVars admin command, fill and return config vars array from internal storage More...

def	onAdminSetConfigVars (self, event)
	onAdminSetConfigVars event handler process setConfigVars admin command More...

def	setConfigVars (self, setConfigVars)
	processSetConfigVars sets config vars in storage More...

def	sendAdminReadyEvent (self)
	send ready event to notify adminInterfaceService More...

def	createLogMsg (self, event)
	from string message from event object More...

def	initStatFields (self, connect_name)
	add record in statFields More...

def	updateStatField (self, field_name, value, operation=STAT_FIELDS_OPERATION_ADD)
	update values of stat field - default sum More...

def	processSpecialConfigVars (self, name, value)
	send ready event to notify adminInterfaceService More...

def	getLogLevel (self)
	Get log level from first of existing loggers. More...

def	setLogLevel (self, level)
	Set log level for all loggers. More...

def	saveStatVarsDump (self)
	Save stat vars in json file. More...

def	loadStatVarsDump (self)
	Load stat vars in json file. More...

def	getStatVarsDumpFileName (self)
	Get stat vars file name. More...

def	createDBIDict (self, configParser)

Public Attributes
	beforeStop

	cfg_section

	processEvents

Public Attributes inherited from app.BaseServerManager.BaseServerManager
	dumpStatVars

	poller_manager

	eventBuilder

	exit_flag

	pollTimeout

	connections

	event_handlers

	statFields
	stat fields container More...

	configVars

	exceptionForward

Static Public Attributes
string	SERVER_TCP = "server_tcp"

string	SERVER_INPROC = "server"

string	CONFIG_SERVER_HOST = "serverHost"

string	CONFIG_SERVER_PORT = "serverPort"

string	TASKS_MANAGER_CLIENT = "clientTasksManager"

string	EXECUTION_ENVIRONMENT_MANAGER_CLINET = "clientExecutionEnvironmentManager"

Static Public Attributes inherited from app.BaseServerManager.BaseServerManager
string	ADMIN_CONNECT_ENDPOINT = "Admin"

string	ADMIN_CONNECT_CLIENT = "Admin"

int	POLL_TIMEOUT_DEFAULT = 3000

int	STAT_FIELDS_OPERATION_ADD = 0

int	STAT_FIELDS_OPERATION_SUB = 1

int	STAT_FIELDS_OPERATION_SET = 2

int	STAT_FIELDS_OPERATION_INIT = 3

string	POLL_TIMEOUT_CONFIG_VAR_NAME = "POLL_TIMEOUT"

string	LOG_LEVEL_CONFIG_VAR_NAME = "LOG_LEVEL"

string	STAT_DUMPS_DEFAULT_DIR = "/tmp/"

string	STAT_DUMPS_DEFAULT_NAME = "%APP_NAME%_%CLASS_NAME%_stat_vars.dump"

dictionary	LOGGERS_NAMES = {APP_CONSTS.LOGGER_NAME, "dc", "dtm", "root", ""}

Detailed Description

The gateway for dmt client communications.

Definition at line 24 of file ClientInterfaceService.py.

Constructor & Destructor Documentation

◆ init()

def dtm.ClientInterfaceService.ClientInterfaceService.__init__	(	self,
		configParser,
		connectBuilderLight
	)

constructor initialise all connections and event handlers

Parameters

configParser	config parser object
connectBuilderLight	instance of ConnectBuilderLight object Constructor

Definition at line 38 of file ClientInterfaceService.py.

   def __init__(self, configParser, connectBuilderLight):
     '''
     Constructor
     '''
     super(ClientInterfaceService, self).__init__()
 
     self.beforeStop = False
     self.cfg_section = self.__class__.__name__
 
     serverAddrInproc = configParser.get(self.cfg_section, self.SERVER_INPROC)
     serverHost = configParser.get(CONFIG_SECTION, self.CONFIG_SERVER_HOST)
     serverPort = configParser.get(CONFIG_SECTION, self.CONFIG_SERVER_PORT)
     serverAddrTcp = serverHost + ":" + str(serverPort)
     clientTaskManager = configParser.get(CONFIG_SECTION, self.TASKS_MANAGER_CLIENT)
     clientExecutionEnvironmentManager = configParser.get(CONFIG_SECTION, self.EXECUTION_ENVIRONMENT_MANAGER_CLINET)
 
     serverConnectionInproc = connectBuilderLight.build(consts.SERVER_CONNECT, serverAddrInproc)
     serverConnectionTcp = connectBuilderLight.build(consts.SERVER_CONNECT, serverAddrTcp, consts.TCP_TYPE)
     taskManagerConnection = connectBuilderLight.build(consts.CLIENT_CONNECT, clientTaskManager)
     eeManagerConnection = connectBuilderLight.build(consts.CLIENT_CONNECT, clientExecutionEnvironmentManager)
 
     self.addConnection(self.SERVER_TCP, serverConnectionTcp)
     self.addConnection(self.SERVER_INPROC, serverConnectionInproc)
     self.addConnection(self.TASKS_MANAGER_CLIENT, taskManagerConnection)
     self.addConnection(self.EXECUTION_ENVIRONMENT_MANAGER_CLINET, eeManagerConnection)
 
     self.setEventHandler(EVENT_TYPES.NEW_TASK, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.UPDATE_TASK, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.GET_TASK_STATUS, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.FETCH_RESULTS_CACHE, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.DELETE_TASK, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.UPDATE_TASK_FIELDS, self.onTaskManagerRoute)
     self.setEventHandler(EVENT_TYPES.FETCH_AVAILABLE_TASK_IDS, self.onTaskManagerRoute)
 
     self.setEventHandler(EVENT_TYPES.CHECK_TASK_STATE, self.onEEManagerRoute)
     self.setEventHandler(EVENT_TYPES.FETCH_TASK_RESULTS, self.onEEManagerRoute)
     self.setEventHandler(EVENT_TYPES.DELETE_TASK_RESULTS, self.onEEManagerRoute)
 
     self.setEventHandler(EVENT_TYPES.NEW_TASK_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.UPDATE_TASK_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.CHECK_TASK_STATE_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.GET_TASK_STATUS_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.FETCH_TASK_RESULTS_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.DELETE_TASK_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.DELETE_TASK_RESULTS_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.UPDATE_TASK_FIELDS_RESPONSE, self.onDTMClientRoute)
     self.setEventHandler(EVENT_TYPES.AVAILABLE_TASK_IDS_RESPONSE, self.onDTMClientRoute)
 
     #map of incoming event, which are in processing
     # event.uid => event without eventObj field
     self.processEvents = dict()
 
 

Member Function Documentation

◆ getRequestEvent()

def dtm.ClientInterfaceService.ClientInterfaceService.getRequestEvent	(	self,
		event
	)

get request event from processEvents map

Parameters

event instance of Event object

Returns: event instance of Event object

Definition at line 138 of file ClientInterfaceService.py.

   def getRequestEvent(self, event):
     return self.processEvents[event.uid]

Here is the caller graph for this function:

◆ onDTMClientRoute()

def dtm.ClientInterfaceService.ClientInterfaceService.onDTMClientRoute	(	self,
		event
	)

handler to route all response event to DTMClient

Parameters

even	instance of Event object

Definition at line 118 of file ClientInterfaceService.py.

   def onDTMClientRoute(self, event):
     try:
       request_event = self.getRequestEvent(event)
       self.reply(request_event, event)
       self.unregisteEvent(request_event)
     except KeyError as err:
       logger.error(str(err.message))
 
 

Here is the call graph for this function:

◆ onEEManagerRoute()

def dtm.ClientInterfaceService.ClientInterfaceService.onEEManagerRoute	(	self,
		event
	)

handler to route all event to EEManager

Parameters

even	instance of Event object

Definition at line 110 of file ClientInterfaceService.py.

   def onEEManagerRoute(self, event):
     self.send(self.EXECUTION_ENVIRONMENT_MANAGER_CLINET, event)
     self.registreEvent(event)
 
 

Here is the call graph for this function:

◆ onTaskManagerRoute()

def dtm.ClientInterfaceService.ClientInterfaceService.onTaskManagerRoute	(	self,
		event
	)

handler to route all event to TaksManager

Parameters

even	instance of Event object

Definition at line 94 of file ClientInterfaceService.py.

   def onTaskManagerRoute(self, event):
     if not self.beforeStop:
       if event.eventType == EVENT_TYPES.DELETE_TASK and event.eventObj.deleteTaskId == DeleteTask.GROUP_DELETE:
         self.beforeStop = True
       self.send(self.TASKS_MANAGER_CLIENT, event)
       self.registreEvent(event)
     else:
       defaultObject = GeneralResponse(GeneralResponse.ERROR_OK, "DTM in prestopped state")
       responseEvent = self.eventBuilder.build(EVENT_TYPES.GENERAL_RESPONSE, defaultObject)
       self.reply(event, responseEvent)
 
 
 

Here is the call graph for this function:

◆ registreEvent()

def dtm.ClientInterfaceService.ClientInterfaceService.registreEvent	(	self,
		event
	)

add event in map of processing events

Parameters

even	instance of Event object

Definition at line 130 of file ClientInterfaceService.py.

   def registreEvent(self, event):
     event.eventObj = None
     self.processEvents[event.uid] = event
 
 

Here is the caller graph for this function:

◆ unregisteEvent()

def dtm.ClientInterfaceService.ClientInterfaceService.unregisteEvent	(	self,
		event
	)

delete event in map of processing events

Parameters

even	instance of Event object

Definition at line 145 of file ClientInterfaceService.py.

145 def unregisteEvent(self, event):

146 del self.processEvents[event.uid]

147

Here is the caller graph for this function:

Member Data Documentation

◆ beforeStop

dtm.ClientInterfaceService.ClientInterfaceService.beforeStop

Definition at line 44 of file ClientInterfaceService.py.

◆ cfg_section

dtm.ClientInterfaceService.ClientInterfaceService.cfg_section

Definition at line 45 of file ClientInterfaceService.py.

◆ CONFIG_SERVER_HOST

string dtm.ClientInterfaceService.ClientInterfaceService.CONFIG_SERVER_HOST = "serverHost"

static

Definition at line 28 of file ClientInterfaceService.py.

◆ CONFIG_SERVER_PORT

string dtm.ClientInterfaceService.ClientInterfaceService.CONFIG_SERVER_PORT = "serverPort"

static

Definition at line 29 of file ClientInterfaceService.py.

◆ EXECUTION_ENVIRONMENT_MANAGER_CLINET

string dtm.ClientInterfaceService.ClientInterfaceService.EXECUTION_ENVIRONMENT_MANAGER_CLINET = "clientExecutionEnvironmentManager"

static

Definition at line 31 of file ClientInterfaceService.py.

◆ processEvents

dtm.ClientInterfaceService.ClientInterfaceService.processEvents

Definition at line 88 of file ClientInterfaceService.py.

◆ SERVER_INPROC

string dtm.ClientInterfaceService.ClientInterfaceService.SERVER_INPROC = "server"

static

Definition at line 27 of file ClientInterfaceService.py.

◆ SERVER_TCP

string dtm.ClientInterfaceService.ClientInterfaceService.SERVER_TCP = "server_tcp"

static

Definition at line 26 of file ClientInterfaceService.py.

◆ TASKS_MANAGER_CLIENT

string dtm.ClientInterfaceService.ClientInterfaceService.TASKS_MANAGER_CLIENT = "clientTasksManager"

static

Definition at line 30 of file ClientInterfaceService.py.

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

sources/hce/dtm/ClientInterfaceService.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getRequestEvent()

◆ onDTMClientRoute()

◆ onEEManagerRoute()

◆ onTaskManagerRoute()

◆ registreEvent()

◆ unregisteEvent()

Member Data Documentation

◆ beforeStop

◆ cfg_section

◆ CONFIG_SERVER_HOST

◆ CONFIG_SERVER_PORT

◆ EXECUTION_ENVIRONMENT_MANAGER_CLINET

◆ processEvents

◆ SERVER_INPROC

◆ SERVER_TCP

◆ TASKS_MANAGER_CLIENT

◆ init()