visiontransfer::internal::DataChannel Class Reference

Detailed Description

Base class all data channel services derive from (once on the server side, once on the API side)

Definition at line 83 of file datachannelservicebase.h.

#include <visiontransfer/internal/datachannelservicebase.h>

Inheritance diagram for visiontransfer::internal::DataChannel:

Classes
struct	Types
	Known data channel service types, not all may be active on a specific device. More...

Public Types
typedef unsigned char	Type
typedef unsigned char	ID

Public Member Functions
ID	getChannelID () const
std::string	getInfoString () const
void	setService (std::weak_ptr< DataChannelServiceBase > serv)
void	setChannelID (ID id)
virtual Type	getChannelType () const =0
virtual int	handleMessage (DataChannelMessage &message, sockaddr_in *sender)=0
	Channel-dependent message handlers in respective channel implementations. More...
virtual bool	initialize ()=0
	When initialize() implementations return false, the service will be deactivated. More...
virtual int	startService ()=0
	startService() implementations can start devices, launch an IO-blocked worker thread etc. More...
virtual bool	process ()
	A single processing iteration; should be short and must not block. Actual frequency determined by the thread calling DataChannelServiceBase::process() More...
virtual int	stopService ()=0

Protected Member Functions
int	sendData (unsigned char *data, unsigned int dataSize, sockaddr_in *recipient=nullptr)

Protected Attributes
std::string	infoString

Member Function Documentation

handleMessage()

virtual int visiontransfer::internal::DataChannel::handleMessage ( DataChannelMessage &  message, sockaddr_in *  sender  )

pure virtual

Channel-dependent message handlers in respective channel implementations.

Implemented in visiontransfer::internal::ClientSideDataChannelIMUBNO080.

initialize()

virtual bool visiontransfer::internal::DataChannel::initialize ( )

pure virtual

When initialize() implementations return false, the service will be deactivated.

Implemented in visiontransfer::internal::ClientSideDataChannelIMUBNO080.

process()

virtual bool visiontransfer::internal::DataChannel::process ( )

inlinevirtual

A single processing iteration; should be short and must not block. Actual frequency determined by the thread calling DataChannelServiceBase::process()

Definition at line 116 of file datachannelservicebase.h.

startService()

virtual int visiontransfer::internal::DataChannel::startService ( )

pure virtual

startService() implementations can start devices, launch an IO-blocked worker thread etc.

Implemented in visiontransfer::internal::ClientSideDataChannelIMUBNO080.

---

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

• visiontransfer/internal/datachannelservicebase.h
• visiontransfer/internal/datachannelservicebase.cpp