Tonido::Plugin::Loader Class Reference

Responsible for loading and unloading a specific plugin. More...

Inheritance diagram for Tonido::Plugin::Loader:

List of all members.

Public Types
typedef boost::shared_ptr< Loader >	SharedPtr
Public Member Functions
	Loader ()
	Ctor.
virtual	~Loader ()
	Dtor.
virtual bool	load (const std::string &a_path, const std::string &a_basePath, const std::vector< std::string > &a_dependencies)=0
	Loads the plugin in the specified path.
virtual bool	start ()=0
	Starts the plugin.
virtual bool	init (const std::string &a_initPath)=0
	Init the plugin.
virtual bool	stop ()=0
	Stop the plugin.
virtual bool	unload ()=0
	Unload the plugin.
virtual bool	isStarted ()=0
	Returns whether the plugin is started or not.
virtual bool	isLoaded ()=0
	Returns whether the plugin is loaded or not.
virtual std::string	getVersion ()=0
	Returns the version of the plugin.
virtual std::string	getName ()=0
	Returns the name of the plugin.
virtual std::string	getPluginType ()=0
	Returns the type of the plugin.
virtual std::string	getPluginURL ()=0
	Returns the starting URL of the plugin.
virtual std::string	getDescription ()=0
	Returns the description of the plugin.
virtual std::string	getLicensing ()=0
	Returns the licensing of the plugin.
virtual const std::vector < std::string > &	getServiceNames ()=0
	Returns the list of services in this plugin.
virtual std::string	getBasePath ()=0
	Gets the base path for this plugin.
virtual std::string	getAuthentication ()=0
	Gets the Authentication for this plugin.

---

Detailed Description

Responsible for loading and unloading a specific plugin.

---

Constructor & Destructor Documentation

Tonido::Plugin::Loader::Loader

(

)

Ctor.

details if needed ...

virtual Tonido::Plugin::Loader::~Loader

(

)

[virtual]

Dtor.

details if needed ...

---

Member Function Documentation

virtual std::string Tonido::Plugin::Loader::getAuthentication

(

)

[pure virtual]

Gets the Authentication for this plugin.

Parameters:

[in]

none

Returns:

authentication for this plugin

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getBasePath

(

)

[pure virtual]

Gets the base path for this plugin.

Parameters:

[in]

none

Returns:

a_serviceList list of services

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getDescription

(

)

[pure virtual]

Returns the description of the plugin.

Parameters:

[in]

none

Returns:

plugin description

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getLicensing

(

)

[pure virtual]

Returns the licensing of the plugin.

Parameters:

[in]

none

Returns:

plugin licensing

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getName

(

)

[pure virtual]

Returns the name of the plugin.

Parameters:

[in]

none

Returns:

plugin name

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getPluginType

(

)

[pure virtual]

Returns the type of the plugin.

Parameters:

[in]

none

Returns:

plugin type

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getPluginURL

(

)

[pure virtual]

Returns the starting URL of the plugin.

Parameters:

[in]

none

Returns:

plugin URL

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual const std::vector<std::string>& Tonido::Plugin::Loader::getServiceNames

(

)

[pure virtual]

Returns the list of services in this plugin.

Parameters:

[in]

none

Returns:

a_serviceList list of services

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual std::string Tonido::Plugin::Loader::getVersion

(

)

[pure virtual]

Returns the version of the plugin.

Parameters:

[in]

none

Returns:

plugin version

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::init

(

const std::string &

a_initPath

)

[pure virtual]

Init the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::isLoaded

(

)

[pure virtual]

Returns whether the plugin is loaded or not.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::isStarted

(

)

[pure virtual]

Returns whether the plugin is started or not.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::load	(	const std::string &	a_path,
		const std::string &	a_basePath,
		const std::vector< std::string > &	a_dependencies
	)		[pure virtual]

Loads the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::start

(

)

[pure virtual]

Starts the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::stop

(

)

[pure virtual]

Stop the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.

virtual bool Tonido::Plugin::Loader::unload

(

)

[pure virtual]

Unload the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implemented in Tonido::Plugin::PluginLoader, and Tonido::Plugin::ScriptLoader.