microscope.win32.MicroscopeWindowsService Class Reference

Inheritance diagram for microscope.win32.MicroscopeWindowsService:

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

Public Attributes
	stop_event = multiprocessing.Event()

Static Protected Attributes
str	_svc_name_ = "MicroscopeService"
str	_svc_display_name_ = "Microscope device servers"
str	_svc_description_ = "Serves microscope devices."

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__()

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()

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()

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()

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()

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()

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

_svc_description_

str microscope.win32.MicroscopeWindowsService._svc_description_ = "Serves microscope devices."

staticprotected

Definition at line 67 of file win32.py.

_svc_display_name_

str microscope.win32.MicroscopeWindowsService._svc_display_name_ = "Microscope device servers"

staticprotected

Definition at line 66 of file win32.py.

_svc_name_

microscope.win32.MicroscopeWindowsService._svc_name_ = "MicroscopeService"

staticprotected

Definition at line 65 of file win32.py.

stop_event

microscope.win32.MicroscopeWindowsService.stop_event = multiprocessing.Event()

Definition at line 91 of file win32.py.

---

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

• BioImager/PythonMicroscope/microscope/win32.py