Cpl::TShell::Context_ Class Reference

This Private Namespace class defines a "Context" for a TShell command. More...

Detailed Description

This Private Namespace class defines a "Context" for a TShell command.

The Context provide common infrastructure, information, buffers, etc. that facilitates interaction between the Command Processor and individual commands. The application SHOULD NEVER directly access this interface.

#include <Context_.h>

Inheritance diagram for Cpl::TShell::Context_:

Collaboration diagram for Cpl::TShell::Context_:

Public Member Functions
virtual Cpl::Container::Map< Command > &	getCommands () noexcept=0
	This method returns the list of implemented commands.
virtual bool	writeFrame (const char *text) noexcept=0
	This method encodes and outputs the specified message/text. The method returns false if there was Output Stream error.
virtual bool	writeFrame (const char *text, size_t maxBytes) noexcept=0
	Same as writeFrame(), but only outputs (at most) 'N' bytes as the content of the frame.
virtual Cpl::Text::String &	getOutputBuffer () noexcept=0
	This method returns a working buffer for a command to format its output prior to 'writing the frame'.
virtual Cpl::Text::String &	getTokenBuffer () noexcept=0
	A shared/common working buffer.
virtual Cpl::Text::String &	getTokenBuffer2 () noexcept=0
	Same as getTokenBuffer(), except provides a second/separate token buffer.
virtual bool	oobRead (void *buffer, int numBytes, int &bytesRead) noexcept=0
	This method allows a command access to the input stream, i.e.
virtual Security::Permission_T	getUserPermissionLevel () const noexcept=0
	This method returns the 'logged user' permission level.
virtual Security::Permission_T	setUserPermissionLevel (Security::Permission_T newPermissionLevel) noexcept=0
	This method is used to updated the 'logged user' permission level.
virtual	~Context_ ()
	Virtual destructor.
Public Member Functions inherited from Cpl::TShell::ProcessorApi
virtual bool	start (Cpl::Io::Input &infd, Cpl::Io::Output &outfd, bool blocking=true) noexcept=0
	This method is used to start the Command Processor, i.e.
virtual int	poll () noexcept=0
	This method is used to provide the command processor 'CPU cycles' to parse/process/execute commands.
virtual void	requestStop () noexcept=0
	This non-blocking method requests the Command Processor to stop.
virtual char	getEscapeChar () noexcept=0
	Getter for escape character.
virtual char	getDelimiterChar () noexcept=0
	Getter for delimiter character.
virtual char	getQuoteChar () noexcept=0
	Getter for quote character.
virtual char	getTerminatorChar () noexcept=0
	Getter for terminator character.
virtual	~ProcessorApi ()
	Virtual destructor.

Constructor & Destructor Documentation

~Context_()

virtual Cpl::TShell::Context_::~Context_ ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

getCommands()

virtual Cpl::Container::Map< Command > & Cpl::TShell::Context_::getCommands ( )

pure virtualnoexcept

This method returns the list of implemented commands.

Implemented in Cpl::TShell::Processor.

getOutputBuffer()

virtual Cpl::Text::String & Cpl::TShell::Context_::getOutputBuffer ( )

pure virtualnoexcept

This method returns a working buffer for a command to format its output prior to 'writing the frame'.

Implemented in Cpl::TShell::Processor.

getTokenBuffer()

virtual Cpl::Text::String & Cpl::TShell::Context_::getTokenBuffer ( )

pure virtualnoexcept

A shared/common working buffer.

The buffer is guaranteed to be large enough hold any valid token from an input frame. The contents of buffer is guaranteed to be empty/cleared.

Implemented in Cpl::TShell::Processor.

getTokenBuffer2()

virtual Cpl::Text::String & Cpl::TShell::Context_::getTokenBuffer2 ( )

pure virtualnoexcept

Same as getTokenBuffer(), except provides a second/separate token buffer.

Implemented in Cpl::TShell::Processor.

getUserPermissionLevel()

virtual Security::Permission_T Cpl::TShell::Context_::getUserPermissionLevel ( ) const

pure virtualnoexcept

This method returns the 'logged user' permission level.

Implemented in Cpl::TShell::Processor.

oobRead()

virtual bool Cpl::TShell::Context_::oobRead ( void *  buffer, int  numBytes, int &  bytesRead  )

pure virtualnoexcept

This method allows a command access to the input stream, i.e.

consume additional input data that is 'out-of-band' of the nominal newline delineated command syntax.

Attempts to read the specified number of bytes from the stream into the supplied buffer. The actual number of bytes read is returned via 'bytesRead'. Returns true if successful, or false if End-of-Stream was encountered.

Implemented in Cpl::TShell::Processor.

setUserPermissionLevel()

virtual Security::Permission_T Cpl::TShell::Context_::setUserPermissionLevel ( Security::Permission_T  newPermissionLevel )

pure virtualnoexcept

This method is used to updated the 'logged user' permission level.

The method returns the previous value for the user's permission level.

NOTE: The program model is that all command implementations are well behaved in that they do not indiscriminately call this method.
In practice only the 'user' command should every call this method!

Implemented in Cpl::TShell::Processor.

writeFrame() [1/2]

virtual bool Cpl::TShell::Context_::writeFrame ( const char *  text )

pure virtualnoexcept

This method encodes and outputs the specified message/text. The method returns false if there was Output Stream error.

Implemented in Cpl::TShell::Processor.

writeFrame() [2/2]

virtual bool Cpl::TShell::Context_::writeFrame ( const char *  text, size_t  maxBytes  )

pure virtualnoexcept

Same as writeFrame(), but only outputs (at most) 'N' bytes as the content of the frame.

Implemented in Cpl::TShell::Processor.

---

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

• Cpl/TShell/Context_.h