TCAPUser Class Reference

Abstract SS7 TCAP user interface. More...

#include <yatesig.h>

Inheritance diagram for TCAPUser:

Public Member Functions
	TCAPUser (const char *name, const NamedList *params=0)
virtual	~TCAPUser ()
virtual void	attach (SS7TCAP *tcap)
virtual bool	tcapIndication (NamedList &params)
SS7TCAP *	tcap () const
virtual bool	managementNotify (SCCP::Type type, NamedList &params)
virtual int	managementState ()
virtual void	destroyed ()
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
void	setTCAP (SS7TCAP *tcap)
Protected Member Functions inherited from SignallingComponent
	SignallingComponent (const char *name=0, const NamedList *params=0, const char *type="unknown")
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)

Friends
class	SS7TCAP

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

Abstract SS7 TCAP user interface.

An interface to a SS7 Transactional Capabilities Application Part user

Constructor & Destructor Documentation

~TCAPUser()

virtual ~TCAPUser ( )

virtual

Destructor, detaches from the TCAP implementation

Member Function Documentation

attach()

virtual void attach ( SS7TCAP * tcap )

virtual

Attach as user to a SS7 TCAP

Parameters

tcap	Pointer to the TCAP to use

References tcap().

destroyed()

virtual void destroyed ( )

virtual

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

Reimplemented from SignallingComponent.

References tcap().

managementNotify()

virtual bool managementNotify ( SCCP::Type type, NamedList & params )

virtual

Received a management notification from SCCP layer

Parameters

type	SCCP management notification type
params	Management notification params

Returns

True or false if the notification was handled bu this user

managementState()

virtual int managementState ( )

virtual

Get TCAP user management state

Returns

The state of the user

tcap()

SS7TCAP * tcap ( ) const

inline

Retrieve the TCAP to which this user is attached

Returns

Pointer to a SS7 TCAP interface or NULL

Referenced by attach(), and destroyed().

tcapIndication()

virtual bool tcapIndication ( NamedList & params )

virtual

Receive a TCAP message from TCAP layer

Parameters

params

The message in NamedList form

Returns

True or false if the message was processed by this user

---

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

• yatesig.h