Driver::TPipe::Pipe Class Reference

This concrete class provides the implementation of TPipe. More...

Detailed Description

This concrete class provides the implementation of TPipe.

The implementation is thread safe with respect to transmitting frames. In addition, all transmitted frames are atomic with respect to each other.

Reception of frames is done a single thread, i.e. the callback to individual Receive Frame Handler occur in the TPipe's thread. It is APPLICATION's responsibility to provide thread safety for its Receive Frame Handlers.

The TPipe dynamically allocates memory for its incoming frame buffer on start-up. The memory is freed when the TPipe is shutdown.

The TPipe also assumes that the runnable object for its thread is a Cpl::System::PeridiocScheduler. The Periodic Scheduler semantics impose the following constraints on the Application (who is responsible for creating the Periodic Scheduler)

- The application MUST call the TPipe's start() method in the 'beginThreadProcessing'
  function for the thread/PeriodicScheduler.

- The application MUST call the TPipe's stop() method in the 'endThreadProcessing'
  function for the thread/PeriodicScheduler

- The application MUST call the TPipe's poll() method in the 'idleProcessing'
  function for the thread/PeriodicScheduler

- The concrete Frame decoder class MUST use non-blocking semantics AND
  the input stream MUST support the Cpl::Io::Input.available() method. See 
  Cpl::Text::Frame::StreamDecoder for more details.

#include <Pipe.h>

Inheritance diagram for Driver::TPipe::Pipe:

Collaboration diagram for Driver::TPipe::Pipe:

Public Member Functions
	Pipe (Cpl::Container::Map< RxFrameHandlerApi > &rxFrameHdlrs, Cpl::Text::Frame::StreamDecoder &deframer, Cpl::Text::Frame::StreamEncoder &framer, size_t rxFrameSize, const char *verbDelimiters=" ")
	Constructor.
	~Pipe ()
	Destructor.
void	start (Cpl::Io::Input &inStream, Cpl::Io::Output &outStream) noexcept
	This method performs the in-thread initialization of the TPipe.
void	stop () noexcept
	This method performs the in-thread shutdown of the TPipe.
bool	poll () noexcept
	This method provides the TPipe CPU/Execution time.
bool	sendCommand (const char *completeCommandText, size_t numBytes) noexcept
	See Driver::TPipe::Tx.
bool	sendRawCommand (const char *completeCommandText, size_t numBytes) noexcept
	See Driver::TPipe::Tx.
size_t	getUnknownFrameCount () noexcept
	This method returns the number of received frames that there was no registered frame handler to process the incoming frame.
Public Member Functions inherited from Driver::TPipe::Tx
bool	sendCommand (Cpl::Text::String &command) noexcept
	Convenience method to send a command that is contain in Text string object.
bool	sendCommand (const char *commandString) noexcept
	Convenience method to send a command that is a contained in a null terminated string.
virtual	~Tx ()
	Virtual destructor.

Protected Attributes
Cpl::Container::Map< RxFrameHandlerApi > &	m_rxHandlers
	List of Frame handlers.
Cpl::Text::Frame::StreamDecoder &	m_deframer
	Frame Decoder.
Cpl::Text::Frame::StreamEncoder &	m_framer
	Frame Encoder.
char *	m_frameBuffer
	Frame buffer.
Cpl::Io::Output *	m_outfdPtr
	Cache the handle to the output stream (for raw-commands)
Cpl::System::Mutex	m_lock
	Lock for thread safety and atomic transmits.
size_t	m_frameBufSize
	Frame buffer size (not including the null terminator)
const char *	m_verbDelimiters
	Delimiter(s) to find the end of the command verb.
size_t	m_unknownFrames
	Track the number of unknown frames (i.e. frame received with no register frame handler)

Constructor & Destructor Documentation

Pipe()

Driver::TPipe::Pipe::Pipe	(	Cpl::Container::Map< RxFrameHandlerApi > &	rxFrameHdlrs,
		Cpl::Text::Frame::StreamDecoder &	deframer,
		Cpl::Text::Frame::StreamEncoder &	framer,
		size_t	rxFrameSize,
		const char *	verbDelimiters = " "
	)

Constructor.

Parameters

rxFrameHdlrs	The set of received frame handlers. Note: frame handler's self register
deframer	Frame decoder used to identify individual command strings within the raw Input stream. NOTE: The decoder instance MUST use non-blocking semantics
framer	Frame encoder used to encapsulate the output of command in the Output stream.
rxFrameSize	The size, in bytes, of the buffer used to hold an incoming Frame. The behavior of what happens if the incoming data exceeds the frame size is defined by the 'deframer' (typically this is to discard the in-progress frame and being looking for a new SOF).
verbDelimiters	The delimiter characters used to separate the command verb from the rest of commands tokens/data. This string must stay in scope for the life of the Pipe instance.

~Pipe()

Driver::TPipe::Pipe::~Pipe

(

)

Destructor.

Member Function Documentation

getUnknownFrameCount()

size_t Driver::TPipe::Pipe::getUnknownFrameCount ( )

noexcept

This method returns the number of received frames that there was no registered frame handler to process the incoming frame.

This method is thread safe.

poll()

bool Driver::TPipe::Pipe::poll ( )

noexcept

This method provides the TPipe CPU/Execution time.

It MUST be called in the 'idleFunction' for the Periodic Scheduler of which the TPipe executes in.

Return false if a Stream IO error occurred; else true is returned

sendCommand()

bool Driver::TPipe::Pipe::sendCommand ( const char *  completeCommandText, size_t  numBytes  )

virtualnoexcept

See Driver::TPipe::Tx.

Implements Driver::TPipe::Tx.

sendRawCommand()

bool Driver::TPipe::Pipe::sendRawCommand ( const char *  completeCommandText, size_t  numBytes  )

virtualnoexcept

See Driver::TPipe::Tx.

Implements Driver::TPipe::Tx.

start()

void Driver::TPipe::Pipe::start ( Cpl::Io::Input &  inStream, Cpl::Io::Output &  outStream  )

noexcept

This method performs the in-thread initialization of the TPipe.

It MUST be called in the 'beginThreadProcessing' for the Periodic Scheduler of which the TPipe executes in.

stop()

void Driver::TPipe::Pipe::stop ( )

noexcept

This method performs the in-thread shutdown of the TPipe.

It MUST be called in the 'endThreadProcessing' for the Periodic Scheduler of which the TPipe executes in.

Member Data Documentation

m_deframer

Cpl::Text::Frame::StreamDecoder& Driver::TPipe::Pipe::m_deframer

protected

Frame Decoder.

m_frameBuffer

char* Driver::TPipe::Pipe::m_frameBuffer

protected

Frame buffer.

m_frameBufSize

size_t Driver::TPipe::Pipe::m_frameBufSize

protected

Frame buffer size (not including the null terminator)

m_framer

Cpl::Text::Frame::StreamEncoder& Driver::TPipe::Pipe::m_framer

protected

Frame Encoder.

m_lock

Cpl::System::Mutex Driver::TPipe::Pipe::m_lock

protected

Lock for thread safety and atomic transmits.

m_outfdPtr

Cpl::Io::Output* Driver::TPipe::Pipe::m_outfdPtr

protected

Cache the handle to the output stream (for raw-commands)

m_rxHandlers

Cpl::Container::Map<RxFrameHandlerApi>& Driver::TPipe::Pipe::m_rxHandlers

protected

List of Frame handlers.

m_unknownFrames

size_t Driver::TPipe::Pipe::m_unknownFrames

protected

Track the number of unknown frames (i.e. frame received with no register frame handler)

m_verbDelimiters

const char* Driver::TPipe::Pipe::m_verbDelimiters

protected

Delimiter(s) to find the end of the command verb.

---

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

• Driver/TPipe/Pipe.h