Source code for pyrogue.interfaces._ZmqServer

#-----------------------------------------------------------------------------
# Company    : SLAC National Accelerator Laboratory
#-----------------------------------------------------------------------------
#  Description:
#       PyRogue ZMQ Server
#-----------------------------------------------------------------------------
# This file is part of the rogue software platform. It is subject to
# the license terms in the LICENSE.txt file found in the top-level directory
# of this distribution and at:
#    https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html.
# No part of the rogue software platform, including this file, may be
# copied, modified, propagated, or distributed except according to the terms
# contained in the LICENSE.txt file.
#-----------------------------------------------------------------------------

import rogue.interfaces
import pickle
import json




class ZmqServer(rogue.interfaces.ZmqServer):

    def __init__(self,*,root,addr,port,incGroups=None, excGroups=['NoServe']):
        rogue.interfaces.ZmqServer.__init__(self,addr,port)
        self._root = root
        self._addr = addr
        self._root.addVarListener(func=self._varUpdate, done=self._varDone, incGroups=incGroups, excGroups=excGroups)
        self._updateList = {}

    @property
    def address(self):
        if self._addr == "*":
            return f"127.0.0.1:{self.port()}"
        else:
            return f"{self._addr}:{self.port()}"

    def _doOperation(self,d):
        path    = d['path']   if 'path'   in d else None
        attr    = d['attr']   if 'attr'   in d else None
        args    = d['args']   if 'args'   in d else ()
        kwargs  = d['kwargs'] if 'kwargs' in d else {}

        # Special case to get root node
        if path == "__ROOT__":
            return self._root

        node = self._root.getNode(path)

        if node is None:
            return None

        nAttr = getattr(node, attr)

        if nAttr is None:
            return None
        elif callable(nAttr):
            return nAttr(*args,**kwargs)
        else:
            return nAttr

    def _doRequest(self,data):
        try:
            return pickle.dumps(self._doOperation(pickle.loads(data)))
        except Exception as msg:
            return pickle.dumps(msg)

    def _doString(self,data):
        try:
            d = json.loads(data)
            if 'args' in d:
                d['args'] = tuple(d['args'])
            return str(self._doOperation(d))
        except Exception as msg:
            return "EXCEPTION: " + str(msg)

    def _varUpdate(self, path, value):
        self._updateList[path] = value

    def _varDone(self):
        if len(self._updateList) > 0:
            self._publish(pickle.dumps(self._updateList))
            self._updateList = {}

    def _start(self):
        rogue.interfaces.ZmqServer._start(self)
        print(f"Start: Started zmqServer on ports {self.port()}-{self.port()+2}")
        print(f"    To start a gui: python -m pyrogue gui --server='localhost:{self.port()}'")
        print(f"    To use a virtual client: client = pyrogue.interfaces.VirtualClient(addr='localhost', port={self.port()})")