SignallingCircuitSpan Class Reference

A span in a circuit group. More...

#include <yatesig.h>

Inheritance diagram for SignallingCircuitSpan:

Public Member Functions
virtual	~SignallingCircuitSpan ()
SignallingCircuitGroup *	group () const
const String &	id () const
unsigned int	increment () const
Public Member Functions inherited from SignallingComponent
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)

Protected Member Functions
	SignallingCircuitSpan (const char *id=0, SignallingCircuitGroup *group=0)
Protected Member Functions inherited from SignallingComponent
	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)

Protected Attributes
SignallingCircuitGroup *	m_group
unsigned int	m_increment

Additional Inherited Members
Static Public Member Functions inherited from SignallingComponent
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 ()

Detailed Description

A span in a circuit group.

An interface to a span belonging to a circuit group

Constructor & Destructor Documentation

~SignallingCircuitSpan()

virtual ~SignallingCircuitSpan ( )

virtual

Destructor. Remove from group's queue

SignallingCircuitSpan()

SignallingCircuitSpan ( const char * id = 0, SignallingCircuitGroup * group = 0 )

protected

Constructor

Parameters

id	Optional span id
group	Optional circuit group owning the span's circuits

References group().

Member Function Documentation

group()

SignallingCircuitGroup * group ( ) const

inline

Get the owner of this span

Returns

SignallingCircuitGroup pointer or 0

References m_group.

Referenced by SignallingCircuitSpan().

id()

const String & id ( ) const

inline

Get this span's id

Returns

The id of this span

increment()

unsigned int increment ( ) const

inline

Get the increment in circuit numbers caused by this span

Returns

Circuit number increment for this span

References m_increment.

Member Data Documentation

m_group

SignallingCircuitGroup* m_group

protected

The owner of this span

Referenced by group().

m_increment

unsigned int m_increment

protected

The increment in channel code caused by this span

Referenced by increment().

---

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

• yatesig.h