#include <ds_events.h>

Inheritance diagram for DS_Events:

Collaboration diagram for DS_Events:

Public Member Functions
	DS_Events ()

virtual	~DS_Events ()

virtual ds_string	GetName ()

virtual ds_string	GetVersion ()

virtual bool	Init (DispatchingModuleManager *manager)

virtual bool	SendString (DS_Event &event, ds_string &sendString, bool &forceImmediateSending)

virtual bool	PostSendString (DS_Event &event, ds_string &sendString, ds_StringList &sendStringList, bool &forceImmediateSending)

Public Member Functions inherited from DispatchingModuleInterface
	DispatchingModuleInterface ()

virtual	~DispatchingModuleInterface ()

void	Enable ()

void	Disable ()

bool	IsEnabled () const

virtual void	RestartTimer (DS_Event &event)

	DispatchingModuleInterface ()

virtual	~DispatchingModuleInterface ()

void	Enable ()

void	Disable ()

bool	IsEnabled () const

virtual void	RestartTimer (DS_Event &event)

Constructor & Destructor Documentation

DS_Events::DS_Events ( )

DS_Events::~DS_Events ( )

virtual

Member Function Documentation

ds_string DS_Events::GetName ( )

virtual

Pure virtual method returns name of plugin. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: name of plugin

Implements DispatchingModuleInterface.

ds_string DS_Events::GetVersion ( )

virtual

Pure virtual method returns version of plugin in form to be sent. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: version of plugin

Implements DispatchingModuleInterface.

bool DS_Events::Init ( DispatchingModuleManager * manager )

virtual

Pure virtual method reads configuration file and initializes plugin.

Returns: true when configuration has been successfully loaded, false otherwise

Implements DispatchingModuleInterface.

Here is the call graph for this function:

bool DS_Events::PostSendString	(	DS_Event &	event,
		ds_string &	sendString,
		ds_StringList &	sendStringList,
		bool &	forceImmediateSending
	)

virtual

Pure virtual method allows to append some data to sendString which was prepared/modified by plugin in SendString method. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implements DispatchingModuleInterface.

bool DS_Events::SendString	(	DS_Event &	event,
		ds_string &	sendString,
		bool &	forceImmediateSending
	)

virtual

Pure virtual method handles sending request. String is prepared (modified) by plugin depending on occured event and it's configuration. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implements DispatchingModuleInterface.

Here is the call graph for this function:

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

src/appcore/dispatching/ds_events.h
src/appcore/dispatching/ds_events.cpp

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation