Cpl::Text::Frame::StreamDecoder Class Reference

This partially concrete class defines an interface a Text "Decoder" that has a Cpl::Io::Input stream as its input source. More...

Detailed Description

This partially concrete class defines an interface a Text "Decoder" that has a Cpl::Io::Input stream as its input source.

See Cpl::Text::Frame::Decoder for details on what is a decoder.

#include <StreamDecoder.h>

Inheritance diagram for Cpl::Text::Frame::StreamDecoder:

Collaboration diagram for Cpl::Text::Frame::StreamDecoder:

Public Member Functions
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
	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 bool	isStartOfFrame () noexcept=0
	Returns true if at start-of-frame.
virtual bool	isEofOfFrame () noexcept=0
	Returns true if at end-of-frame.
virtual bool	isEscapeChar () noexcept=0
	Returns true if the start of the start of a escape sequence has been detected.
virtual bool	isLegalCharacter () noexcept=0
	Returns true if the current character is a legal/valid within a frame.
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::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

StreamDecoder()

Cpl::Text::Frame::StreamDecoder::StreamDecoder ( char  rawInputBuffer[], size_t  sizeOfRawInputBuffer, Cpl::Io::Input *  inputSource = 0, bool  blocking = true  )

protected

Constructor.

The 'inputSource' can optionally be specified at construction time or defer till later (the default is: later). However, the "input source" MUST be specified BEFORF scan() is called or a fatal error will be generated. See Cpl::Text::Frame::Decoder_ for details about the other constructor arguments.

When the 'blocking' argument is set to false - decoder will not block while waiting on input data. The default behavior is to BLOCK.

NOTE: A sub-class IS required to actual create an instance of a StreamDecoder.

Member Function Documentation

read()

bool Cpl::Text::Frame::StreamDecoder::read ( void *  buffer, int  numBytes, int &  bytesRead  )

protectedvirtual

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

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

setInput()

void Cpl::Text::Frame::StreamDecoder::setInput ( Cpl::Io::Input &  newInFd )

noexcept

This method allows the Application/consumer to change/Set the Input Stream handle.

Member Data Documentation

m_blocking

bool Cpl::Text::Frame::StreamDecoder::m_blocking

protected

Block semantics.

m_srcPtr

Cpl::Io::Input* volatile Cpl::Text::Frame::StreamDecoder::m_srcPtr

protected

Input stream.

---

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

• Cpl/Text/Frame/StreamDecoder.h