udpcommunicator::communicatorThread Class Reference

communicatorThread(QThread) More...

Inheritance diagram for udpcommunicator::communicatorThread:

List of all members.

Public Member Functions
def	__init__
	Constructor of communicatorThread.
def	initSocket
	Creates and binds to a new UDP socket.
def	processAnswer
	This function is triggered whenever thread socket receives a packet.
def	triggerTimeout
	This function is triggered whenever thread timeouts.
Public Attributes
	peachHost
	Peach communicator host.
	peachPort
	Peach communicator port.
	timeout
	Timeout.
	socket
	Socket used for connections.
Static Public Attributes
int	iterationNumberID = 2
	Communicator iteration number request ID.
int	killAllID = 3
	Communicator kill all request ID.
int	pauseID = 4
	Communicator pause request ID.
int	unPauseID = 5
	Communicator unpause request ID.

---

Detailed Description

communicatorThread(QThread)

"abstract" communicator thread class, which serves as ancestor for all thread classes, which actually do something.

It contains communicator protocol command IDs and some function which are common for all children classes

Author:

Stepan Henek

---

Member Function Documentation

def udpcommunicator::communicatorThread::__init__	(		self,
			host = QHostAddress.LocalHost,
			port = 12559,
			timeout = 2000,
			parent = None
	)

Constructor of communicatorThread.

Parameters:

	self	The object pointer.
	host	Host where peach is listening (uint, not some string represented value)
	port	Port on which peach is listening
	timeout	after which thread stops waiting for response and quits
	parent	parent component (intentionally set as None by default since error may occur when main window instance is used)

def udpcommunicator::communicatorThread::initSocket

(

self

)

Creates and binds to a new UDP socket.

Parameters:

self

The object pointer.

def udpcommunicator::communicatorThread::processAnswer

(

self

)

This function is triggered whenever thread socket receives a packet.

After thread finishes emitting retval signal. It exits with status 2, which can be processed later.

Parameters:

self

The object pointer.

def udpcommunicator::communicatorThread::triggerTimeout

(

self

)

This function is triggered whenever thread timeouts.

It exits with status 1, which can be processed later.

Parameters:

self

The object pointer.

---

Member Data Documentation

int udpcommunicator::communicatorThread::iterationNumberID = 2 [static]

Communicator iteration number request ID.

int udpcommunicator::communicatorThread::killAllID = 3 [static]

Communicator kill all request ID.

int udpcommunicator::communicatorThread::pauseID = 4 [static]

Communicator pause request ID.

udpcommunicator::communicatorThread::peachHost

Peach communicator host.

udpcommunicator::communicatorThread::peachPort

Peach communicator port.

udpcommunicator::communicatorThread::socket

Socket used for connections.

udpcommunicator::communicatorThread::timeout

Timeout.

int udpcommunicator::communicatorThread::unPauseID = 5 [static]

Communicator unpause request ID.

---

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

• GUI/udpcommunicator.py