class SS7TCAPTransaction

SS7 TCAP transaction implementation. More...

Contains pure virtuals
Full nameTelEngine::SS7TCAPTransaction
Definition#include <libs/ysig/yatesig.h>
InheritsTelEngine::Mutex [public ], TelEngine::RefObject [public ]
Inherited bySS7TCAPTransactionANSI, SS7TCAPTransactionITU
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Members


Detailed Description

Implementation of SS7 Transactional Capabilities Application Part Transaction

enum TransactionState { Idle = 0, PackageSent = 1, PackageReceived = 2, Active = 3, }

TransactionState

enum TransactionTransmit { NoTransmit = 0, PendingTransmit = 256, Transmitted = 521, }

TransactionTransmit

 SS7TCAPTransaction (SS7TCAP* tcap, SS7TCAP::TCAPUserTransActions type, const String& transactID, NamedList& params, u_int64_t timeout, bool initLocal = true)

SS7TCAPTransaction

Constructor

Parameters:
tcapTCAP holding this transaction
typeInitiating type for transaction
transactIDTransaction ID
paramsDecoded TCAP parameters for building the transaction
timeoutTransaction timeout
initLocalTrue if the transaction was initiated locally, false if not

 ~SS7TCAPTransaction ()

~SS7TCAPTransaction

Destructor

SS7TCAPError  handleData (NamedList& params, DataBlock& data)

handleData

[pure virtual]

Process transaction data and fill the NamedList with the decoded data

Parameters:
paramsNamedList to fill with decoded data
dataData to decode

Returns: A TCAP error encountered whilst decoding

SS7TCAPError  update (SS7TCAP::TCAPUserTransActions type, NamedList& params, bool updateByUser = true)

update

[pure virtual]

An update request for this transaction

Parameters:
typeThe type of transaction to which this transaction should be updated
paramsUpdate parameter
updateByUserTrue if the update is made by the local user, false if it's made by the remote end

Returns: A TCAP Error

SS7TCAPError  handleDialogPortion (NamedList& params,bool byUser = true)

handleDialogPortion

[pure virtual]

Handle TCAP relevant dialog data

Parameters:
paramsNamedList containing (if present) dialog information
byUserTrue if the dialog information is provided by the local user, false otherwise

Returns: A report error

SS7TCAPError  buildComponentError (SS7TCAPError& error, NamedList& params, DataBlock& data)

buildComponentError

[virtual]

Build a Reject component in answer to an encoutered error during decoding of the component portion

Parameters:
errorThe encountered error
paramsDecoded TCAP message parameters
dataDataBlock containing the rest of the coded TCAP message

Returns: A report error

SS7TCAPError  handleComponents (NamedList& params, bool updateByUser = true)

handleComponents

[virtual]

Update components

Parameters:
paramsNamedList reference containing the update information
updateByUserFlag if the update was issued by local user or by remote

Returns: A report error

void  requestComponents (NamedList& params, DataBlock& data)

requestComponents

[virtual]

Request encoding for the components of this transaction

Parameters:
paramsComponents parameters to encode
dataDataBlock reference in which to insert the encoded components

void  transactionData (NamedList& params)

transactionData

[virtual]

Fill the NamedList with transaction portion parameters

Parameters:
paramsNamedList reference to fill with transaction portion parameters

void  requestContent (NamedList& params, DataBlock& data)

requestContent

[pure virtual]

Request content for this transaction

Parameters:
paramsList of parameters of this tranaction
dataData block to fill with encoded content

void  checkComponents ()

checkComponents

[virtual]

Check components for timeouts

inline void  setTransactionType (SS7TCAP::TCAPUserTransActions type)

setTransactionType

Set the current type of transaction primitive

Parameters:
typeThe transaction primitive to be set

inline SS7TCAP::TCAPUserTransActions  transactionType ()

transactionType

Retrieve the current type of primitive that is set for this transaction

Returns: The transaction primitive type

inline void  setState (TransactionState state)

setState

Set the state of this transaction, trigger a transmission pending state

Parameters:
stateThe state to set for the transaction

inline TransactionState  transactionState ()

transactionState

Retrieve the state of this transaction

Returns: The state of this transaction

void  setTransmitState (TransactionTransmit state)

setTransmitState

Set the transmission state for this transaction

Parameters:
stateThe transmission state to be set

inline TransactionTransmit  transmitState ()

transmitState

The transmission state for this transaction

Returns: The current transmission state

inline SS7TCAP*  tcap ()

tcap

The TCAP to which this transaction belongs

Returns: A pointer to the TCAP component

const String&  toString ()

toString

[const]

Get the ID of the transaction so it can be used for list searches

Returns: A reference to the ID

Reimplemented from GenObject.

inline void  setUserName (const String& name)

setUserName

Set the TCAP username to which this transaction belongs

Parameters:
nameThe name of the user to set

const String&  userName ()

userName

Return the name of the TCAP user to which this transaction belongs

Returns: The name of the user

inline bool  basicEnd ()

basicEnd

Check if a basic end was set for this transaction

Returns: True if basic end was specified by the user, false if prearranged end was specified

void  addSCCPAddressing (NamedList& fillParams, bool local)

addSCCPAddressing

Add SCCP Addressing information

Parameters:
fillParamsNamedList to fill with addressing information
localTrue if the information is for the user, otherwise

inline bool  endNow ()

endNow

Check if the flag to end this transaction immediately was set

Returns: True if the end flag was set, false otherwise

inline void  endNow (bool endNow)

endNow

Set the flag to end this transaction immediately

Parameters:
endNowBoolean value to set to the end flag

inline bool  timedOut ()

timedOut

Check if the transaction has timed out

Returns: True if the transaction timed out, false otherwise

SS7TCAPComponent*  findComponent (const String& id)

findComponent

Find a component with given id

Parameters:
idId of component to find

Returns: The component with given id or null

void  updateToEnd ()

updateToEnd

[virtual]

Update the state of this transaction to end the transaction

void  updateState (bool byUser = true)

updateState

[pure virtual]

Update transaction state

Parameters:
byUserTrue if update is requested by user, false if by remote

void  abnormalDialogInfo (NamedList& params)

abnormalDialogInfo

[virtual]

Set information in case of abnormal dialog detection

Parameters:
paramsList of parameters where to set the abnormal dialog information

SS7TCAPError  decodeDialogPortion (NamedList& params, DataBlock& data)

decodeDialogPortion

[pure virtual]

Parameters:
paramsNamedList reference to fill with the decoded dialog information
dataDataBlock reference from which to decode the dialog information

Returns: A TCAP error encountered whilst decoding

void  encodeDialogPortion (NamedList& params, DataBlock& data)

encodeDialogPortion

[pure virtual]

Parameters:
paramsNamedList reference from which to take the dialog information to encode
dataDataBlock reference into which to put the encoded dialog information

SS7TCAPError  decodeComponents (NamedList& params, DataBlock& data)

decodeComponents

[pure virtual]

Parameters:
paramsNamedList reference to fill with the decoded component information
dataDataBlock reference from which to decode the component information

Returns: A TCAP error encountered whilst decoding

void  encodeComponents (NamedList& params, DataBlock& data)

encodeComponents

[pure virtual]

Parameters:
paramsNamedList reference from which to take the component information to encode
dataDataBlock reference into which to put the encoded component information

SS7TCAP* m_tcap

m_tcap

[protected]

SS7TCAP::TCAPType m_tcapType

m_tcapType

[protected]

String m_userName

m_userName

[protected]

String m_localID

m_localID

[protected]

String m_remoteID

m_remoteID

[protected]

SS7TCAP::TCAPUserTransActions m_type

m_type

[protected]

TransactionState m_state

m_state

[protected]

TransactionTransmit m_transmit

m_transmit

[protected]

ObjList m_components

m_components

[protected]

NamedList m_localSCCPAddr

m_localSCCPAddr

[protected]

NamedList m_remoteSCCPAddr

m_remoteSCCPAddr

[protected]

bool m_basicEnd

m_basicEnd

[protected]

bool m_endNow

m_endNow

[protected]

SignallingTimer m_timeout

m_timeout

[protected]


Generated by: paulc on bussard on Mon Feb 10 13:15:47 2014, using kdoc 2.0a54.