Cpl::TShell::Maker Class Reference

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

Detailed Description

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

#include <Maker.h>

Collaboration diagram for Cpl::TShell::Maker:

Public Member Functions
	Maker (Cpl::Container::Map< 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.
Processor	m_processor
	Command Processor.

Constructor & Destructor Documentation

Maker()

Cpl::TShell::Maker::Maker	(	Cpl::Container::Map< 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::Maker::getCommandProcessor ( void  )

inlinenoexcept

Returns a reference to the Command processor.

operator ProcessorApi &()

Cpl::TShell::Maker::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::Maker::m_deframer

protected

De-framer for the input stream.

m_framer

Cpl::Text::Frame::StreamEncoder Cpl::TShell::Maker::m_framer

protected

Framer for the output.

m_processor

Processor Cpl::TShell::Maker::m_processor

protected

Command Processor.

---

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

• Cpl/TShell/Maker.h