Cpl::TShell::ProcessorApi Class Reference

This class defines the interface a TShell Command Processor. More...

Detailed Description

This class defines the interface a TShell Command Processor.

The Command Processor is responsible for scanning the input, determining what command (if any) to execute; and then executing the command.

The design of the interface supports running the Command Processor with blocking-thread and with cooperative scheduling semantics.

#include <ProcessorApi.h>

Inheritance diagram for Cpl::TShell::ProcessorApi:

Public Member Functions
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

~ProcessorApi()

virtual Cpl::TShell::ProcessorApi::~ProcessorApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

getDelimiterChar()

virtual char Cpl::TShell::ProcessorApi::getDelimiterChar ( )

pure virtualnoexcept

Getter for delimiter character.

Implemented in Cpl::TShell::Processor.

getEscapeChar()

virtual char Cpl::TShell::ProcessorApi::getEscapeChar ( )

pure virtualnoexcept

Getter for escape character.

Implemented in Cpl::TShell::Processor.

getQuoteChar()

virtual char Cpl::TShell::ProcessorApi::getQuoteChar ( )

pure virtualnoexcept

Getter for quote character.

Implemented in Cpl::TShell::Processor.

getTerminatorChar()

virtual char Cpl::TShell::ProcessorApi::getTerminatorChar ( )

pure virtualnoexcept

Getter for terminator character.

Implemented in Cpl::TShell::Processor.

poll()

virtual int Cpl::TShell::ProcessorApi::poll ( )

pure virtualnoexcept

This method is used to provide the command processor 'CPU cycles' to parse/process/execute commands.

This command should ONLY be called when the application called the start() method with the 'blocking' argument set to false. This method should be called as often as possible, e.g. every pass of the 'main loop'

NOTE: This method must ALWAYS be called from the same 'thread context'

The method returns 0 if the method executed without errors. The method returns -1 if an error occurred (e.g. a Input/Output stream error was encounter). The method returns 1 if the command processor self terminated or was requested to stop.

Implemented in Cpl::TShell::PolledProcessor, and Cpl::TShell::Processor.

requestStop()

virtual void Cpl::TShell::ProcessorApi::requestStop ( )

pure virtualnoexcept

This non-blocking method requests the Command Processor to stop.

When (or if) the Command Processor actually stops depends on the target's implementation, health of the Shell, current command(s) executing, etc. This method returns immediately. There is no feedback/confirmation when the Command Processor stops.

Implemented in Cpl::TShell::Processor.

start()

virtual bool Cpl::TShell::ProcessorApi::start ( Cpl::Io::Input &  infd, Cpl::Io::Output &  outfd, bool  blocking = true  )

pure virtualnoexcept

This method is used to start the Command Processor, i.e.

it will begin to process commands.

When 'blocking' is set to true, the method command will not return until the Command Processor self terminates or a Input/Output stream error was encounter. The method returns true if the Command Processor self terminated or was requested to stop; else false is returned e.g. a Input/Output stream error was encounter).

When 'blocking' is set to false, the command processor will be started and the method returns immediately. After start() is the called the Application is responsible for calling poll() to provide the command processor with CPU time to process commands. The method returns true if the Command Processor was successfully started; else false is returned (e.g. a Input/Output stream error was encounter).

NOTE: This method is an 'in-thread' initialization, i.e. not thread safe. The application is RESPONSIBLE for managing threading issues.

Implemented in Cpl::TShell::PolledProcessor, and Cpl::TShell::Processor.

---

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

• Cpl/TShell/ProcessorApi.h