Abstract signalling component that can be managed by the engine. More...

#include <yatesig.h>

Inheritance diagram for SignallingComponent:

Public Member Functions
virtual	~SignallingComponent ()

virtual const String &	toString () const

virtual bool	initialize (const NamedList *config)

virtual bool	control (NamedList &params)

virtual NamedList *	controlCreate (const char *oper=0)

virtual bool	controlExecute (NamedList *params)

virtual void	engine (SignallingEngine *eng)

SignallingEngine *	engine () const

int	debugLevel (int level)

const String &	componentType () const

Public Member Functions inherited from RefObject
	RefObject ()

virtual	~RefObject ()

virtual void *	getObject (const String &name) const

virtual bool	alive () const

bool	ref ()

bool	deref ()

int	refcount () const

virtual void	destruct ()

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual const String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Public Member Functions inherited from DebugEnabler
	DebugEnabler (int level=TelEngine::debugLevel(), bool enabled=true)

int	debugLevel () const

int	debugLevel (int level)

bool	debugEnabled () const

void	debugEnabled (bool enable)

const char *	debugName () const

bool	debugAt (int level) const

bool	debugChained () const

void	debugChain (const DebugEnabler *chain=0)

void	debugCopy (const DebugEnabler *original=0)

Static Public Member Functions
static bool	resolveConfig (const String &cmpName, NamedList &params, const NamedList *config)

Static Public Member Functions inherited from RefObject
static bool	alive (const RefObject *obj)

static bool	efficientIncDec ()

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Protected Member Functions
	SignallingComponent (const char name=0, const NamedList params=0, const char *type="unknown")

virtual void	destroyed ()

void	insert (SignallingComponent *component)

virtual void	detach ()

virtual void	timerTick (const Time &when)

void	setName (const char *name)

void	setCompType (const char *type)

unsigned long	tickSleep (unsigned long usec=1000000) const

Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()

bool	resurrect ()

Protected Member Functions inherited from DebugEnabler
void	debugName (const char *name)

Friends
class	SignallingEngine

Detailed Description

Abstract signalling component that can be managed by the engine.

Interface to an abstract signalling component that is managed by an engine. The engine will periodically poll each component to keep them alive.

Constructor & Destructor Documentation

◆ ~SignallingComponent()

virtual ~SignallingComponent ( )

virtual

Destructor, detaches the engine and other components

◆ SignallingComponent()

SignallingComponent	(	const char *	name = 0,
		const NamedList *	params = 0,
		const char *	type = "unknown" )

protected

Constructor with a default empty component name

Parameters

name	Name of this component
params	Optional pointer to creation parameters
type	Default component type string

Referenced by insert(), ISDNLayer3::ISDNLayer3(), and SIGTransport::SIGTransport().

Member Function Documentation

◆ componentType()

const String & componentType ( ) const

inline

Return the type of this component

Returns: A string version of the component type

◆ control()

virtual bool control ( NamedList & params )

virtual

Query or modify component's settings or operational parameters

Parameters

params The list of parameters to query or change

Returns: True if the control operation was executed

Reimplemented in SS7ISUP, SS7Layer2, SS7M2PA, SS7Management, SS7MTP3, SS7Router, SS7SCCP, and SS7Testing.

◆ controlCreate()

virtual NamedList * controlCreate ( const char * oper = 0 )

virtual

Create a parameter list adequate to control this component

Parameters

oper	Optional name of the operation to execute

Returns: A new parameter list or descendant object, NULL if not supported

◆ controlExecute()

virtual bool controlExecute ( NamedList * params )

virtual

Execute or postpone a control command

Parameters

params Parameter list describing the command, will be destroyed

Returns: True if the command was accepted (but not necessarily executed)

◆ debugLevel()

int debugLevel ( int level )

inline

Conditionally set the debug level of the component

Parameters

level Desired debug level, negative for no change

Returns: Current debug level

References DebugEnabler::debugLevel().

◆ destroyed()

virtual void destroyed ( )

protectedvirtual

This method is called to clean up and destroy the object after the reference counter becomes zero

Reimplemented from RefObject.

Reimplemented in AnalogLineGroup, GTT, ISDNQ921, ISDNQ921Passive, ISDNQ931, ISDNQ931Monitor, SCCPUser, SignallingCircuitGroup, SS7ISUP, SS7Layer4, SS7M2PA, SS7MTP2, SS7MTP3, SS7Router, SS7SCCP, and TCAPUser.

Referenced by ISDNQ921::destroyed(), ISDNQ921Passive::destroyed(), SignallingCircuitGroup::destroyed(), and SS7MTP2::destroyed().

◆ detach()

virtual void detach ( )

protectedvirtual

Detach this component from all its links - components and engine. Reimplement this method in all components that keep pointers to other components. The default implementation detaches from the engine.

◆ engine() [1/2]

SignallingEngine * engine ( ) const

inline

Get the TelEngine::SignallingEngine that manages this component

Returns: Pointer to engine or NULL if not managed by an engine

◆ engine() [2/2]

virtual void engine ( SignallingEngine * eng )

virtual

Set the TelEngine::SignallingEngine that manages this component and any subcomponent of it

Parameters

eng	Pointer to the engine that will manage this component

Reimplemented in ISDNQ921Management.

◆ initialize()

virtual bool initialize ( const NamedList * config )

virtual

Configure and initialize the component and any subcomponents it may have

Parameters

config Optional configuration parameters override

Returns: True if the component was initialized properly

Reimplemented in GTT, ISDNIUA, ISDNQ921, ISDNQ921Management, ISDNQ921Passive, ISDNQ931, ISDNQ931Monitor, SCCPManagement, SCCPUser, SIGAdaptation, SIGTransport, SS7ISUP, SS7Layer3, SS7Layer4, SS7M2PA, SS7M2UA, SS7MTP2, SS7MTP3, SS7Router, SS7SCCP, SS7TCAP, and SS7Testing.

◆ insert()

void insert ( SignallingComponent * component )

protected

Insert another component in the same engine as this one. This method should be called for every component we attach.

Parameters

component Pointer to component to insert in engine

References SignallingComponent().

◆ resolveConfig()

static bool resolveConfig	(	const String &	cmpName,
		NamedList &	params,
		const NamedList *	config )

static

Choose parameters that should be used for object initialization

Parameters

cmpName	The name of the parameter holding the component name
params	The list of parameters used to initialize the component
config	The received list of parameters

Returns: True if the config was resolved

◆ setCompType()

void setCompType ( const char * type )

inlineprotected

Change the type of the component after it was constructed

Parameters

type	Type of this component

◆ setName()

void setName ( const char * name )

protected

Change the name of the component after it was constructed

Parameters

name	Name of this component

◆ tickSleep()

unsigned long tickSleep ( unsigned long usec = 1000000 ) const

protected

Adjust (decrease only) the desired maximum time until next tick. Can be called only from within timerTick()

Parameters

usec	Desired time until next engine's timerTick() call in usec

Returns: Timer sleep in usec after applying the current change

◆ timerTick()

virtual void timerTick ( const Time & when )

protectedvirtual

Method called periodically by the engine to keep everything alive

Parameters

when	Time to use as computing base for events and timeouts

Reimplemented in ISDNQ921, ISDNQ921Management, ISDNQ921Passive, ISDNQ931, ISDNQ931Monitor, SCCPManagement, SIGAdaptation, SS7ISUP, SS7Layer2, SS7M2PA, SS7M2UA, SS7Management, SS7MTP2, SS7MTP3, SS7Router, SS7SCCP, SS7TCAP, and SS7Testing.

◆ toString()

virtual const String & toString ( ) const

virtual

Get the component's name so it can be used for list searches

Returns: A reference to the name by which the component is known to engine

Reimplemented from GenObject.

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

yatesig.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~SignallingComponent()

◆ SignallingComponent()

Member Function Documentation

◆ componentType()

◆ control()

◆ controlCreate()

◆ controlExecute()

◆ debugLevel()

◆ destroyed()

◆ detach()

◆ engine() [1/2]

◆ engine() [2/2]

◆ initialize()

◆ insert()

◆ resolveConfig()

◆ setCompType()

◆ setName()

◆ tickSleep()

◆ timerTick()

◆ toString()