Qudi
Public Member Functions | Public Attributes | List of all members
core.remote.RemoteObjectManager Class Reference

This shares modules with other computers and is responsible for obtaining modules shared by other computer. More...

Inheritance diagram for core.remote.RemoteObjectManager:
Inheritance graph
[legend]
Collaboration diagram for core.remote.RemoteObjectManager:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, manager, kwargs)
 Handle sharing and getting shared modules.
 
def makeRemoteService (self)
 A function that returns a class containing a module list hat can be manipulated from the host.
 
def createServer (self, hostname, port, certfile=None, keyfile=None)
 Start the rpyc modules server on a given port. More...
 
def stopServer (self)
 Stop the remote module server.
 
def shareModule (self, name, obj)
 Add a module to the list of modules that can be accessed remotely. More...
 
def unshareModule (self, name)
 Remove a module from the shared module list. More...
 
def getRemoteModuleUrl (self, url, certfile=None, keyfile=None)
 Get a remote module via its URL. More...
 
def getRemoteModule (self, host, port, name, certfile=None, keyfile=None)
 Get a remote module via its host, port and name. More...
 

Public Attributes

 tm
 
 manager
 
 remoteModules
 
 sharedModules
 
 server
 

Detailed Description

This shares modules with other computers and is responsible for obtaining modules shared by other computer.

Member Function Documentation

◆ createServer()

def core.remote.RemoteObjectManager.createServer (   self,
  hostname,
  port,
  certfile = None,
  keyfile = None 
)

Start the rpyc modules server on a given port.

Parameters
intport: port where the server should be running

◆ getRemoteModule()

def core.remote.RemoteObjectManager.getRemoteModule (   self,
  host,
  port,
  name,
  certfile = None,
  keyfile = None 
)

Get a remote module via its host, port and name.

Parameters
strhost: host that the remote module server is running on
intport: port that the remote module server is listening on
strname: unique name of the remote module
strcertfile: filename of certificate or None if SSL is not used
strkeyfile: filename of key or None if SSL is not used
Returns
object: remote module

◆ getRemoteModuleUrl()

def core.remote.RemoteObjectManager.getRemoteModuleUrl (   self,
  url,
  certfile = None,
  keyfile = None 
)

Get a remote module via its URL.

Parameters
strurl: URL pointing to a module hosted b a remote server
strcertfile: filename of certificate or None if SSL is not used
strkeyfile: filename of key or None if SSL is not used
Returns
object: remote module

◆ shareModule()

def core.remote.RemoteObjectManager.shareModule (   self,
  name,
  obj 
)

Add a module to the list of modules that can be accessed remotely.

Parameters
strname: unique name that is used to access the module
objectobj: a reference to the module

◆ unshareModule()

def core.remote.RemoteObjectManager.unshareModule (   self,
  name 
)

Remove a module from the shared module list.

Parameters
strname: unique name of the module that should not be accessible any more

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