commotion_client.utils.single_application.SingleApplicationWithMessaging Class Reference

Inheritance diagram for commotion_client.utils.single_application.SingleApplicationWithMessaging:

Public Member Functions
def	__init__
def	handle_message
def	send_message
def	process_message
Public Member Functions inherited from commotion_client.utils.single_application.SingleApplication
def	__init__
def	is_running

Additional Inherited Members
Public Attributes inherited from commotion_client.utils.single_application.SingleApplication
	log
	main
	status_bar
	control_panel
	shared_memory

Detailed Description

The interprocess messaging class for the Commotion Client. This class extends the single application to allow for instantiations of the Commotion Client to pass messages to the existing client if it is already running. When a second instance of a Commotion Client is run without a message specified it will reaise the earler clients main window to the front and then close itself.

e.g:
python3.3 CommotionClient.py --message "COMMAND"

Member Function Documentation

def commotion_client.utils.single_application.SingleApplicationWithMessaging.handle_message

(

self

)

Server side implementation of the messaging functions. This function waits for signals it receives and then emits a SIGNAL "messageAvailable" with the decoded message.

(Emits a signal instead of just calling a function in case we decide we would like to allow other components or extensions to listen for messages from new instances.)

References commotion_client.utils.single_application.SingleApplicationWithMessaging._timeout, commotion_client.GUI.menu_bar.MenuBar.translate, commotion_client.extensions.config_editor.main.ViewPort.translate, commotion_client.GUI.main_window.MainWindow.translate, commotion_client.GUI.toolbar_builder.ToolBar.translate, commotion_client.GUI.extension_toolbar.ExtensionToolBar.translate, commotion_client.GUI.toolbar.ToolBar.translate, commotion_client.utils.validate.ClientConfig.translate, commotion_client.utils.extension_manager.ExtensionManager.translate, commotion_client.GUI.extension_toolbar.MenuItem.translate, commotion_client.commotion_client.CommotionClientApplication.translate, commotion_client.utils.validate.Networking.translate, and commotion_client.utils.extension_manager.ConfigManager.translate.

    def handle_message(self):
        """
        Server side implementation of the messaging functions. This function waits for signals it receives and then emits a SIGNAL "messageAvailable" with the decoded message.
        
        (Emits a signal instead of just calling a function in case we decide we would like to allow other components or extensions to listen for messages from new instances.)
        """
        socket = self._server.nextPendingConnection()
        if socket.waitForReadyRead(self._timeout):
            self.emit(QtCore.SIGNAL("messageAvailable"), bytes(socket.readAll().data()).decode('utf-8'))
            socket.disconnectFromServer()
            self.log.debug(self.translate("logs", "message received and emitted in a messageAvailable signal"))
        else:
            self.log.error(socket.errorString())