Tonido::Plugin::ScriptLoader Class Reference

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

Inheritance diagram for Tonido::Plugin::ScriptLoader:

List of all members.

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

---

Detailed Description

Responsible for loading and unloading a specific script based plugin.

---

Constructor & Destructor Documentation

Tonido::Plugin::ScriptLoader::ScriptLoader

(

)

Ctor.

details if needed ...

Tonido::Plugin::ScriptLoader::~ScriptLoader

(

)

[virtual]

Dtor.

details if needed ...

---

Member Function Documentation

virtual std::string Tonido::Plugin::ScriptLoader::getAuthentication

(

)

[virtual]

Gets the Authentication for this plugin.

Parameters:

[in]

none

Returns:

authentication for this plugin

Implements Tonido::Plugin::Loader.

virtual std::string Tonido::Plugin::ScriptLoader::getBasePath

(

)

[virtual]

Gets the base path for this plugin.

Parameters:

[in]

none

Returns:

a_serviceList list of services

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getDescription

(

)

[virtual]

Returns the description of the plugin.

Parameters:

[in]

none

Returns:

plugin description

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getLicensing

(

)

[virtual]

Returns the licensing of the plugin.

Parameters:

[in]

none

Returns:

plugin licensing

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getName

(

)

[virtual]

Returns the name of the plugin.

Parameters:

[in]

none

Returns:

plugin name

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getPluginType

(

)

[virtual]

Returns the type of the plugin.

Parameters:

[in]

none

Returns:

plugin type

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getPluginURL

(

)

[virtual]

Returns the starting URL of the plugin.

Parameters:

[in]

none

Returns:

plugin URL

Implements Tonido::Plugin::Loader.

const std::vector< std::string > & Tonido::Plugin::ScriptLoader::getServiceNames

(

)

[virtual]

Returns the list of services in this plugin.

Parameters:

[in]

none

Returns:

a_serviceList list of services

Implements Tonido::Plugin::Loader.

std::string Tonido::Plugin::ScriptLoader::getVersion

(

)

[virtual]

Returns the version of the plugin.

Parameters:

[in]

none

Returns:

plugin version

Implements Tonido::Plugin::Loader.

bool Tonido::Plugin::ScriptLoader::init

(

const std::string &

a_initPath

)

[virtual]

Init the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

virtual bool Tonido::Plugin::ScriptLoader::isLoaded

(

)

[virtual]

Returns whether the plugin is loaded or not.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

virtual bool Tonido::Plugin::ScriptLoader::isStarted

(

)

[virtual]

Returns whether the plugin is started or not.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

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

Loads the plugin in the specified path.

Parameters:

[in]

path

to load

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

bool Tonido::Plugin::ScriptLoader::start

(

)

[virtual]

Starts the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

bool Tonido::Plugin::ScriptLoader::stop

(

)

[virtual]

Stop the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.

bool Tonido::Plugin::ScriptLoader::unload

(

)

[virtual]

Unload the plugin.

Parameters:

[in]

none

Returns:

true on sucess, false otherwise

Implements Tonido::Plugin::Loader.