SS7TCAPComponent Class Reference

SS7 TCAP component implementation. More...

#include <yatesig.h>

Inheritance diagram for SS7TCAPComponent:

Public Types
enum	TCAPComponentState { Idle , OperationPending , OperationSent , WaitForReject }

Public Member Functions
	SS7TCAPComponent (SS7TCAP::TCAPType type, SS7TCAPTransaction *trans, NamedList &params, unsigned int index)
virtual	~SS7TCAPComponent ()
virtual void	update (NamedList &params, unsigned int index)
virtual void	fill (unsigned int index, NamedList &fillIn)
void	setTransaction (SS7TCAPTransaction *transact)
SS7TCAPTransaction *	transaction ()
void	setType (SS7TCAP::TCAPUserCompActions type)
SS7TCAP::TCAPUserCompActions	type ()
virtual void	setInvokeID (String invokeID)
virtual const String &	toString () const
virtual const String &	correlationID () const
bool	timedOut ()
void	setState (TCAPComponentState state)
TCAPComponentState	state ()
void	resetTimer (NamedList &params, unsigned int index)
SS7TCAP::TCAPComponentOperationClass	operationClass ()
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	toString () const
virtual const String &	traceId () const
virtual void *	getObject (const String &name) const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

Static Public Member Functions
static SS7TCAPComponent *	componentFromNamedList (SS7TCAP::TCAPType type, SS7TCAPTransaction *tr, NamedList &params, unsigned int index)
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 ()

Static Public Attributes
static const TokenDict	s_compStates []

Detailed Description

SS7 TCAP component implementation.

Implementation of SS7 Transactional Capabilities Application Part Component

Member Enumeration Documentation

TCAPComponentState

enum TCAPComponentState

Component state

Constructor & Destructor Documentation

SS7TCAPComponent()

SS7TCAPComponent	(	SS7TCAP::TCAPType	type,
		SS7TCAPTransaction *	trans,
		NamedList &	params,
		unsigned int	index
	)

Constructor

Parameters

type	TCAP type for which to build this component
trans	TCAP transaction to which this component belongs to
params	Parameters for building component
index	Index in the list of parameters

~SS7TCAPComponent()

virtual ~SS7TCAPComponent ( )

virtual

Destructor

Member Function Documentation

componentFromNamedList()

static SS7TCAPComponent * componentFromNamedList ( SS7TCAP::TCAPType  type, SS7TCAPTransaction *  tr, NamedList &  params, unsigned int  index  )

static

Build a TCAP Component from a NamedList

Parameters

type	TCAP type of component
tr	The transaction to which this component should belong
params	Parameters for building the component
index	Index in the list of parameters

Returns

A pointer to the built SS7TCAPComponent or nil if not all required parameters are present

correlationID()

virtual const String & correlationID ( ) const

inlinevirtual

String representation of this component's Correlation ID

Returns

String representation of Correlation ID

fill()

virtual void fill ( unsigned int  index, NamedList &  fillIn  )

virtual

Put the information of the component in a NamedList

Parameters

index	Index for build parameter names
fillIn	NamedList to fill with this component's information

operationClass()

SS7TCAP::TCAPComponentOperationClass operationClass ( )

inline

Retrieve operation class for this component

Returns

The class of the operation

resetTimer()

void resetTimer	(	NamedList &	params,
		unsigned int	index
	)

Reset invocation timer on user request

Parameters

params	List of parameters
index	Index of this component's parameters in the list

setInvokeID()

virtual void setInvokeID ( String  invokeID )

inlinevirtual

Set the Invoke ID for this component

Parameters

invokeID

The invoke ID to assign

setState()

void setState

(

TCAPComponentState

state

)

Set component state

Parameters

state

The state to be set

setTransaction()

void setTransaction

(

SS7TCAPTransaction *

transact

)

Set the transaction to which this component belongs to

Parameters

transact

TCAP transaction

setType()

void setType ( SS7TCAP::TCAPUserCompActions  type )

inline

Set the type for this component

Parameters

type	The type of the component

state()

TCAPComponentState state ( )

inline

Obtain the component state

Returns

The component state

timedOut()

bool timedOut ( )

inline

Check if the component has timed out

Returns

True if the component timed out, false otherwise

toString()

virtual const String & toString ( ) const

inlinevirtual

String representation of this component's Invoke ID

Returns

String representation of Invoke ID

Reimplemented from GenObject.

transaction()

SS7TCAPTransaction * transaction

(

)

Returns the transaction to which this component belongs to.

type()

SS7TCAP::TCAPUserCompActions type ( )

inline

Get the type of the component

update()

virtual void update ( NamedList &  params, unsigned int  index  )

virtual

Update this component's data

Parameters

params	Update parameters
index	Index of parameters in the list for the update of this component

Member Data Documentation

s_compStates

const TokenDict s_compStates[]

static

Dictionary for component states

---

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

• yatesig.h