Driver::TPipe::Maker Class Reference

This concrete class is a "Maker" that assembles the objects needed for TPipe. More...

Detailed Description

This concrete class is a "Maker" that assembles the objects needed for TPipe.

#include <Maker.h>

Inheritance diagram for Driver::TPipe::Maker:

Collaboration diagram for Driver::TPipe::Maker:

Public Member Functions
	Maker (Cpl::Container::Map< RxFrameHandlerApi > &frameHandlerList, size_t maxRxFrameSize, const char *verbDelimiters=" ", char startOfFrame='^', char endOfFrame=';', char escapeChar='`')
	Constructor.
Pipe &	getPipeProcessor (void) noexcept
	Returns a reference to the TPipe processor.
	operator Pipe & ()
	Cast-operator: Short-hand for getPipeProcessor()
Public Member Functions inherited from Cpl::Text::Frame::StreamDecoder
void	setInput (Cpl::Io::Input &newInFd) noexcept
	This method allows the Application/consumer to change/Set the Input Stream handle.
Public Member Functions inherited from Cpl::Text::Frame::Decoder_
	Decoder_ (char rawInputBuffer[], size_t sizeOfRawInputBuffer)
	Constructor.
bool	scan (size_t maxSizeOfFrame, char *frame, size_t &frameSize) noexcept
	See Cpl::Text::Frame::Decoder.
bool	scan (size_t maxSizeOfFrame, char *frame, size_t &frameSize, bool &isEof) noexcept
	See Cpl::Text::Frame::Decoder.
bool	oobRead (void *buffer, int numBytes, int &bytesRead) noexcept
	See Cpl::Text::Frame::Decoder.
Public Member Functions inherited from Cpl::Text::Frame::Decoder
virtual	~Decoder ()
	Virtual Destructor.

Protected Member Functions
bool	isStartOfFrame () noexcept
	See Cpl::Text::Frame::Decoder_.
bool	isEofOfFrame () noexcept
	See Cpl::Text::Frame::Decoder_.
bool	isEscapeChar () noexcept
	See Cpl::Text::Frame::Decoder_.
bool	isLegalCharacter () noexcept
	See Cpl::Text::Frame::Decoder_.
Protected Member Functions inherited from Cpl::Text::Frame::StreamDecoder
	StreamDecoder (char rawInputBuffer[], size_t sizeOfRawInputBuffer, Cpl::Io::Input *inputSource=0, bool blocking=true)
	Constructor.
bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Text::Frame::Decoder_.
Protected Member Functions inherited from Cpl::Text::Frame::Decoder_
virtual char	decodeEscapedChar (char escapedChar)
	Returns the un-encoded value for the specified escaped character.
virtual void	initializeFrame () noexcept
	Helper method to initialize frame processing.

Protected Attributes
Cpl::Text::Frame::StreamEncoder	m_framer
	Framer for the output.
Pipe	m_processor
	Pipe Processor.
char	m_workBuffer [OPTION_DRIVER_TPIPE_RAW_INPUT_SIZE]
	Work buffer for raw incoming data (is not a null terminated string)
const char	m_sof
	SOF character.
const char	m_eof
	EOF character.
const char	m_esc
	Escape character.
Protected Attributes inherited from Cpl::Text::Frame::StreamDecoder
Cpl::Io::Input *volatile	m_srcPtr
	Input stream.
bool	m_blocking
	Block semantics.
Protected Attributes inherited from Cpl::Text::Frame::Decoder_
int	m_dataLen
	Current number of characters remaining in my raw input buffer.
char *	m_dataPtr
	Pointer to the next unprocessed character in my raw input buffer.
char *	m_buffer
	Raw input buffer for reading characters in 'chunks' from my Input stream (i.e. minimize the calls to read())
size_t	m_bufSize
	Size of my raw input buffer.
bool	m_inFrame
	Flag: I am currently in a Frame.
bool	m_escaping
	Flag: the next character is an escape character.
char *	m_framePtr
	Pointer to the next decoded frame character.
size_t	m_frameSize
	Number of bytes current decoded for the frame.

Constructor & Destructor Documentation

Maker()

Driver::TPipe::Maker::Maker	(	Cpl::Container::Map< RxFrameHandlerApi > &	frameHandlerList,
		size_t	maxRxFrameSize,
		const char *	verbDelimiters = " ",
		char	startOfFrame = '^',
		char	endOfFrame = ';',
		char	escapeChar = '`'
	)

Constructor.

Parameters

frameHandlerList	The set of received frame handlers. Note: frame handler's self register
maxRxFrameSize	The size, in bytes, of the buffer used to hold an incoming Frame.
verbDelimiters	The delimiter characters used to separate the command verb from the rest of commands tokens/data. This string must stay in scope for life of the Maker instance.
startOfFrame	Framing: Start-of-Frame character
endOfFrame	Framing: End-of-Frame character
escapeChar	Framing: Escape character

Member Function Documentation

getPipeProcessor()

Pipe & Driver::TPipe::Maker::getPipeProcessor ( void  )

inlinenoexcept

Returns a reference to the TPipe processor.

isEofOfFrame()

bool Driver::TPipe::Maker::isEofOfFrame ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

isEscapeChar()

bool Driver::TPipe::Maker::isEscapeChar ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

isLegalCharacter()

bool Driver::TPipe::Maker::isLegalCharacter ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

isStartOfFrame()

bool Driver::TPipe::Maker::isStartOfFrame ( )

protectedvirtualnoexcept

See Cpl::Text::Frame::Decoder_.

Implements Cpl::Text::Frame::Decoder_.

operator Pipe &()

Driver::TPipe::Maker::operator Pipe & ( )

inline

Cast-operator: Short-hand for getPipeProcessor()

Member Data Documentation

m_eof

const char Driver::TPipe::Maker::m_eof

protected

EOF character.

m_esc

const char Driver::TPipe::Maker::m_esc

protected

Escape character.

m_framer

Cpl::Text::Frame::StreamEncoder Driver::TPipe::Maker::m_framer

protected

Framer for the output.

m_processor

Pipe Driver::TPipe::Maker::m_processor

protected

Pipe Processor.

m_sof

const char Driver::TPipe::Maker::m_sof

protected

SOF character.

m_workBuffer

char Driver::TPipe::Maker::m_workBuffer[OPTION_DRIVER_TPIPE_RAW_INPUT_SIZE]

protected

Work buffer for raw incoming data (is not a null terminated string)

---

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

• Driver/TPipe/Maker.h