This abstract class defines the "manager" interface to for starting, stopping, etc. More...

Detailed Description

This abstract class defines the "manager" interface to for starting, stopping, etc.

individual MApp instances.

NOTE: ALL of the following method can ONLY be called from a different thread than where the MApp instances execute! This is because synchronous ITC is (assumed to be) used for the implementation.

#include <ManagerApi.h>

Inheritance diagram for Cpl::MApp::ManagerApi:

[legend]

Public Member Functions
virtual bool	startMApp (const char mappName, char optionalArgs) noexcept=0
	This method is used to the specified MApp.

virtual bool	stopMApp (const char *mappName) noexcept=0
	This method is used to stop the specified running MApp.

virtual void	stopAllMApps () noexcept=0
	This method is used to stop ALL currently started MApp instances.

virtual bool	getAvailableMApps (Cpl::MApp::MAppApi *dstList[], size_t dstMaxElements, size_t &numElemsFound) noexcept=0
	This method returns a list of started MApps.

virtual bool	getStartedMApps (Cpl::MApp::MAppApi *dstList[], size_t dstMaxElements, size_t &numElemsFound) noexcept=0
	This method returns a list of started MApps.

virtual Cpl::MApp::MAppApi *	lookUpMApp (const char *mappName) noexcept=0
	This method returns a pointer to the named MApp instance.

virtual	~ManagerApi ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~ManagerApi()

virtual Cpl::MApp::ManagerApi::~ManagerApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ getAvailableMApps()

virtual bool Cpl::MApp::ManagerApi::getAvailableMApps	(	Cpl::MApp::MAppApi *	dstList[],
		size_t	dstMaxElements,
		size_t &	numElemsFound
	)

pure virtualnoexcept

This method returns a list of started MApps.

If the number of started MApps exceeded the provided buffer space false is returned; else return true is returned. The number of instances found is returned via 'numElemsFound'.

NOTE: There is no order to the returned instances.

Implemented in Cpl::MApp::Manager.

◆ getStartedMApps()

virtual bool Cpl::MApp::ManagerApi::getStartedMApps	(	Cpl::MApp::MAppApi *	dstList[],
		size_t	dstMaxElements,
		size_t &	numElemsFound
	)

pure virtualnoexcept

This method returns a list of started MApps.

If the number of started MApps exceeded the provided buffer space false is returned; else return true is returned. The number of instances found is returned via 'numElemsFound'.

NOTE: There is no order to the returned instances.

Implemented in Cpl::MApp::Manager.

◆ lookUpMApp()

virtual Cpl::MApp::MAppApi * Cpl::MApp::ManagerApi::lookUpMApp ( const char * mappName )

pure virtualnoexcept

This method returns a pointer to the named MApp instance.

If no such MApp exists, a null pointer is returned;

Implemented in Cpl::MApp::Manager.

◆ startMApp()

virtual bool Cpl::MApp::ManagerApi::startMApp	(	const char *	mappName,
		char *	optionalArgs
	)

pure virtualnoexcept

This method is used to the specified MApp.

If a MApp is currently executing, that MApp will be stopped before the new MApp is started. If the specified MApp name is not found false is returned; else true is returned.

NOTE: If the client has no 'optionalArgs' to pass to the MApp instance, it must provide an empty/blank null terminated string, i.e can NOT pass a nullptr.

Implemented in Cpl::MApp::Manager.