This abstract class defines the 'Received Frame Handler' interface for the TPipe. More...

Detailed Description

This abstract class defines the 'Received Frame Handler' interface for the TPipe.

The frame handlers are essentially callback that are executed when a valid frame is received. The frame handler's execute in the TPipe's thread. It is the Application RESPONSIBLE for ensuring proper thread-safe inside the frame handlers.

#include <RxFrameHandlerApi.h>

Inheritance diagram for Driver::TPipe::RxFrameHandlerApi:

[legend]

Collaboration diagram for Driver::TPipe::RxFrameHandlerApi:

[legend]

Public Member Functions
virtual void	execute (char *decodedFrameText) noexcept=0
	This method is execute when an valid frame is received AND the frame begins with the frame handler' verb (as defined by its getVerb() method).

virtual const char *	getVerb () const noexcept=0
	This method returns the frame handler's verb string.

virtual	~RxFrameHandlerApi ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Protected Member Functions inherited from Cpl::Container::MapItem
	MapItem ()
	Constructor.

	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.

void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.

MapItem *	getParent () const
	Get tree connection/pointer.

void	setParent (MapItem *n)
	Set tree connection/pointer.

MapItem *	getLeft () const
	Get tree connection/pointer.

void	setLeft (MapItem *n)
	Set tree connection/pointer.

MapItem *	getRight () const
	Get tree connection/pointer.

void	setRight (MapItem *n)
	Set tree connection/pointer.

Protected Member Functions inherited from Cpl::Container::DictItem
virtual const Key &	getKey () const noexcept=0
	This method returns a reference to the Item's Key instance.

	DictItem ()
	Constructor.

	DictItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes inherited from Cpl::Container::MapItem
void *	m_parentPtr_
	Link field to the parent node.

bool	m_is_NOT_root_
	I am the root node.

Balance_T	m_balance_
	Balance status.

Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Constructor & Destructor Documentation

◆ ~RxFrameHandlerApi()

virtual Driver::TPipe::RxFrameHandlerApi::~RxFrameHandlerApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ execute()

virtual void Driver::TPipe::RxFrameHandlerApi::execute ( char * decodedFrameText )

pure virtualnoexcept

This method is execute when an valid frame is received AND the frame begins with the frame handler' verb (as defined by its getVerb() method).

The frame is passed via 'decodedFrameText' - which is a null terminated string. The frame handler is ALLOWED to modify the frame contents (e.g. destructive tokenizing)

◆ getVerb()

virtual const char * Driver::TPipe::RxFrameHandlerApi::getVerb ( ) const

pure virtualnoexcept

This method returns the frame handler's verb string.

Implemented in Driver::TPipe::RxFrameHandler.

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

Driver/TPipe/RxFrameHandlerApi.h