mycroft.client.enclosure.base.GUIConnection Class Reference

Public Member Functions
def	__init__ (self, id, config, callback_disconnect, enclosure)
def	on_connection_closed (self, socket)
def	on_connection_opened (self, socket_handler)
def	synchronize (self)

Public Attributes
	callback_disconnect
	enclosure
	id
	port
	socket
	webapp

Static Public Attributes
	server_thread = None

Static Private Attributes
int	_last_idx = 0

Detailed Description

A single GUIConnection exists per graphic interface.  This object
maintains the socket used for communication and keeps the state of the
Mycroft data in sync with the GUIs data.

Serves as a communication interface between Qt/QML frontend and Mycroft
Core.  This is bidirectional, e.g. "show me this visual" to the frontend as
well as "the user just tapped this button" from the frontend.

For the rough protocol, see:
https://cgit.kde.org/scratch/mart/mycroft-gui.git/tree/transportProtocol.txt?h=newapi  # nopep8

TODO: Implement variable deletion
TODO: Implement 'models' support
TODO: Implement events
TODO: Implement data coming back from Qt to Mycroft

Definition at line 468 of file base.py.

Constructor & Destructor Documentation

def mycroft.client.enclosure.base.GUIConnection.__init__	(		self,
			id,
			config,
			callback_disconnect,
			enclosure
	)

Definition at line 489 of file base.py.

Member Function Documentation

def mycroft.client.enclosure.base.GUIConnection.on_connection_closed	(		self,
			socket
	)

Definition at line 556 of file base.py.

def mycroft.client.enclosure.base.GUIConnection.on_connection_opened	(		self,
			socket_handler
	)

Definition at line 525 of file base.py.

def mycroft.client.enclosure.base.GUIConnection.synchronize

(

self

)

Upload namespaces, pages and data. 

Definition at line 530 of file base.py.

Member Data Documentation

int mycroft.client.enclosure.base.GUIConnection._last_idx = 0

staticprivate

Definition at line 486 of file base.py.

mycroft.client.enclosure.base.GUIConnection.callback_disconnect

Definition at line 493 of file base.py.

mycroft.client.enclosure.base.GUIConnection.enclosure

Definition at line 494 of file base.py.

mycroft.client.enclosure.base.GUIConnection.id

Definition at line 491 of file base.py.

mycroft.client.enclosure.base.GUIConnection.port

Definition at line 504 of file base.py.

mycroft.client.enclosure.base.GUIConnection.server_thread = None

static

Definition at line 487 of file base.py.

mycroft.client.enclosure.base.GUIConnection.socket

Definition at line 492 of file base.py.

mycroft.client.enclosure.base.GUIConnection.webapp

Definition at line 508 of file base.py.

---

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

• base.py