anna::diameter::comm::OamModule Class Reference

#include <OamModule.hpp>

Inheritance diagram for anna::diameter::comm::OamModule:

Collaboration diagram for anna::diameter::comm::OamModule:

Classes
struct	Alarm
struct	Counter

Public Member Functions
std::string	getDefaultInternalAlarmDescription (const int &alarmType) const
std::string	getDefaultInternalCounterDescription (const int &counterType) const
Public Member Functions inherited from anna::oam::Module
	Module (const std::string &name)
virtual	~Module ()
int	scopes () const
void	enableCounters (void)
void	disableCounters (void)
void	enableAlarms (void)
void	disableAlarms (void)
bool	countersEnabled () const
bool	alarmsEnabled () const
void	enableAlarmsPreffix (void)
void	enableAlarmsSuffix (void)
void	disableAlarmsPreffix (void)
void	disableAlarmsSuffix (void)
void	setHandler (Handler *handler)
void	initializeCounterScope (const int &scopeId, const std::string &description="") noexcept(false)
void	setActiveCounterScope (const int &scopeId)
const anna::oam::CounterScope *	getActiveCounterScope () const
void	registerCounter (const int &type, const std::string &description, const int &offset) noexcept(false)
void	registerAlarm (const int &type, const std::string &description, const int &externalId, const std::string &dynamicVariablesCSL, const int &activationId, const int &cancellationId=-1) noexcept(false)
const char *	getName () const
const counter_data_t *	counter (const int &type) const
const alarm_data_t *	alarm (const int &type) const
void	count (const int &type, const int &amount=1) noexcept(false)
int	resetCounters (const int &scopeId=-1)
void	setCounterRecorder (CounterRecorder *counterRecorder)
void	recordCounters () noexcept(false)
void	activateAlarm (int type,...) const noexcept(false)
void	cancelAlarm (int type,...) const noexcept(false)
virtual std::string	asString (void) const
virtual anna::xml::Node *	asXML (anna::xml::Node *parent) const

Friends
class	anna::Singleton< OamModule >

Additional Inherited Members
Static Public Member Functions inherited from anna::Singleton< OamModule >
static OamModule &	instantiate ()
static void	release ()
Static Public Attributes inherited from anna::oam::Module
static const int	MaxScope = 1000
Protected Member Functions inherited from anna::oam::Module
virtual void	readAlarmPreffixComponents (std::vector< std::string > &components) const
virtual void	readAlarmSuffixComponents (std::vector< std::string > &components) const

Member Function Documentation

getDefaultInternalAlarmDescription()

std::string anna::diameter::comm::OamModule::getDefaultInternalAlarmDescription ( const int &  type ) const

inlinevirtual

Child oam module classes should define descriptions for each enum type. A good practice would be the use of 'anna_declare_enum' macro in order to define names for enum types. This is an oam-internal description which should be redefined at application layer during registering. Returns undefined by default.

Parameters

type	Counter enum-identification within the own context/module

Returns

Default alarm description

Reimplemented from anna::oam::Module.

{ return Alarm::asCString((Alarm::_v)alarmType); }

getDefaultInternalCounterDescription()

std::string anna::diameter::comm::OamModule::getDefaultInternalCounterDescription ( const int &  type ) const

inlinevirtual

Child oam module classes should define descriptions for each enum type. A good practice would be the use of 'anna_declare_enum' macro in order to define names for enum types. This is an oam-internal description which should be redefined at application layer during registering. Returns undefined by default.

Parameters

type	Counter enum-identification within the own context/module

Returns

Default counter description

Reimplemented from anna::oam::Module.

{ return Counter::asCString((Counter::_v)counterType); }

Friends And Related Function Documentation

anna::Singleton< OamModule >

friend class anna::Singleton< OamModule >

friend

---

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

• /tmp/anna/include/anna/diameter.comm/OamModule.hpp