This is app base class for management server connection end-points and parallel transport messages processing Provides main MOM transport for application architecture of parallel data processing. More...

Inheritance diagram for app.BaseServerManager.BaseServerManager:

[legend]

Collaboration diagram for app.BaseServerManager.BaseServerManager:

[legend]

Public Member Functions
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
	dumpStatVars

	poller_manager

	eventBuilder

	exit_flag

	pollTimeout

	connections

	event_handlers

	statFields
	stat fields container More...

	configVars

	exceptionForward

Static Public Attributes
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

This is app base class for management server connection end-points and parallel transport messages processing Provides main MOM transport for application architecture of parallel data processing.

Definition at line 38 of file BaseServerManager.py.

Constructor & Destructor Documentation

◆ init()

def app.BaseServerManager.BaseServerManager.__init__	(	self,
		poller_manager = `None`,
		admin_connection = `None`,
		conectionLightBuilder = `None`,
		exceptionForward = `False`,
		dumpStatVars = `True`
	)

constructor

Definition at line 59 of file BaseServerManager.py.

                dumpStatVars=True):
     threading.Thread.__init__(self)
 
     logger.info("Thread-based class instance constructor begin!")
 
     self.dumpStatVars = dumpStatVars
 
     if poller_manager is None:
       self.poller_manager = PollerManager()
     else:
       self.poller_manager = poller_manager
 
     self.eventBuilder = EventBuilder()
 
     self.exit_flag = False
     self.pollTimeout = self.POLL_TIMEOUT_DEFAULT
 
     #map {"name":connection}
     self.connections = dict()
     #map {event_type:handler}
     self.event_handlers = dict()
 
     
     self.statFields = dict()
     self.loadStatVarsDump()
 
     #Config fields container
     self.configVars = dict()
 
     #by default -add client admin connection
     conectLightBuilder = conectionLightBuilder
     admin_connect = admin_connection
     if conectLightBuilder is None:
       conectLightBuilder = ConnectionBuilderLight()
     if admin_connect is None:
       admin_connect = conectLightBuilder.build(trasnport_consts.CLIENT_CONNECT, self.ADMIN_CONNECT_ENDPOINT)
 
     self.addConnection(self.ADMIN_CONNECT_CLIENT, admin_connect)
     #Set event handler for ADMIN_STATE  event
     self.setEventHandler(EVENT_TYPES.ADMIN_STATE, self.onAdminState)
     self.setEventHandler(EVENT_TYPES.ADMIN_FETCH_STAT_DATA, self.onAdminFetchStatData)
     self.setEventHandler(EVENT_TYPES.ADMIN_GET_CONFIG_VARS, self.onAdminGetConfigVars)
     self.setEventHandler(EVENT_TYPES.ADMIN_SET_CONFIG_VARS, self.onAdminSetConfigVars)
     self.setEventHandler(EVENT_TYPES.ADMIN_SUSPEND, self.onAdminSuspend)
     self.sendAdminReadyEvent()
     #Set exception forwarding behavior, True - means forward exceptions farther, False - handle locally
     self.exceptionForward = exceptionForward
     #Init log level in config vars storage
     self.configVars[self.LOG_LEVEL_CONFIG_VAR_NAME] = self.getLogLevel()
     #Init start date in stat vars
     self.updateStatField(APP_CONSTS.START_DATE_NAME, datetime.now().__str__(), self.STAT_FIELDS_OPERATION_SET)
     logger.info("Thread-based class instance constructor end!")
 
 

Member Function Documentation

◆ addConnection()

def app.BaseServerManager.BaseServerManager.addConnection	(	self,
		name,
		connection
	)

Definition at line 116 of file BaseServerManager.py.

   def addConnection(self, name, connection):
     self.initStatFields(name)
     self.connections[name] = connection
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_poller_list()

def app.BaseServerManager.BaseServerManager.build_poller_list ( self )

Definition at line 294 of file BaseServerManager.py.

   def build_poller_list(self):
     for item in self.connections:
       self.poller_manager.add(self.connections[item], item)
 
 

Here is the caller graph for this function:

◆ clear_poller()

def app.BaseServerManager.BaseServerManager.clear_poller ( self )

Definition at line 299 of file BaseServerManager.py.

   def clear_poller(self):
     for item in self.connections:
       self.poller_manager.remove(self.connections[item])
 
 

Here is the caller graph for this function:

◆ createDBIDict()

def app.BaseServerManager.BaseServerManager.createDBIDict	(	self,
		configParser
	)

Definition at line 639 of file BaseServerManager.py.

   def createDBIDict(self, configParser):
     # get section
     return dict(configParser.items(DTM_CONSTS.DB_CONFIG_SECTION))
 

◆ createLogMsg()

def app.BaseServerManager.BaseServerManager.createLogMsg	(	self,
		event
	)

from string message from event object

Parameters

event instance of Event object

Returns: log string

Definition at line 493 of file BaseServerManager.py.

   def createLogMsg(self, event):
     logMsg = "event:\n" + str(vars(event)) + "\neventObj:\n"
     if event.eventObj and hasattr(event.eventObj, "__dict__"):
       logMsg = logMsg + str(vars(event.eventObj))
     else:
       logMsg = logMsg + str(event.eventObj)
     return logMsg
 
 
 

Here is the caller graph for this function:

◆ getConfigVarsFields()

def app.BaseServerManager.BaseServerManager.getConfigVarsFields	(	self,
		fields
	)

getConfigVarsFields returns config vars from storage

Parameters

fields list of requested fields names to get config vars, if empty or None - return all fields set

Definition at line 404 of file BaseServerManager.py.

   def getConfigVarsFields(self, fields):
     if len(fields) == 0 or "*" in fields:
       fields = self.configVars
     else:
       for field_name in fields:
         if field_name in self.configVars:
           fields[field_name] = self.configVars[field_name]
 
     return fields
 
 
 

Here is the caller graph for this function:

◆ getLogLevel()

def app.BaseServerManager.BaseServerManager.getLogLevel ( self )

Get log level from first of existing loggers.

Returns: log level

Definition at line 564 of file BaseServerManager.py.

   def getLogLevel(self):
     level = None
     for name in logging.Logger.manager.loggerDict.keys():
       if isinstance(logging.Logger.manager.loggerDict[name], logging.Logger) and name in self.LOGGERS_NAMES:
         level = logging.Logger.manager.loggerDict[name].getEffectiveLevel()
         break
       else:
         pass
 
     return level
 
 
 

◆ getStatDataFields()

def app.BaseServerManager.BaseServerManager.getStatDataFields	(	self,
		fields
	)

getStatDataFields returns stat data from storage

Parameters

fields list of requested fields names to get stat data, if empty or None - return all stat fields set

Definition at line 367 of file BaseServerManager.py.

   def getStatDataFields(self, fields):
     if len(fields) == 0:
       fields = self.statFields
     else:
       for field_name in fields:
         if field_name in self.statFields:
           fields[field_name] = self.statFields[field_name]
     if isinstance(fields, dict):
       fields.update(self.getSystemStat())
     return fields
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatVarsDumpFileName()

def app.BaseServerManager.BaseServerManager.getStatVarsDumpFileName ( self )

Get stat vars file name.

Definition at line 631 of file BaseServerManager.py.

   def getStatVarsDumpFileName(self):
     appName = os.path.splitext(os.path.basename(sys.argv[0]))[0]
     return self.STAT_DUMPS_DEFAULT_DIR + self.STAT_DUMPS_DEFAULT_NAME.replace("%APP_NAME%", appName).\
                                                                       replace("%CLASS_NAME%", self.__class__.__name__)
 
 

Here is the caller graph for this function:

◆ getSystemStat()

def app.BaseServerManager.BaseServerManager.getSystemStat ( self )

getSystemStat returns stat data for system indicators: RAMV, RAMR and CPU

Returns: dict of stat fields

Definition at line 383 of file BaseServerManager.py.

   def getSystemStat(self):
     fields = {'RAMV':0, 'RAMR':0, 'CPUU':0, 'CPUS':0, 'THREADS':0}
     try:
       py = psutil.Process(os.getpid())
       m = py.memory_info()
       fields['RAMV'] = m.vms
       fields['RAMR'] = m.rss
       c = py.cpu_times()
       fields['CPUU'] = c.user
       fields['CPUS'] = c.system
       fields['THREADS'] = py.num_threads()
     except Exception as e:
       del e
 
     return fields
 
 

Here is the caller graph for this function:

◆ initStatFields()

def app.BaseServerManager.BaseServerManager.initStatFields	(	self,
		connect_name
	)

add record in statFields

Parameters

connect_name mane of connection

Definition at line 506 of file BaseServerManager.py.

   def initStatFields(self, connect_name):
     if connect_name + "_send_cnt" not in self.statFields:
       self.statFields[connect_name + "_send_cnt"] = 0
     if connect_name + "_recv_cnt" not in self.statFields:
       self.statFields[connect_name + "_recv_cnt"] = 0
     if connect_name + "_send_bytes" not in self.statFields:
       self.statFields[connect_name + "_send_bytes"] = 0
     if connect_name + "_recv_bytes" not in self.statFields:
       self.statFields[connect_name + "_recv_bytes"] = 0
 
 
 

Here is the caller graph for this function:

◆ is_connection_registered()

def app.BaseServerManager.BaseServerManager.is_connection_registered	(	self,
		name
	)

check is a connection was registered in a instance of BaseServerManager i object

Parameters

name	connection name

Returns: True is connection was registered, else - False

Definition at line 272 of file BaseServerManager.py.

   def is_connection_registered(self, name):
     if name in self.connections:
       return True
     return False
 
 

Here is the caller graph for this function:

◆ loadStatVarsDump()

def app.BaseServerManager.BaseServerManager.loadStatVarsDump ( self )

Load stat vars in json file.

Definition at line 608 of file BaseServerManager.py.

   def loadStatVarsDump(self):
     if self.dumpStatVars:
       try:
         name = self.getStatVarsDumpFileName()
         if os.path.exists(name):
           with open(name, 'r') as f:            data = f.read()
             self.statFields = json.loads(str(data))
             #APP_CONSTS.START_DATE_NAME
             self.updateStatField(APP_CONSTS.START_DATE_NAME, datetime.now().__str__(), self.STAT_FIELDS_OPERATION_SET)
       except IOError as e:
         del e
       except Exception as err:
         try:
           ExceptionLog.handler(logger, err, "Error load stat vars from file `" + name + "`: ")
           logger.error(str(data))
         except IOError as e:
           del e
 
 
 
 

Here is the call graph for this function:

◆ on_poll_timeout()

def app.BaseServerManager.BaseServerManager.on_poll_timeout ( self )

function will call every time when ConnectionTimeout exception arrive

Definition at line 280 of file BaseServerManager.py.

   def on_poll_timeout(self):
     pass

Here is the caller graph for this function:

◆ on_unhandled_event()

def app.BaseServerManager.BaseServerManager.on_unhandled_event	(	self,
		event
	)

function will call every time when arrive doesn't set handler for event type of event.evenType

Parameters

event event which can't be processed

Definition at line 288 of file BaseServerManager.py.

   def on_unhandled_event(self, event):
     logStr = "Got UNHANDLED EVENT\n" + self.createLogMsg(event)
     logger.debug(logStr)
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onAdminFetchStatData()

def app.BaseServerManager.BaseServerManager.onAdminFetchStatData	(	self,
		event
	)

onAdminState event handler process admin command

Parameters

event instance of Event object

Definition at line 331 of file BaseServerManager.py.

   def onAdminFetchStatData(self, event):
     adminStatData = event.eventObj
     if adminStatData.className == self.__class__.__name__:
       adminStatData.fields = self.getStatDataFields(adminStatData.fields)
     else:
       err_msg = "Got wrong admin class name [" + adminStatData.className + "]"
       try:
         logger.error(err_msg + str(adminStatData.className))
       except IOError as e:
         del e
 
     responseEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_FETCH_STAT_DATA_RESPONSE, adminStatData)
     self.reply(event, responseEvent)
 
 
 

Here is the call graph for this function:

◆ onAdminGetConfigVars()

def app.BaseServerManager.BaseServerManager.onAdminGetConfigVars	(	self,
		event
	)

onAdminGetConfigVars event handler process getConfigVars admin command, fill and return config vars array from internal storage

Parameters

event instance of Event object

Definition at line 420 of file BaseServerManager.py.

   def onAdminGetConfigVars(self, event):
     getConfigVars = event.eventObj
     if getConfigVars.className == self.__class__.__name__:
       if len(getConfigVars.fields) > 0 and "*" not in getConfigVars.fields:
         for fieldName in getConfigVars.fields:
           if fieldName in self.configVars:
             getConfigVars.fields[fieldName] = self.configVars[fieldName]
           else:
             getConfigVars.fields[fieldName] = None
       else:
         getConfigVars.fields = self.configVars
     else:
       try:
         logger.error("Wrong admin class name [" + str(getConfigVars.className) + "]")
       except IOError as e:
         del e
 
     responseEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_FETCH_STAT_DATA_RESPONSE, getConfigVars)
     self.reply(event, responseEvent)
 
 
 

Here is the call graph for this function:

◆ onAdminSetConfigVars()

def app.BaseServerManager.BaseServerManager.onAdminSetConfigVars	(	self,
		event
	)

onAdminSetConfigVars event handler process setConfigVars admin command

Parameters

event instance of Event object

Definition at line 446 of file BaseServerManager.py.

   def onAdminSetConfigVars(self, event):
     setConfigVars = event.eventObj
     responseEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_FETCH_STAT_DATA_RESPONSE,
                                             self.setConfigVars(setConfigVars))
     self.reply(event, responseEvent)
 
 
 

Here is the call graph for this function:

◆ onAdminState()

def app.BaseServerManager.BaseServerManager.onAdminState	(	self,
		event
	)

onAdminState event handler process admin SHUTDOWN command

Parameters

event instance of Event object

Definition at line 308 of file BaseServerManager.py.

   def onAdminState(self, event):
     adminState = event.eventObj
     className = self.__class__.__name__
     response = AdminState(className, AdminState.STATE_SHUTDOWN)
     try:
       if adminState.command == AdminState.STATE_SHUTDOWN and adminState.className == className:
         logger.info("Has successfully shutdown!")
         self.exit_flag = True
       else:
         logger.error("Got unsupported admin command [" + str(adminState.command) + "] for " + str(adminState.className))
         response = AdminState(className, AdminState.STATE_ERROR)
     except IOError as e:
       del e
 
     responseEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_STATE_RESPONSE, response)
     self.reply(event, responseEvent)
 
 
 

Here is the call graph for this function:

◆ onAdminSuspend()

def app.BaseServerManager.BaseServerManager.onAdminSuspend	(	self,
		event
	)

onAdminState event handler process admin command

Parameters

event instance of Event object

Definition at line 351 of file BaseServerManager.py.

   def onAdminSuspend(self, event):
     responseObj = GeneralResponse(GeneralResponse.ERROR_OK, (">>> Suspend Processed " + str(self.__class__.__name__)))
 
     try:
       logger.debug(">>> SUSPEND BASE processed class=" + str(self.__class__.__name__))
     except IOError as e:
       del e
 
     responseEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_SUSPEND_RESPONSE, responseObj)
     self.reply(event, responseEvent)
 
 

Here is the call graph for this function:

◆ poll()

def app.BaseServerManager.BaseServerManager.poll ( self )

poll function polling connections receive as multipart msg, the second argument is pickled pyobj

Definition at line 167 of file BaseServerManager.py.

   def poll(self):
     connect_names = dict()
     timedout = False
 
     try:
       if self.POLL_TIMEOUT_CONFIG_VAR_NAME in self.configVars and \
          int(self.configVars[self.POLL_TIMEOUT_CONFIG_VAR_NAME]) > 0:
         timeout = int(self.configVars[self.POLL_TIMEOUT_CONFIG_VAR_NAME])
       else:
         timeout = self.pollTimeout
       #Try to poll all registered connections
       connect_names = self.poller_manager.poll(timeout)  # pylint: disable=R0204
     except ConnectionTimeout:
       timedout = True
     except TransportInternalErr as err:
       logger.error("ZMQ transport error: " + str(err.message))
     except IOError as e:
       del e
     except Exception as err:
       ExceptionLog.handler(logger, err, "Polling error:")
 
     if timedout is True:
       try:
         self.on_poll_timeout()
       except IOError as e:
         del e
       except EnvironmentError as e:
         del e
       except Exception as err:
         try:
           ExceptionLog.handler(logger, err, "Call of on_poll_timeout() error:")
         except IOError as e:
           del e
     else:
       #Read data from sockets of connections list returned
       for name in connect_names:
         try:
           if self.is_connection_registered(name):
             event = self.connections[name].recv()
             if isinstance(event, Response):
               #process data from Connection
               event = self.eventBuilder.build(EVENT_TYPES.SERVER_TCP_RAW, event)
             event.connect_name = name
             #Process received event
             self.process(event)
           else:
             logger.error("Unregistered connection [" + str(name) + "] network transport event!")
         except IOError as e:
           del e
         except EnvironmentError as e:
           del e
         except Exception as err:
           ExceptionLog.handler(logger, err, "Event processing error:")
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process()

def app.BaseServerManager.BaseServerManager.process	(	self,
		event
	)

process event call the event handler method that was set by user or on_unhandled_event method if not set

Parameters

event

Definition at line 226 of file BaseServerManager.py.

   def process(self, event):
     try:
       try:
         logger.debug("Got " + self.createLogMsg(event))
       except IOError as e:
         del e
 
       self.updateStatField(event.connect_name + "_recv_cnt", 1)
       self.updateStatField(event.connect_name + "_recv_bytes", sys.getsizeof(event))
       if event.eventType in self.event_handlers:
         self.event_handlers[event.eventType](event)
       else:
         self.on_unhandled_event(event)
     except IOError as e:
       del e
     except EnvironmentError as e:
       del e
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processSpecialConfigVars()

def app.BaseServerManager.BaseServerManager.processSpecialConfigVars	(	self,
		name,
		value
	)

send ready event to notify adminInterfaceService

Parameters

name
value

Definition at line 545 of file BaseServerManager.py.

   def processSpecialConfigVars(self, name, value):
     try:
       if name == self.LOG_LEVEL_CONFIG_VAR_NAME:
         #logger.setLevel(value)
         self.setLogLevel(value)
     except IOError as e:
       del e
     except Exception as err:
       try:
         ExceptionLog.handler(logger, err, "Exception:")
       except IOError as e:
         del e
 
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reply()

def app.BaseServerManager.BaseServerManager.reply	(	self,
		event,
		reply_event
	)

wrapper for sending event in reply for event

Parameters

event	reason event
reply_evenr	event sent in reply

Definition at line 157 of file BaseServerManager.py.

   def reply(self, event, reply_event):
     reply_event.uid = event.uid
     reply_event.connect_identity = event.connect_identity
     reply_event.cookie = event.cookie
     self.send(event.connect_name, reply_event)
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

def app.BaseServerManager.BaseServerManager.run ( self )

Definition at line 245 of file BaseServerManager.py.

   def run(self):
     while not self.exit_flag:
       try:
         self.build_poller_list()
         self.poll()
         self.clear_poller()
       except IOError as e:
         del e
       except Exception, e:
         try:
           logger.error("Unhandled exception in thread-based class : " + str(e.message) + "\n" + \
                        Utils.getTracebackInfo())
           if self.exceptionForward:
             logger.error("Exception forwarded.")
             raise e
         except IOError as e:
           del e
 
     self.saveStatVarsDump()
 
 
 

Here is the call graph for this function:

◆ saveStatVarsDump()

def app.BaseServerManager.BaseServerManager.saveStatVarsDump ( self )

Save stat vars in json file.

Definition at line 592 of file BaseServerManager.py.

   def saveStatVarsDump(self):
     if self.dumpStatVars:
       try:
         name = self.getStatVarsDumpFileName()
         with open(name, "w") as f:
           f.write(json.dumps(self.statFields, indent=4))
       except Exception as err:
         try:
           ExceptionLog.handler(logger, err, "Error save stat vars to file `" + name + "`: ")
         except IOError as e:
           del e
 
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

def app.BaseServerManager.BaseServerManager.send	(	self,
		connect_name,
		event
	)

send event

Parameters

connect_name	of of a connection to which event will be send
event	sending event

Definition at line 134 of file BaseServerManager.py.

   def send(self, connect_name, event):
     try:
       logger.debug("Send to " + str(connect_name) + "\n" + self.createLogMsg(event))
       if self.is_connection_registered(connect_name):
         self.connections[connect_name].send(event)
         self.updateStatField(connect_name + "_send_cnt", 1)
         self.updateStatField(connect_name + "_send_bytes", sys.getsizeof(event))
       else:
         logger.error("Unregistered connection [" + str(connect_name) + "] network transport event!")
     except IOError as e:
       del e
     except EnvironmentError as e:
       del e
     except Exception, err:
       logger.error("Error `%s`", str(err))
     except:  # pylint: disable=W0702
       pass
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendAdminReadyEvent()

def app.BaseServerManager.BaseServerManager.sendAdminReadyEvent ( self )

send ready event to notify adminInterfaceService

Definition at line 481 of file BaseServerManager.py.

   def sendAdminReadyEvent(self):
     className = self.__class__.__name__
     ready = AdminState(className, AdminState.STATE_READY)
     readyEvent = self.eventBuilder.build(EVENT_TYPES.ADMIN_STATE_RESPONSE, ready)
     self.send(self.ADMIN_CONNECT_CLIENT, readyEvent)
 
 
 

Here is the call graph for this function:

◆ setConfigVars()

def app.BaseServerManager.BaseServerManager.setConfigVars	(	self,
		setConfigVars
	)

processSetConfigVars sets config vars in storage

Parameters

setConfigVars instance of SetConfigVars object

Definition at line 458 of file BaseServerManager.py.

   def setConfigVars(self, setConfigVars):
     if setConfigVars.className == self.__class__.__name__:
       for fieldName in setConfigVars.fields:
         if fieldName in self.configVars:
           if type(self.configVars[fieldName]) == type(setConfigVars.fields[fieldName]):  # pylint: disable=C0123
             self.configVars[fieldName] = setConfigVars.fields[fieldName]
             self.processSpecialConfigVars(fieldName, setConfigVars.fields[fieldName])
           else:
             setConfigVars.fields[fieldName] = None
         else:
           self.configVars[fieldName] = setConfigVars.fields[fieldName]
     else:
       try:
         logger.error("Wrong admin class name [" + str(setConfigVars.className) + "]")
       except IOError as e:
         del e
 
     return setConfigVars
 
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEventHandler()

def app.BaseServerManager.BaseServerManager.setEventHandler	(	self,
		eventType,
		handler
	)

set event handler rewrite the current handler for eventType

Parameters

eventType	type of processed events
handler	handler to process events of eventType type

Definition at line 126 of file BaseServerManager.py.

   def setEventHandler(self, eventType, handler):
     self.event_handlers[eventType] = handler

◆ setLogLevel()

def app.BaseServerManager.BaseServerManager.setLogLevel	(	self,
		level
	)

Set log level for all loggers.

Parameters

level of logging

Returns: log level

Definition at line 581 of file BaseServerManager.py.

   def setLogLevel(self, level):
     for name in logging.Logger.manager.loggerDict.keys():
       if isinstance(logging.Logger.manager.loggerDict[name], logging.Logger) and name in self.LOGGERS_NAMES:
         logging.Logger.manager.loggerDict[name].setLevel(level)
     ll = logging.getLogger("")
     ll.setLevel(level)
 
 
 

Here is the caller graph for this function:

◆ updateStatField()

def app.BaseServerManager.BaseServerManager.updateStatField	(	self,
		field_name,
		value,
		operation = `STAT_FIELDS_OPERATION_ADD`
	)

update values of stat field - default sum

Parameters

field_name	name of updated field
value	value to summarize

Definition at line 522 of file BaseServerManager.py.

   def updateStatField(self, field_name, value, operation=STAT_FIELDS_OPERATION_ADD):
     if field_name in self.statFields:
       if operation == self.STAT_FIELDS_OPERATION_ADD:
         self.statFields[field_name] += int(value)
       elif operation == self.STAT_FIELDS_OPERATION_SUB:
         self.statFields[field_name] -= int(value)
       elif operation == self.STAT_FIELDS_OPERATION_SET:
         self.statFields[field_name] = value
     else:
       if operation == self.STAT_FIELDS_OPERATION_SET or operation == self.STAT_FIELDS_OPERATION_INIT:
         self.statFields[field_name] = value
       else:
         try:
           logger.error("Stat update: key is not valid " + field_name)
         except IOError as e:
           del e
 
 
 

Here is the caller graph for this function:

Member Data Documentation

◆ ADMIN_CONNECT_CLIENT

string app.BaseServerManager.BaseServerManager.ADMIN_CONNECT_CLIENT = "Admin"

static

Definition at line 40 of file BaseServerManager.py.

◆ ADMIN_CONNECT_ENDPOINT

string app.BaseServerManager.BaseServerManager.ADMIN_CONNECT_ENDPOINT = "Admin"

static

Definition at line 39 of file BaseServerManager.py.

◆ configVars

app.BaseServerManager.BaseServerManager.configVars

Definition at line 87 of file BaseServerManager.py.

◆ connections

app.BaseServerManager.BaseServerManager.connections

Definition at line 77 of file BaseServerManager.py.

◆ dumpStatVars

app.BaseServerManager.BaseServerManager.dumpStatVars

Definition at line 64 of file BaseServerManager.py.

◆ event_handlers

app.BaseServerManager.BaseServerManager.event_handlers

Definition at line 79 of file BaseServerManager.py.

◆ eventBuilder

app.BaseServerManager.BaseServerManager.eventBuilder

Definition at line 71 of file BaseServerManager.py.

◆ exceptionForward

app.BaseServerManager.BaseServerManager.exceptionForward

Definition at line 106 of file BaseServerManager.py.

◆ exit_flag

app.BaseServerManager.BaseServerManager.exit_flag

Definition at line 73 of file BaseServerManager.py.

◆ LOG_LEVEL_CONFIG_VAR_NAME

string app.BaseServerManager.BaseServerManager.LOG_LEVEL_CONFIG_VAR_NAME = "LOG_LEVEL"

static

Definition at line 49 of file BaseServerManager.py.

◆ LOGGERS_NAMES

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

static

Definition at line 54 of file BaseServerManager.py.

◆ POLL_TIMEOUT_CONFIG_VAR_NAME

string app.BaseServerManager.BaseServerManager.POLL_TIMEOUT_CONFIG_VAR_NAME = "POLL_TIMEOUT"

static

Definition at line 48 of file BaseServerManager.py.

◆ POLL_TIMEOUT_DEFAULT

int app.BaseServerManager.BaseServerManager.POLL_TIMEOUT_DEFAULT = 3000

static

Definition at line 41 of file BaseServerManager.py.

◆ poller_manager

app.BaseServerManager.BaseServerManager.poller_manager

Definition at line 67 of file BaseServerManager.py.

◆ pollTimeout

app.BaseServerManager.BaseServerManager.pollTimeout

Definition at line 74 of file BaseServerManager.py.

◆ STAT_DUMPS_DEFAULT_DIR

string app.BaseServerManager.BaseServerManager.STAT_DUMPS_DEFAULT_DIR = "/tmp/"

static

Definition at line 51 of file BaseServerManager.py.

◆ STAT_DUMPS_DEFAULT_NAME

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

static

Definition at line 52 of file BaseServerManager.py.

◆ STAT_FIELDS_OPERATION_ADD

int app.BaseServerManager.BaseServerManager.STAT_FIELDS_OPERATION_ADD = 0

static

Definition at line 43 of file BaseServerManager.py.

◆ STAT_FIELDS_OPERATION_INIT

int app.BaseServerManager.BaseServerManager.STAT_FIELDS_OPERATION_INIT = 3

static

Definition at line 46 of file BaseServerManager.py.

◆ STAT_FIELDS_OPERATION_SET

int app.BaseServerManager.BaseServerManager.STAT_FIELDS_OPERATION_SET = 2

static

Definition at line 45 of file BaseServerManager.py.

◆ STAT_FIELDS_OPERATION_SUB

int app.BaseServerManager.BaseServerManager.STAT_FIELDS_OPERATION_SUB = 1

static

Definition at line 44 of file BaseServerManager.py.

◆ statFields

app.BaseServerManager.BaseServerManager.statFields

stat fields container

Definition at line 83 of file BaseServerManager.py.

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

sources/hce/app/BaseServerManager.py

app
BaseServerManager
BaseServerManager
Generated on Fri Nov 24 2017 18:54:16 for HCE Project Python language Distributed Tasks Manager Application, Distributed Crawler Application and client API bindings. by 1.8.13

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ addConnection()

◆ build_poller_list()

◆ clear_poller()

◆ createDBIDict()

◆ createLogMsg()

◆ getConfigVarsFields()

◆ getLogLevel()

◆ getStatDataFields()

◆ getStatVarsDumpFileName()

◆ getSystemStat()

◆ initStatFields()

◆ is_connection_registered()

◆ loadStatVarsDump()

◆ on_poll_timeout()

◆ on_unhandled_event()

◆ onAdminFetchStatData()

◆ onAdminGetConfigVars()

◆ onAdminSetConfigVars()

◆ onAdminState()

◆ onAdminSuspend()

◆ poll()

◆ process()

◆ processSpecialConfigVars()

◆ reply()

◆ run()

◆ saveStatVarsDump()

◆ send()

◆ sendAdminReadyEvent()

◆ setConfigVars()

◆ setEventHandler()

◆ setLogLevel()

◆ updateStatField()

Member Data Documentation

◆ ADMIN_CONNECT_CLIENT

◆ ADMIN_CONNECT_ENDPOINT

◆ configVars

◆ connections

◆ dumpStatVars

◆ event_handlers

◆ eventBuilder

◆ exceptionForward

◆ exit_flag

◆ LOG_LEVEL_CONFIG_VAR_NAME

◆ LOGGERS_NAMES

◆ POLL_TIMEOUT_CONFIG_VAR_NAME

◆ POLL_TIMEOUT_DEFAULT

◆ poller_manager

◆ pollTimeout

◆ STAT_DUMPS_DEFAULT_DIR

◆ STAT_DUMPS_DEFAULT_NAME

◆ STAT_FIELDS_OPERATION_ADD

◆ STAT_FIELDS_OPERATION_INIT

◆ STAT_FIELDS_OPERATION_SET

◆ STAT_FIELDS_OPERATION_SUB

◆ statFields

◆ init()