Yate
|
Abstract signalling component that can be managed by the engine. More...
#include <yatesig.h>
Public Member Functions | |
virtual | ~SignallingComponent () |
virtual const String & | toString () const |
virtual bool | initialize (const NamedList *config) |
virtual bool | control (NamedList ¶ms) |
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 |
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 |
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.
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
name | Name of this component |
params | Optional pointer to creation parameters |
const String& componentType | ( | ) | const [inline] |
Return the type of this component
Query or modify component's settings or operational parameters
params | The list of parameters to query or change |
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
oper | Optional name of the operation to execute |
virtual bool controlExecute | ( | NamedList * | params | ) | [virtual] |
Execute or postpone a control command
params | Parameter list describing the command, will be destroyed |
int debugLevel | ( | int | level | ) | [inline] |
Conditionally set the debug level of the component
level | Desired debug level, negative for no change |
Reimplemented from DebugEnabler.
References TelEngine::debugLevel().
virtual 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 ISDNQ931Monitor, ISDNQ931, ISDNQ921Passive, ISDNQ921, SS7SCCP, SS7ISUP, SS7MTP3, SS7MTP2, SS7Router, SS7Layer4, TCAPUser, SCCPUser, GTT, AnalogLineGroup, and SignallingCircuitGroup.
Referenced by SignallingCircuitGroup::destroyed(), SS7MTP2::destroyed(), ISDNQ921::destroyed(), ISDNQ921Passive::destroyed(), ISDNQ931::destroyed(), and ISDNQ931Monitor::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.
virtual void engine | ( | SignallingEngine * | eng | ) | [virtual] |
Set the TelEngine::SignallingEngine that manages this component and any subcomponent of it
eng | Pointer to the engine that will manage this component |
Reimplemented in ISDNQ921Management.
SignallingEngine* engine | ( | ) | const [inline] |
Get the TelEngine::SignallingEngine that manages this component
virtual bool initialize | ( | const NamedList * | config | ) | [virtual] |
Configure and initialize the component and any subcomponents it may have
config | Optional configuration parameters override |
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.
component | Pointer to component to insert in engine |
void setCompType | ( | const char * | type | ) | [inline, protected] |
Change the type of the component after it was constructed
type | Type of this component |
void setName | ( | const char * | name | ) | [protected] |
Change the name of the component after it was constructed
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()
usec | Desired time until next engine's timerTick() call in usec |
Method called periodically by the engine to keep everything alive
when | Time 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.
Get the component's name so it can be used for list searches
Reimplemented from GenObject.