UM.Backend.Backend.Backend Class Reference

Inheritance diagram for UM.Backend.Backend.Backend:

Public Member Functions
	__init__ (self)
	setState (self, new_state)
	startEngine (self)
	close (self)
	getLog (self)
	getEngineCommand (self)
Public Member Functions inherited from UM.PluginObject.PluginObject
None	__init__ (self, *args, **kwags)
str	getId (self)
None	setPluginId (self, str plugin_id)
None	setMetaData (self, Dict[str, Any] metadata)
Dict[str, Any]	getMetaData (self)
str	getPluginId (self)
None	setVersion (self, str version)
str	getVersion (self)

Static Public Attributes
	processingProgress = Signal()
	backendStateChange = Signal()
	backendConnected = Signal()
	backendQuit = Signal()
	backendDone = Signal()

Protected Member Functions
	_backendLog (self, line)
Optional[subprocess.Popen]	_runEngineProcess (self, command_list)
	_storeOutputToLogThread (self, handle)
	_storeStderrToLogThread (self, handle)
	_onSocketStateChanged (self, state)
	_logSocketState (self, state)
	_onMessageReceived (self)
	_onSocketError (self, error)
	_createSocket (self, protocol_file)

Protected Attributes
	_supported_commands
	_message_handlers
	_socket
	_port
	_process
	_backend_log
	_backend_log_max_lines
	_backend_state
	_createSocket
	_onSocketStateChanged
	_onMessageReceived
	_onSocketError
Protected Attributes inherited from UM.PluginObject.PluginObject
	_plugin_id
	_version
	_metadata
	_name

Detailed Description

Base class for any backend communication (separate piece of software).
It makes use of the Socket class from libArcus for the actual communication bits.
The message_handlers dict should be filled with string (full name of proto message), function pairs.

Constructor & Destructor Documentation

__init__()

UM.Backend.Backend.Backend.__init__

(

self

)

Reimplemented from UM.PluginObject.PluginObject.

Member Function Documentation

_createSocket()

UM.Backend.Backend.Backend._createSocket (   self,   protocol_file  )

protected

Creates a socket and attaches listeners.

_logSocketState()

UM.Backend.Backend.Backend._logSocketState (   self,   state  )

protected

Debug function created to provide more info for CURA-2127

_onMessageReceived()

UM.Backend.Backend.Backend._onMessageReceived (   self )

protected

Private message handler

_onSocketError()

UM.Backend.Backend.Backend._onSocketError (   self,   error  )

protected

Private socket error handler

_onSocketStateChanged()

UM.Backend.Backend.Backend._onSocketStateChanged (   self,   state  )

protected

Private socket state changed handler.

_runEngineProcess()

Optional[subprocess.Popen] UM.Backend.Backend.Backend._runEngineProcess (   self,   command_list  )

protected

Start the (external) backend process.

getEngineCommand()

UM.Backend.Backend.Backend.getEngineCommand

(

self

)

Get the command used to start the backend executable 

getLog()

UM.Backend.Backend.Backend.getLog

(

self

)

Get the logging messages of the backend connection.

startEngine()

UM.Backend.Backend.Backend.startEngine

(

self

)

:brief Start the backend / engine.
Runs the engine, this is only called when the socket is fully opened & ready to accept connections

---

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

• UM/Backend/Backend.py