Server.ServerProxy Class Reference

Proxy class for a FeaturePython Server instance. More...

Inheritance diagram for Server.ServerProxy:

Public Member Functions
def	__init__ (self, fp)
	Initialization method for ServerProxy. More...
def	onDocumentRestored (self, fp)
	Method called when document is restored to make sure everything is as it was. More...
def	onDocumentClosed (self)
def	setProperties (self, fp)
	Method to set properties during initialization or document restoration. More...
def	__getstate__ (self)
	Necessary method to avoid errors when trying to save unserializable objects. More...
def	__setstate__ (self, state)
	Necessary method to avoid errors when trying to restore unserializable objects. More...

Static Public Attributes
	cmd_server = None
	A CommandServer instance to handle external commands. More...

Detailed Description

Proxy class for a FeaturePython Server instance.

A ServerProxy instance adds properties to a FeaturePython Server instance and responds to theirs changes. It provides a communication. CommandServer cmd_server when Running is set to True by double-clicking on it in the Tree View or right clicking and selecting Connect Server option from context menu. It closes the cmd_server when Running is set to False or an AnimateDocumentObserver detects that a document with Server instance is closing

Because communication.CommandServer cmd_server occupies a Port at selected Address, you cannot have duplicit Servers running simultaneously in a file, a FreeCAD window nor on one computer.

To connect this Proxy object to a FeaturePython Server do:

a = FreeCAD.ActiveDocument.addObject("App::FeaturePython", "Server")
ServerProxy(a)

Definition at line 71 of file Server.py.

Constructor & Destructor Documentation

__init__()

def Server.ServerProxy.__init__	(		self,
			fp
	)

Initialization method for ServerProxy.

A class instance is created and made a Proxy for a generic FeaturePython Server object. During initialization number of properties are specified and preset.

Parameters

fp	A barebone FeaturePython Server object to be extended.

Definition at line 88 of file Server.py.

    def __init__(self, fp):
        self.setProperties(fp)
        fp.Proxy = self

Member Function Documentation

__getstate__()

def Server.ServerProxy.__getstate__

(

self

)

Necessary method to avoid errors when trying to save unserializable objects.

This method is used by JSON to serialize unserializable objects during autosave. Without this an Error would rise when JSON would try to do that itself.

We need this for unserializable cmd_server attribute, but we don't serialize them, because it's enough to reset it when object is restored.

Returns

None, because we don't serialize anything.

Definition at line 201 of file Server.py.

    def __getstate__(self):
        return None

__setstate__()

def Server.ServerProxy.__setstate__	(		self,
			state
	)

Necessary method to avoid errors when trying to restore unserializable objects.

This method is used during a document restoration. We need this for unserializable cmd_server attribute, but we do not restore it, because it's enough to reset them from saved parameters.

Returns

None, because we don't restore anything.

Definition at line 214 of file Server.py.

    def __setstate__(self, state):
        return None

onDocumentRestored()

def Server.ServerProxy.onDocumentRestored	(		self,
			fp
	)

Method called when document is restored to make sure everything is as it was.

Reinitialization it creates properties and sets them to default values, if they were not restored automatically. It restarts a cmd_server if it was running when document was closed. Properties of connected ViewObject are also recreated and reset if necessary.

Parameters

fp	A restored FeaturePython Server object.

Definition at line 103 of file Server.py.

    def onDocumentRestored(self, fp):
        self.setProperties(fp)
        fp.ViewObject.Proxy.setProperties(fp.ViewObject)

setProperties()

def Server.ServerProxy.setProperties	(		self,
			fp
	)

Method to set properties during initialization or document restoration.

The properties are set if they are not already present. Constrained properties have their boundaries reset even if present, because constrains are not saved. Also cmd_server is restarted if it was running previously and an AnimateDocumentObserver is recreated.

Parameters

fp	A restored or barebone FeaturePython Server object.

Definition at line 131 of file Server.py.

    def setProperties(self, fp):
        # Check properties are present and create them if not
        if not hasattr(fp, "Address"):
            fp.addProperty("App::PropertyString", "Address", "Server settings",
                           "IP address where the server will listen for "
                           + "connection.\nValid values are IPv4 and "
                           + "IPv6 addresses or 'localhost'string."
                           ).Address = "localhost"
        if not hasattr(fp, "Port"):
            fp.addProperty("App::PropertyIntegerConstraint", "Port",
                           "Server settings", "Port where the server will "
                           + "listen for connections.\n" +
                           "Valid port numbers are in range <0 | 65535>,\n"
                           + "but some may be already taken!"
                           ).Port = (54321, 0, 65535, 1)
        else:
            fp.Port = (fp.Port, 0, 65535, 1)
        if not hasattr(fp, "Running"):
            fp.addProperty("App::PropertyBool", "Running", "Server settings",
                           "If Server Running is true, then Server listens "
                           + "for new connections."
                           ).Running = False

        # hide Placement property as there is nothing to display/move
        fp.setEditorMode("Placement", 2)
        # make Running property read-only as it's set from context menu/
        # by double clicking
        fp.setEditorMode("Running", 1)

        # try to start cmd_server, if it was running before closing
        if fp.Running:
            self.cmd_server = com.startServer(fp.Address, fp.Port)
            if self.cmd_server == com.SERVER_ERROR_INVALID_ADDRESS:
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "Server.png")
                QMessageBox.warning(None, 'Error while starting server',
                                    "The address was not in supported format.")
                fp.Running = False
            elif self.cmd_server == com.SERVER_ERROR_PORT_OCCUPIED:
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "Server.png")
                QMessageBox.warning(None, 'Error while starting server',
                                    "The port requested is already occupied.")
                fp.Running = False
            else:
                fp.setEditorMode("Address", 1)
                fp.setEditorMode("Port", 1)
                fp.Running = True
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "ServerRunning.png")

        # Make an document observer to be notified when document will be closed
        import AnimateDocumentObserver
        AnimateDocumentObserver.addObserver()
        FreeCAD.animate_observer.addServerToNotify(self,
                                                   FreeCAD.ActiveDocument.Name)

Member Data Documentation

cmd_server

Server.ServerProxy.cmd_server = None

static

A CommandServer instance to handle external commands.

Definition at line 76 of file Server.py.

---

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

• Doxypypy outputs/Server.py