DispatchingModuleManager Class Reference

#include <DispatchingModuleManager.h>

Public Member Functions
	DispatchingModuleManager (Dispatching *core)
virtual	~DispatchingModuleManager ()
void	Enable (ds_string pluginName)
void	Disable (ds_string pluginName)
bool	IsPluginEnabled (ds_string pluginName)
bool	LoadDispatchingModules ()
void	RestartTimers (DS_Event &event)
ds_string	GetVersions () const
bool	PluginRequest (DS_Event &event)
bool	PrepareEvent (DS_Event &event, ds_string &sendString, bool &forceImmediateSending)
	true when at least one plugin added some text to be sent More...
bool	PostPrepareEvent (DS_Event &event, ds_string &sendString, ds_StringList &sendStringList, bool &forceImmediateSending)
	true when at least one plugin added some text More...
void	SetPluginsProperty (ds_string propertyName, ds_string propertyValue)
EM::Common::EDataCol *	GetPluginsProperty ()
	DispatchingModuleManager (Dispatching *core)
virtual	~DispatchingModuleManager ()
void	Enable (ds_string pluginName)
void	Disable (ds_string pluginName)
bool	IsPluginEnabled (ds_string pluginName)
bool	LoadDispatchingModules ()
void	RestartTimers (DS_Event &event)
ds_string	GetVersions () const
bool	PluginRequest (DS_Event &event)
bool	PrepareEvent (DS_Event &event, ds_string &sendString, bool &forceImmediateSending)
	true when at least one plugin added some text to be sent More...
bool	PostPrepareEvent (DS_Event &event, ds_string &sendString, ds_StringList &sendStringList, bool &forceImmediateSending)
	true when at least one plugin added some text More...
void	SetPluginsProperty (ds_string propertyName, ds_string propertyValue)
EM::Common::EDataCol *	GetPluginsProperty ()

Static Public Member Functions
static ds_string	GetConfigPath ()
static void	StringCompletion (ds_string &sendstring, const ds_string &stringToAdd)
static ds_string	GetConfigPath ()
static void	StringCompletion (ds_string &sendstring, const ds_string &stringToAdd)

Detailed Description

Class splits relations between plugins and DS_Core so Plugin doesn't depend on DS_Core (and therefore application).

Author

Stanislav Piecka

Note

It IS required to rebuild all plugins, when this class is modified incompatible way.

Constructor & Destructor Documentation

INTERNAL DispatchingModuleManager::DispatchingModuleManager

(

Dispatching *

core

)

Constructor

Parameters

core	pointer to DS_Core, pointer to owner

DispatchingModuleManager::~DispatchingModuleManager ( )

virtual

Destructor

DispatchingModuleManager::DispatchingModuleManager

(

Dispatching *

core

)

Constructor

Parameters

core	pointer to DS_Core, pointer to owner

virtual DispatchingModuleManager::~DispatchingModuleManager ( )

virtual

Destructor

Member Function Documentation

void DispatchingModuleManager::Disable

(

ds_string

pluginName

)

Method disables plugin

Parameters

pluginName

specifies which plugin is to be enabled

Here is the call graph for this function:

void DispatchingModuleManager::Disable

(

ds_string

pluginName

)

Method disables plugin

Parameters

pluginName

specifies which plugin is to be enabled

void DispatchingModuleManager::Enable

(

ds_string

pluginName

)

Method enables plugin

Parameters

pluginName

specifies which plugin is to be enabled

Here is the call graph for this function:

void DispatchingModuleManager::Enable

(

ds_string

pluginName

)

Method enables plugin

Parameters

pluginName

specifies which plugin is to be enabled

ds_string DispatchingModuleManager::GetConfigPath ( )

static

Configuration getting method

Returns

path to configuration files

static ds_string DispatchingModuleManager::GetConfigPath ( )

static

Configuration getting method

Returns

path to configuration files

EM::Common::EDataCol* DispatchingModuleManager::GetPluginsProperty

(

)

EM::Common::EDataCol * DispatchingModuleManager::GetPluginsProperty

(

)

ds_string DispatchingModuleManager::GetVersions

(

)

const

Method returns string containing all version of registered plugins.

Returns

structured string containing all versions of all plugins.

ds_string DispatchingModuleManager::GetVersions

(

)

const

Method returns string containing all version of registered plugins.

Returns

structured string containing all versions of all plugins.

bool DispatchingModuleManager::IsPluginEnabled

(

ds_string

pluginName

)

Method returns whether named plugin is enabled or disabled

Parameters

pluginName

specifies name of plugin to be checked

Returns

true when enabled, false otherwise

bool DispatchingModuleManager::IsPluginEnabled

(

ds_string

pluginName

)

Method returns whether named plugin is enabled or disabled

Parameters

pluginName

specifies name of plugin to be checked

Returns

true when enabled, false otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

bool DispatchingModuleManager::LoadDispatchingModules

(

)

Method reads configuration. Loads all plugins, calls initialization and call configuration read of each loaded plugin.

Returns

false when no one plugin is found or no ne is loaded correctly true is returned otherwise

Here is the call graph for this function:

bool DispatchingModuleManager::LoadDispatchingModules

(

)

Method reads configuration. Loads all plugins, calls initialization and call configuration read of each loaded plugin.

Returns

false when no one plugin is found or no ne is loaded correctly true is returned otherwise

bool DispatchingModuleManager::PluginRequest

(

DS_Event &

event

)

Interface between plugin and core system. Plugin send event trought this to DS_Core.

Parameters

event

what event should be processed

Returns

always true

bool DispatchingModuleManager::PluginRequest

(

DS_Event &

event

)

Interface between plugin and core system. Plugin send event trought this to DS_Core.

Parameters

event

what event should be processed

Returns

always true

Here is the caller graph for this function:

bool DispatchingModuleManager::PostPrepareEvent	(	DS_Event &	event,
		ds_string &	sendString,
		ds_StringList &	sendStringList,
		bool &	forceImmediateSending
	)

true when at least one plugin added some text

Here is the call graph for this function:

bool DispatchingModuleManager::PostPrepareEvent	(	DS_Event &	event,
		ds_string &	sendString,
		ds_StringList &	sendStringList,
		bool &	forceImmediateSending
	)

true when at least one plugin added some text

bool DispatchingModuleManager::PrepareEvent	(	DS_Event &	event,
		ds_string &	sendString,
		bool &	forceImmediateSending
	)

true when at least one plugin added some text to be sent

Here is the call graph for this function:

bool DispatchingModuleManager::PrepareEvent	(	DS_Event &	event,
		ds_string &	sendString,
		bool &	forceImmediateSending
	)

true when at least one plugin added some text to be sent

void DispatchingModuleManager::RestartTimers

(

DS_Event &

event

)

Method ask all plugins to restart timers. Each plugin which care about restarting it's timer for such event will do that.

Parameters

event

event which is asking to restart plugin

void DispatchingModuleManager::RestartTimers

(

DS_Event &

event

)

Method ask all plugins to restart timers. Each plugin which care about restarting it's timer for such event will do that.

Parameters

event

event which is asking to restart plugin

Here is the call graph for this function:

void DispatchingModuleManager::SetPluginsProperty	(	ds_string	propertyName,
		ds_string	propertyValue
	)

void DispatchingModuleManager::SetPluginsProperty	(	ds_string	propertyName,
		ds_string	propertyValue
	)

static void DispatchingModuleManager::StringCompletion ( ds_string &  sendstring, const ds_string &  stringToAdd  )

static

void DispatchingModuleManager::StringCompletion ( ds_string &  sendstring, const ds_string &  stringToAdd  )

static

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• src/appcore/appcore/dispatching/DispatchingModuleManager.h
• src/appcore/dispatching/DispatchingModuleManager.cpp