Interface for handling PI commands. More...

#include <Safir/Application/Backdoor.h>

Public Member Functions
virtual	~Backdoor ()
	Destructor.

virtual void	HandleCommand (const std::vector< std::wstring > &cmdTokens)=0
	Called when a 'Program Info' command aimed for this handler is received.

virtual std::wstring	GetHelpText ()=0
	Called when a 'help' command aimed for this handler is received.

Detailed Description

Interface for handling PI commands.

Provides the interface needed for classes that want to handle PI commands. The class must use a BackdoorKeeper class to set up the subscriptions, and pass "itself" to its Start-routine. After this the abstract methods in the class will be called when a PI command is received.

Constructor & Destructor Documentation

◆ ~Backdoor()

virtual Safir::Application::Backdoor::~Backdoor ( )

virtual

Destructor.

Member Function Documentation

◆ GetHelpText()

virtual std::wstring Safir::Application::Backdoor::GetHelpText ( )

pure virtual

Called when a 'help' command aimed for this handler is received.

To be implemented by subclasses.

Returns: Help text, typically describing supported Program Info commands.

◆ HandleCommand()

virtual void Safir::Application::Backdoor::HandleCommand ( const std::vector< std::wstring > & cmdTokens )

pure virtual

Called when a 'Program Info' command aimed for this handler is received.