Cpl::TShell::PolledMaker Class Reference

This concrete class is a "Maker" that assembles the objects needed for a 'basic' TShell Processor engine that has POLLED semantics. More...

Detailed Description

This concrete class is a "Maker" that assembles the objects needed for a 'basic' TShell Processor engine that has POLLED semantics.

#include <PolledMaker.h>

Collaboration diagram for Cpl::TShell::PolledMaker:

Public Member Functions
	PolledMaker (Cpl::Container::SList< Command > &cmdlist, Cpl::System::Mutex &lock=Cpl::System::Locks_::tracingOutput())
	Constructor.
ProcessorApi &	getCommandProcessor (void) noexcept
	Returns a reference to the Command processor.
	operator ProcessorApi & ()
	Cast-operator: Short-hand for getCommandProcessor()

Protected Attributes
Cpl::Text::Frame::StreamEncoder	m_framer
	Framer for the output.
Cpl::Text::Frame::LineDecoder< OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE >	m_deframer
	De-framer for the input stream.
PolledProcessor	m_processor
	Command Processor.

Constructor & Destructor Documentation

PolledMaker()

Cpl::TShell::PolledMaker::PolledMaker	(	Cpl::Container::SList< Command > &	cmdlist,
		Cpl::System::Mutex &	lock = Cpl::System::Locks_::tracingOutput() )

Constructor.

The application is responsible for supplying the set of commands and the mutex to ensure atomic output.

Member Function Documentation

getCommandProcessor()

ProcessorApi & Cpl::TShell::PolledMaker::getCommandProcessor ( void )

inlinenoexcept

Returns a reference to the Command processor.

operator ProcessorApi &()

Cpl::TShell::PolledMaker::operator ProcessorApi & ( )

inline

Cast-operator: Short-hand for getCommandProcessor()

Member Data Documentation

m_deframer

Cpl::Text::Frame::LineDecoder<OPTION_CPL_TSHELL_PROCESSOR_INPUT_SIZE> Cpl::TShell::PolledMaker::m_deframer

protected

De-framer for the input stream.

m_framer

Cpl::Text::Frame::StreamEncoder Cpl::TShell::PolledMaker::m_framer

protected

Framer for the output.

m_processor

PolledProcessor Cpl::TShell::PolledMaker::m_processor

protected

Command Processor.

---

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

• Cpl/TShell/PolledMaker.h