SignallingComponent Class Reference

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

#include <yatesig.h>

Inheritance diagram for SignallingComponent:
RefObject DebugEnabler GenObject ISDNLayer2 ISDNLayer3 SignallingCircuitGroup SignallingCircuitSpan SignallingInterface SignallingReceiver SIGTransport SS7ASP SS7L2User SS7L3User SS7Layer2 SS7Layer3 SS7TCAP

List of all members.

Public Member Functions

virtual ~SignallingComponent ()
virtual const StringtoString () const
virtual bool initialize (const NamedList *config)
virtual bool control (NamedList &params)
virtual void engine (SignallingEngine *eng)
SignallingEngineengine () const
int debugLevel (int level)

Protected Member Functions

 SignallingComponent (const char *name=0, const NamedList *params=0)
void destroyed ()
void insert (SignallingComponent *component)
virtual void detach ()
virtual void timerTick (const Time &when)
void setName (const char *name)
unsigned long tickSleep (unsigned long usec=1000000) const

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

virtual ~SignallingComponent (  )  [virtual]

Destructor, detaches the engine and other components

SignallingComponent ( const char *  name = 0,
const NamedList params = 0 
) [protected]

Constructor with a default empty component name

Parameters:
name Name of this component
params Optional pointer to creation parameters

Member Function Documentation

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 SS7Layer2, and SS7MTP3.

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

Reimplemented from DebugEnabler.

References TelEngine::debugLevel().

void destroyed (  )  [protected, virtual]

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

Reimplemented from RefObject.

Reimplemented in SignallingCircuitGroup, AnalogLineGroup, SS7MTP2, SS7MTP3, SS7ISUP, ISDNQ921, ISDNQ921Passive, ISDNQ931, and ISDNQ931Monitor.

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

virtual void detach (  )  [protected, virtual]

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.

SignallingEngine* engine (  )  const [inline]

Get the TelEngine::SignallingEngine that manages this component

Returns:
Pointer to engine or NULL if not managed by an engine
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.

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 SS7Router, SS7MTP2, SS7MTP3, SS7ISUP, ISDNQ921, ISDNQ921Management, ISDNQ921Passive, ISDNQ931, and ISDNQ931Monitor.

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
void setName ( const char *  name  )  [protected]

Change the name of the component after it was constructed

Parameters:
name Name of this component
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
virtual void timerTick ( const Time when  )  [protected, virtual]

Method called periodically by the engine to keep everything alive

Parameters:
when Time to use as computing base for events and timeouts

Reimplemented in SS7MTP2, SS7ISUP, ISDNQ921, ISDNQ921Management, ISDNQ921Passive, ISDNQ931, and ISDNQ931Monitor.

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:
Generated on Thu Apr 8 18:19:44 2010 for Yate by  doxygen 1.6.3