trikNetwork Namespace Reference

Classes
class	Connection
	Abstract class that serves one client of TrikServer. More...
class	Mailbox
	Implementation of mailboxes system. More...
class	MailboxConnection
	One connection to a client (or server) in mailbox. Supposed to be working in a separate thread. More...
class	MailboxFactory
	Factory that creates real mailbox object. More...
class	MailboxInterface
	Allows communication between robots. More...
class	MailboxServer
	Worker object for mailbox functionality. More...
class	TrikServer
	Server that can handle multiple clients. Actual work is done in separate threads by Connection objects. More...

Enumerations
enum	Protocol { Protocol::messageLength, Protocol::endOfLineSeparator }
	Connection protocol variants. More...
enum	Heartbeat { Heartbeat::use, Heartbeat::dontUse }
	Heartbeat protocol option. More...

Functions
bool	operator== (const MailboxServer::Endpoint &left, const MailboxServer::Endpoint &right)
QDebug	operator<< (QDebug dbg, const MailboxServer::Endpoint &endpoint)

Enumeration Type Documentation

enum trikNetwork::Heartbeat

strong

Heartbeat protocol option.

Enumerator
use	Wait for a packet every N milliseconds, if none is received, assume connection lost and close socket. Do not use heartbeat, keep socket open until TCP protocol detects disconnect (which may take a while, so we will not be able to detect hardware network failures).
dontUse

enum trikNetwork::Protocol

strong

Connection protocol variants.

Enumerator
messageLength	Message is in form "<data length in bytes>:<data>". Message is in form "<data>\n".
endOfLineSeparator

Function Documentation

QDebug trikNetwork::operator<< ( QDebug  dbg, const MailboxServer::Endpoint &  endpoint  )

inline

bool trikNetwork::operator== ( const MailboxServer::Endpoint &  left, const MailboxServer::Endpoint &  right  )

inline