anna::oam::Handler Class Reference

#include <Handler.hpp>

Public Member Functions
	Handler ()
	~Handler ()
virtual void	registerCounter (Module *module, const int &type, const std::string &description, const int &offset) noexcept(false)
virtual void	registerAlarm (Module *module, const int &type, const std::string &description, const int &externalId, const std::string &dynamicVariablesCSL, const int &activationId, const int &cancellationId=-1) noexcept(false)

Protected Member Functions
virtual const counter_data_t *	counterEvent (const Module *module, const int &type, const int &amount) const
virtual const alarm_data_t *	alarmEvent (const Module *module, const char *textPreffix, const char *textSuffix, char textSeparator, bool activation, const int &type, va_list argList) const

Friends
class	Module

Detailed Description

Class used to manage OAM events and registration over a OAM module

Constructor & Destructor Documentation

Handler()

anna::oam::Handler::Handler ( )

inline

Constructor

{;}

~Handler()

anna::oam::Handler::~Handler ( )

inline

Destructor

{;}

Member Function Documentation

alarmEvent()

virtual const alarm_data_t* anna::oam::Handler::alarmEvent ( const Module *  module, const char *  textPreffix, const char *  textSuffix, char  textSeparator, bool  activation, const int &  type, va_list  argList  ) const

protectedvirtual

Event for alarms generated at the module provided. Base implementation trace the event based on #Module::getDefaultAlarmDescription, replacing tags 's' and 'd' by '<%s>' and '<%d>' (for texts and numbers) if they exists, and parsing with dynamic variables passed on activateAlarm()/cancelAlarm() prototypes.

Any re-implementation should invoke base class method.

Parameters

module	Reference OAM module.
textPreffix	Dynamic alarm modification regarding text preffix.
textSuffix	Dynamic alarm modification regarding text suffix.
textSeparator	Dynamic alarm modification regarding text sections separator.
Activation	activation/cancellation indicator.
type	Alarm enum-identification within the own context/module.
argList	Optional parsing data for dynamic-composed text.

Returns

Boolean alarm data for 'type' when registered, NULL if not found

counterEvent()

virtual const counter_data_t* anna::oam::Handler::counterEvent ( const Module *  module, const int &  type, const int &  amount  ) const

protectedvirtual

Event for counters generated at the module provided. Base implementation trace the event based on #Module::getDefaultCounterDescription.

Any re-implementation should invoke base class method.

Parameters

module	Reference OAM module.
type	Counter enum-identification within the own context/module.
amount	Units increased.

Returns

Boolean counter data for 'type' when registered, NULL if not found

registerAlarm()

virtual void anna::oam::Handler::registerAlarm ( Module *  module, const int &  type, const std::string &  description, const int &  externalId, const std::string &  dynamicVariablesCSL, const int &  activationId, const int &  cancellationId = -1  )

inlinevirtualnoexcept

Invokes module alarm registration procedure. Default implementation does nothing specific

Parameters

module

Reference OAM module

See also

anna::oam::Module::registerAlarm

{;}

registerCounter()

virtual void anna::oam::Handler::registerCounter ( Module *  module, const int &  type, const std::string &  description, const int &  offset  )

inlinevirtualnoexcept

Invokes module counter registration procedure. Default implementation does nothing specific

Parameters

module

Reference OAM module

See also

anna::oam::Module::registerCounter

{;}

Friends And Related Function Documentation

Module

friend class Module

friend

---

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

• /tmp/anna/include/anna/core/oam/Handler.hpp