SignallingComponent Class Reference

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

#include <yatesig.h>

Inheritance diagram for SignallingComponent:

GenObject DebugEnabler ISDNLayer2 ISDNLayer3 SignallingCircuitGroup SignallingInterface SignallingReceiver SS7ASP SS7L2User SS7L3User SS7Layer2 SS7Layer3 SS7TCAP

List of all members.

Public Member Functions

virtual ~SignallingComponent ()
virtual const StringtoString () const
SignallingEngineengine () const

Protected Member Functions

 SignallingComponent (const char *name=0)
void insert (SignallingComponent *component)
virtual void detach ()
virtual void timerTick (const Time &when)
void setName (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

virtual ~SignallingComponent (  )  [virtual]

Destructor, detaches the engine and other components

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

Constructor with a default empty component name

Parameters:
name Name of this component


Member Function Documentation

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.

SignallingEngine* engine (  )  const [inline]

Get the TelEngine::SignallingEngine that manages this component

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

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

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 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, ISDNQ921Pasive, ISDNQ931, and ISDNQ931Monitor.

void setName ( const char *  name  )  [protected]

Change the name of the component after it was constructed

Parameters:
name Name of this component


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

Generated on Mon Aug 11 16:17:54 2008 for Yate by  doxygen 1.5.6