Yate
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes
SS7TCAPComponent Class Reference

SS7 TCAP component implementation. More...

#include <yatesig.h>

Inheritance diagram for SS7TCAPComponent:
GenObject

List of all members.

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)
SS7TCAPTransactiontransaction ()
void setType (SS7TCAP::TCAPUserCompActions type)
SS7TCAP::TCAPUserCompActions type ()
virtual void setInvokeID (String invokeID)
virtual const StringtoString () const
virtual const StringcorrelationID () const
bool timedOut ()
void setState (TCAPComponentState state)
TCAPComponentState state ()
void resetTimer (NamedList &params, unsigned int index)
SS7TCAP::TCAPComponentOperationClass operationClass ()

Static Public Member Functions

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

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

Component state


Constructor & Destructor Documentation

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

Constructor

Parameters:
typeTCAP type for which to build this component
transTCAP transaction to which this component belongs to
paramsParameters for building component
indexIndex in the list of parameters
virtual ~SS7TCAPComponent ( ) [virtual]

Destructor


Member Function Documentation

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

Build a TCAP Component from a NamedList

Parameters:
typeTCAP type of component
trThe transaction to which this component should belong
paramsParameters for building the component
indexIndex in the list of parameters
Returns:
A pointer to the built SS7TCAPComponent or nil if not all required parameters are present
virtual const String& correlationID ( ) const [inline, virtual]

String representation of this component's Correlation ID

Returns:
String representation of Correlation ID
virtual void fill ( unsigned int  index,
NamedList fillIn 
) [virtual]

Put the information of the component in a NamedList

Parameters:
indexIndex for build parameter names
fillInNamedList to fill with this component's information

Retrieve operation class for this component

Returns:
The class of the operation
void resetTimer ( NamedList params,
unsigned int  index 
)

Reset invocation timer on user request

Parameters:
paramsList of parameters
indexIndex of this component's parameters in the list
virtual void setInvokeID ( String  invokeID) [inline, virtual]

Set the Invoke ID for this component

Parameters:
invokeIDThe invoke ID to assign
void setState ( TCAPComponentState  state)

Set component state

Parameters:
stateThe state to be set
void setTransaction ( SS7TCAPTransaction transact)

Set the transaction to which this component belongs to

Parameters:
transactTCAP transaction
void setType ( SS7TCAP::TCAPUserCompActions  type) [inline]

Set the type for this component

Parameters:
typeThe type of the component
TCAPComponentState state ( ) [inline]

Obtain the component state

Returns:
The component state
bool timedOut ( ) [inline]

Check if the component has timed out

Returns:
True if the component timed out, false otherwise
virtual const String& toString ( ) const [inline, virtual]

String representation of this component's Invoke ID

Returns:
String representation of Invoke ID

Reimplemented from GenObject.

Returns the transaction to which this component belongs to.

Get the type of the component

virtual void update ( NamedList params,
unsigned int  index 
) [virtual]

Update this component's data

Parameters:
paramsUpdate parameters
indexIndex of parameters in the list for the update of this component

Member Data Documentation

const TokenDict s_compStates[] [static]

Dictionary for component states


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