SocketIODriver Class Reference

A ConnectionBackend that allows the software to interface with SocketIO for communicating with across networks. More...

#include <SocketIODriver.h>

Inheritance diagram for SocketIODriver:

Collaboration diagram for SocketIODriver:

Public Member Functions
virtual uint04	bytesAvailable () const override
virtual void	close () override
virtual bool	isOpen () const override
virtual TranslatedString	lastError () const override
virtual bool	open (const ConnectionInfo &request) override
SocketIODriver &	operator= (const SocketIODriver &other)=delete
SocketIODriver &	operator= (SocketIODriver &&other)=delete
virtual uint04	peek (char *s, uint04 size=Constant< uint04 >::Max) const override
virtual uint04	rx (char *s, uint04 max_size=Constant< uint04 >::Max) override
	SocketIODriver (const SocketIODriver &other)=delete
	SocketIODriver (DynamicPointer< SocketIOChannel > socket, ProgressInfo *log=nullptr)
	SocketIODriver (ProgressInfo *log=nullptr)
	SocketIODriver (SocketIODriver &&other)=delete
virtual void	tx (const String &command) override
virtual bool	waitForReadyRead (const TimeSpan &span) override
	~SocketIODriver ()=default
Public Member Functions inherited from ConnectionBackend
	ConnectionBackend (ProgressInfo *log)
virtual String	threadID () const

Additional Inherited Members
Signals inherited from ConnectionBackend
void	connectionStateChangedSignal (ConnectionState state)
void	dataAvailableSignal ()
Protected Attributes inherited from ConnectionBackend
ProgressInfo *	m_log

Detailed Description

A ConnectionBackend that allows the software to interface with SocketIO for communicating with across networks.

---

Constructor & Destructor Documentation

SocketIODriver() [1/4]

SocketIODriver

(

ProgressInfo *

log = nullptr

)

SocketIODriver() [2/4]

SocketIODriver	(	DynamicPointer< SocketIOChannel >	socket,
		ProgressInfo *	log = nullptr )

~SocketIODriver()

~SocketIODriver ( )

default

SocketIODriver() [3/4]

SocketIODriver ( const SocketIODriver & other )

delete

SocketIODriver() [4/4]

SocketIODriver ( SocketIODriver && other )

delete

Member Function Documentation

bytesAvailable()

virtual uint04 bytesAvailable ( ) const

overridevirtual

Implements ConnectionBackend.

close()

virtual void close ( )

overridevirtual

Implements ConnectionBackend.

isOpen()

virtual bool isOpen ( ) const

overridevirtual

Implements ConnectionBackend.

lastError()

virtual TranslatedString lastError ( ) const

overridevirtual

Implements ConnectionBackend.

open()

virtual bool open ( const ConnectionInfo & request )

overridevirtual

Implements ConnectionBackend.

operator=() [1/2]

SocketIODriver & operator= ( const SocketIODriver & other )

delete

operator=() [2/2]

SocketIODriver & operator= ( SocketIODriver && other )

delete

peek()

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

overridevirtual

Implements ConnectionBackend.

rx()

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

overridevirtual

Implements ConnectionBackend.

tx()

virtual void tx ( const String & command )

overridevirtual

Implements ConnectionBackend.

waitForReadyRead()

virtual bool waitForReadyRead ( const TimeSpan & span )

overridevirtual

Implements ConnectionBackend.

---

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

• SocketIO/Headers/SocketIODriver.h