Yate
Public Member Functions | Protected Member Functions | Friends
SignallingComponent Class Reference

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

#include <yatesig.h>

Inheritance diagram for SignallingComponent:
RefObject DebugEnabler GenObject GTT ISDNLayer2 ISDNLayer3 SCCP SCCPManagement SCCPUser SIGAdaptation SignallingCircuitGroup SignallingCircuitSpan SignallingInterface SignallingReceiver SIGTransport SS7L2User SS7L3User SS7Layer2 SS7Layer3 TCAPUser

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 NamedListcontrolCreate (const char *oper=0)
virtual bool controlExecute (NamedList *params)
virtual void engine (SignallingEngine *eng)
SignallingEngineengine () const
int debugLevel (int level)
const StringcomponentType () const

Protected Member Functions

 SignallingComponent (const char *name=0, const NamedList *params=0)
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

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:
nameName of this component
paramsOptional pointer to creation parameters

Member Function Documentation

const String& componentType ( ) const [inline]

Return the type of this component

Returns:
A string version of the component type
virtual bool control ( NamedList params) [virtual]

Query or modify component's settings or operational parameters

Parameters:
paramsThe list of parameters to query or change
Returns:
True if the control operation was executed

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

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

Create a parameter list adequate to control this component

Parameters:
operOptional name of the operation to execute
Returns:
A new parameter list or descendant object, NULL if not supported
virtual bool controlExecute ( NamedList params) [virtual]

Execute or postpone a control command

Parameters:
paramsParameter list describing the command, will be destroyed
Returns:
True if the command was accepted (but not necessarily executed)
int debugLevel ( int  level) [inline]

Conditionally set the debug level of the component

Parameters:
levelDesired debug level, negative for no change
Returns:
Current debug level

Reimplemented from DebugEnabler.

References TelEngine::debugLevel().

virtual void destroyed ( ) [protected, virtual]
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.

virtual void engine ( SignallingEngine eng) [virtual]

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

Parameters:
engPointer to the engine that will manage this component

Reimplemented in ISDNQ921Management.

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 bool initialize ( const NamedList config) [virtual]

Configure and initialize the component and any subcomponents it may have

Parameters:
configOptional configuration parameters override
Returns:
True if the component was initialized properly

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

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:
componentPointer to component to insert in engine
void setCompType ( const char *  type) [inline, protected]

Change the type of the component after it was constructed

Parameters:
typeType of this component
void setName ( const char *  name) [protected]

Change the name of the component after it was constructed

Parameters:
nameName 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:
usecDesired 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:
whenTime to use as computing base for events and timeouts

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

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: