Tonido::Plugin::PluginManager Class Reference

Responsible for loading and unloading plugins. More...

List of all members.

Public Member Functions
	PluginManager ()
	Ctor.
	~PluginManager ()
	Dtor.
bool	loadPlugin (const std::string &a_path, const std::string &a_basePath, const std::vector< std::string > &a_dependencies, std::string &a_messageout)
	Loads the plugin in the specified path.
bool	loadScriptPlugin (const std::string &a_path, const std::string &a_basePath, const std::vector< std::string > &a_dependencies, std::string &a_messageout)
	Loads the plugin in the specified path.
bool	initPlugin (const std::string &a_path)
	Inits the Plugin in the specified path.
bool	startPlugin (const std::string &a_path)
	Starts the plugin in the specified path.
bool	stopPlugin (const std::string &a_path)
	Stops the plugin in the specified path.
bool	unloadPlugin (const std::string &a_path)
	Unloads the plugin in the specified path.
bool	isPluginLoaded (const std::string &a_path)
	Returns true if the plugin is loaded, false otherwise.
std::string	getPluginDescription (const std::string &a_path)
	Gets the Plugin Description.
std::string	getPluginName (const std::string &a_path)
	Gets the Plugin Name.
std::string	getPluginVersion (const std::string &a_path)
	Gets the Plugin Version.
std::string	getPluginType (const std::string &a_path)
	Gets the Plugin Type.
void	getPluginList (std::vector< std::string > &a_pluginList)
	Gets the Full Plugins List.
void	getApplicationPluginList (std::vector< std::string > &a_pluginList)
	Gets the Application Plugins List.
void	getServiceNames (const std::string &a_path, std::vector< std::string > &a_names)
	Gets the Services in the given plugin.
std::string	getPluginLaunchList ()
	Gets the list of launchable plugins via XML.
std::string	getPluginPathForVFS (const std::string &a_vfsName)
	Gets the Plugin Path for the given VFS file.
std::string	getPluginURL (const std::string &a_path)
	Get the Plugin URL.
bool	isPluginNameLoaded (const std::string &a_pluginName)
	isPluginNameLoaded
std::string	getPluginAuthentication (const std::string &a_pluginName)
	getPluginAuthentication

---

Detailed Description

Responsible for loading and unloading plugins.

Note that the path provided in a std::string can be encoded in UTF-8

---

Constructor & Destructor Documentation

Tonido::Plugin::PluginManager::PluginManager

(

)

Ctor.

details if needed ...

Tonido::Plugin::PluginManager::~PluginManager

(

)

Dtor.

details if needed ...

---

Member Function Documentation

void Tonido::Plugin::PluginManager::getApplicationPluginList

(

std::vector< std::string > &

a_pluginList

)

Gets the Application Plugins List.

Returns:

none

std::string Tonido::Plugin::PluginManager::getPluginAuthentication

(

const std::string &

a_pluginName

)

getPluginAuthentication

Parameters:

[in]

a_pluginName

to check

Returns:

the authentication for this plugin

std::string Tonido::Plugin::PluginManager::getPluginDescription

(

const std::string &

a_path

)

Gets the Plugin Description.

Parameters:

[in]

path

to load

Returns:

Plugin description

std::string Tonido::Plugin::PluginManager::getPluginLaunchList

(

)

Gets the list of launchable plugins via XML.

Parameters:

[in]

@return

XML list of launchable plugins

void Tonido::Plugin::PluginManager::getPluginList

(

std::vector< std::string > &

a_pluginList

)

Gets the Full Plugins List.

Returns:

none

std::string Tonido::Plugin::PluginManager::getPluginName

(

const std::string &

a_path

)

Gets the Plugin Name.

Parameters:

[in]

path

to load

Returns:

Plugin Name

std::string Tonido::Plugin::PluginManager::getPluginPathForVFS

(

const std::string &

a_vfsName

)

Gets the Plugin Path for the given VFS file.

Parameters:

[in]

a_vfsName

name of the Vfs file we are searching for

Returns:

the valid path if the vfs file exists, false otherwise

std::string Tonido::Plugin::PluginManager::getPluginType

(

const std::string &

a_path

)

Gets the Plugin Type.

Parameters:

[in]

path

to load

Returns:

Plugin Type

std::string Tonido::Plugin::PluginManager::getPluginURL

(

const std::string &

a_path

)

Get the Plugin URL.

Parameters:

[in]

none

Returns:

plugin URL

std::string Tonido::Plugin::PluginManager::getPluginVersion

(

const std::string &

a_path

)

Gets the Plugin Version.

Parameters:

[in]

path

to load

Returns:

Plugin Version

void Tonido::Plugin::PluginManager::getServiceNames	(	const std::string &	a_path,
		std::vector< std::string > &	a_names
	)

Gets the Services in the given plugin.

Parameters:

[in]

path

to load

Returns:

list of services available

bool Tonido::Plugin::PluginManager::initPlugin

(

const std::string &

a_path

)

Inits the Plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

bool Tonido::Plugin::PluginManager::isPluginLoaded

(

const std::string &

a_path

)

Returns true if the plugin is loaded, false otherwise.

Parameters:

[in]

path

to load

Returns:

true if loaded, false otherwise

bool Tonido::Plugin::PluginManager::isPluginNameLoaded

(

const std::string &

a_pluginName

)

isPluginNameLoaded

Parameters:

[in]

a_pluginName

to check

Returns:

whether the specific plugin is loaded or not

bool Tonido::Plugin::PluginManager::loadPlugin	(	const std::string &	a_path,
		const std::string &	a_basePath,
		const std::vector< std::string > &	a_dependencies,
		std::string &	a_messageout
	)

Loads the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

bool Tonido::Plugin::PluginManager::loadScriptPlugin	(	const std::string &	a_path,
		const std::string &	a_basePath,
		const std::vector< std::string > &	a_dependencies,
		std::string &	a_messageout
	)

Loads the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

bool Tonido::Plugin::PluginManager::startPlugin

(

const std::string &

a_path

)

Starts the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

bool Tonido::Plugin::PluginManager::stopPlugin

(

const std::string &

a_path

)

Stops the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

bool Tonido::Plugin::PluginManager::unloadPlugin

(

const std::string &

a_path

)

Unloads the plugin in the specified path.

Parameters:

[in]

path

to unload

Returns:

true on sucess, false otherwise