microscope.win32.MicroscopeWindowsService Class Reference

Inheritance diagram for microscope.win32.MicroscopeWindowsService:

Public Member Functions
def	set_config_file (cls, path)
def	get_config_file (cls)
def	log (self, message, error=False)
def	__init__ (self, args)
def	SvcDoRun (self)
def	SvcStop (self)

Public Attributes
	stop_event

Detailed Description

Serves microscope devices via a Windows service.

Win32 service manipulation relies on fetching _svc_name_ without
instantiating any object, so _svc_name_ must be a class
attribute. This means that only one MicroscopeService may be
installed on any one system, and will be responsible for serving
all microscope devices on that system.

Definition at line 55 of file win32.py.

Constructor & Destructor Documentation

__init__()

def microscope.win32.MicroscopeWindowsService.__init__	(		self,
			args
	)

Definition at line 88 of file win32.py.

    def __init__(self, args):
        # Initialise service framework.
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.stop_event = multiprocessing.Event()
 

Member Function Documentation

get_config_file()

def microscope.win32.MicroscopeWindowsService.get_config_file

(

cls

)

Definition at line 76 of file win32.py.

    def get_config_file(cls):
        return win32serviceutil.GetServiceCustomOption(
            cls._svc_name_, "config"
        )
 

log()

def microscope.win32.MicroscopeWindowsService.log	(		self,
			message,
			error = False
	)

Definition at line 81 of file win32.py.

    def log(self, message, error=False):
        if error:
            logFunc = servicemanager.LogErrorMsg
        else:
            logFunc = servicemanager.LogInfoMsg
        logFunc("%s: %s" % (self._svc_name_, message))
 

set_config_file()

def microscope.win32.MicroscopeWindowsService.set_config_file	(		cls,
			path
	)

Definition at line 70 of file win32.py.

    def set_config_file(cls, path):
        win32serviceutil.SetServiceCustomOption(
            cls._svc_name_, "config", os.path.abspath(path)
        )
 

SvcDoRun()

def microscope.win32.MicroscopeWindowsService.SvcDoRun

(

self

)

Definition at line 93 of file win32.py.

    def SvcDoRun(self):
        configfile = win32serviceutil.GetServiceCustomOption(
            self._svc_name_, "config"
        )
        os.chdir(os.path.dirname(configfile))
        self.log("Using config file %s." % configfile)
        self.log("Logging at %s." % os.getcwd())
        self.ReportServiceStatus(win32service.SERVICE_RUNNING)
 
        from microscope.device_server import (
            serve_devices,
            validate_devices,
            DeviceServerOptions,
        )
 
        options = DeviceServerOptions(
            config_fpath=configfile,
            logging_level=logging.INFO,
        )
 
        try:
            devices = validate_devices(configfile)
            serve_devices(devices, options, self.stop_event)
        except Exception as e:
            servicemanager.LogErrorMsg(str(e))
            # Exit with non-zero error code so Windows will attempt to restart.
            sys.exit(-1)
        self.log("Service shutdown complete.")
        self.ReportServiceStatus(win32service.SERVICE_STOPPED)
 

SvcStop()

def microscope.win32.MicroscopeWindowsService.SvcStop

(

self

)

Definition at line 123 of file win32.py.

    def SvcStop(self):
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        self.stop_event.set()
 
 

Member Data Documentation

stop_event

microscope.win32.MicroscopeWindowsService.stop_event

Definition at line 91 of file win32.py.

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/win32.py