visionary::CoLaBProtocolHandler Class Reference

#include <CoLaBProtocolHandler.h>

Inheritance diagram for visionary::CoLaBProtocolHandler:

Public Member Functions
void	closeSession () override
	CoLaBProtocolHandler (ITransport &rTransport)
bool	openSession (std::uint8_t sessionTimeout) override
CoLaCommand	send (CoLaCommand cmd) override
	send cola cmd and receive cola response More...
	~CoLaBProtocolHandler () override
Public Member Functions inherited from visionary::IProtocolHandler
virtual bool	openSession (uint8_t sessionTimeout)=0
virtual	~IProtocolHandler ()=default

Private Types
using	ByteBuffer = std::vector< std::uint8_t >

Private Member Functions
std::uint8_t	calculateChecksum (ByteBuffer::const_iterator begin, ByteBuffer::const_iterator end) const
ByteBuffer	createCommandHeader (std::size_t payloadSize, std::size_t extraReserve=0u)
ByteBuffer	createProtocolHeader (std::size_t payloadSize, std::size_t extraReserve=0u)
ByteBuffer	readProtocol ()
	parse a response on protocol level More...
ByteBuffer	readResponse ()
	read a command response packet More...

Private Attributes
ITransport &	m_rtransport

Detailed Description

Definition at line 17 of file CoLaBProtocolHandler.h.

Member Typedef Documentation

ByteBuffer

using visionary::CoLaBProtocolHandler::ByteBuffer = std::vector<std::uint8_t>

private

Definition at line 30 of file CoLaBProtocolHandler.h.

Constructor & Destructor Documentation

CoLaBProtocolHandler()

visionary::CoLaBProtocolHandler::CoLaBProtocolHandler

(

ITransport &

rTransport

)

Definition at line 19 of file CoLaBProtocolHandler.cpp.

~CoLaBProtocolHandler()

visionary::CoLaBProtocolHandler::~CoLaBProtocolHandler ( )

overridedefault

Member Function Documentation

calculateChecksum()

std::uint8_t visionary::CoLaBProtocolHandler::calculateChecksum ( ByteBuffer::const_iterator  begin, ByteBuffer::const_iterator  end  ) const

private

Definition at line 25 of file CoLaBProtocolHandler.cpp.

closeSession()

void visionary::CoLaBProtocolHandler::closeSession ( )

overridevirtual

Implements visionary::IProtocolHandler.

Definition at line 179 of file CoLaBProtocolHandler.cpp.

createCommandHeader()

CoLaBProtocolHandler::ByteBuffer visionary::CoLaBProtocolHandler::createCommandHeader ( std::size_t  payloadSize, std::size_t  extraReserve = 0u  )

private

Definition at line 133 of file CoLaBProtocolHandler.cpp.

createProtocolHeader()

CoLaBProtocolHandler::ByteBuffer visionary::CoLaBProtocolHandler::createProtocolHeader ( std::size_t  payloadSize, std::size_t  extraReserve = 0u  )

private

Definition at line 112 of file CoLaBProtocolHandler.cpp.

openSession()

bool visionary::CoLaBProtocolHandler::openSession ( std::uint8_t  sessionTimeout )

override

Definition at line 172 of file CoLaBProtocolHandler.cpp.

readProtocol()

CoLaBProtocolHandler::ByteBuffer visionary::CoLaBProtocolHandler::readProtocol ( )

private

parse a response on protocol level

Definition at line 37 of file CoLaBProtocolHandler.cpp.

readResponse()

CoLaBProtocolHandler::ByteBuffer visionary::CoLaBProtocolHandler::readResponse ( )

private

read a command response packet

Definition at line 106 of file CoLaBProtocolHandler.cpp.

send()

CoLaCommand visionary::CoLaBProtocolHandler::send ( CoLaCommand  cmd )

overridevirtual

send cola cmd and receive cola response

Implements visionary::IProtocolHandler.

Definition at line 140 of file CoLaBProtocolHandler.cpp.

Member Data Documentation

m_rtransport

ITransport& visionary::CoLaBProtocolHandler::m_rtransport

private

Definition at line 41 of file CoLaBProtocolHandler.h.

---

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

• CoLaBProtocolHandler.h
• CoLaBProtocolHandler.cpp