ConnectionBackend Class Reference

Provides the unseen backend logic for setting up, tearing down, and sending data over a specific type of connection. More...

#include <Connection.h>

Inheritance diagram for ConnectionBackend:

Collaboration diagram for ConnectionBackend:

Signals
void	connectionStateChangedSignal (ConnectionState state)
void	dataAvailableSignal ()

Public Member Functions
virtual uint04	bytesAvailable () const =0
virtual void	close ()=0
	ConnectionBackend (ProgressInfo *log)
virtual bool	isOpen () const =0
virtual TranslatedString	lastError () const =0
virtual bool	open (const ConnectionInfo &request)=0
virtual uint04	peek (char *s, uint04 size=Constant< uint04 >::Max) const =0
virtual uint04	rx (char *s, uint04 max_size=Constant< uint04 >::Max)=0
virtual String	threadID () const
virtual void	tx (const String &command)=0
virtual bool	waitForReadyRead (const TimeSpan &span)=0

Protected Attributes
ProgressInfo *	m_log

Detailed Description

Provides the unseen backend logic for setting up, tearing down, and sending data over a specific type of connection.

---

Constructor & Destructor Documentation

ConnectionBackend()

ConnectionBackend

(

ProgressInfo *

log

)

Member Function Documentation

bytesAvailable()

virtual uint04 bytesAvailable ( ) const

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

close()

virtual void close ( )

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

connectionStateChangedSignal

void connectionStateChangedSignal ( ConnectionState state )

signal

dataAvailableSignal

void dataAvailableSignal ( )

signal

isOpen()

virtual bool isOpen ( ) const

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

lastError()

virtual TranslatedString lastError ( ) const

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

open()

virtual bool open ( const ConnectionInfo & request )

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

peek()

virtual uint04 peek ( char * s, uint04 size = Constant< uint04 >::Max ) const

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

rx()

virtual uint04 rx ( char * s, uint04 max_size = Constant< uint04 >::Max )

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

threadID()

virtual String threadID ( ) const

inlinevirtual

Reimplemented in SerialPortConnection.

tx()

virtual void tx ( const String & command )

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

waitForReadyRead()

virtual bool waitForReadyRead ( const TimeSpan & span )

pure virtual

Implemented in BluetoothConnection, SerialPortConnection, SocketConnection, SocketIODriver, and WebSocketConnection.

Member Data Documentation

m_log

ProgressInfo* m_log

protected

---

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

• Hardware/Headers/Connection.h