SS7 TCAP transaction implementation. More...

#include <yatesig.h>

Inheritance diagram for SS7TCAPTransaction:

Public Types
enum	TransactionState { Idle = 0, PackageSent = 1, PackageReceived = 2, Active = 3 }
enum	TransactionTransmit { NoTransmit = 0, PendingTransmit = 256, Transmitted = 521 }
Public Member Functions
	SS7TCAPTransaction (SS7TCAP *tcap, SS7TCAP::TCAPUserTransActions type, const String &transactID, NamedList &params, u_int64_t timeout, bool initLocal=true)
	~SS7TCAPTransaction ()
virtual SS7TCAPError	handleData (NamedList &params, DataBlock &data)=0
virtual SS7TCAPError	update (SS7TCAP::TCAPUserTransActions type, NamedList &params, bool updateByUser=true)=0
virtual SS7TCAPError	handleDialogPortion (NamedList &params, bool byUser=true)=0
virtual SS7TCAPError	buildComponentError (SS7TCAPError &error, NamedList &params, DataBlock &data)
virtual SS7TCAPError	handleComponents (NamedList &params, bool updateByUser=true)
virtual void	requestComponents (NamedList &params, DataBlock &data)
virtual void	transactionData (NamedList &params)
virtual void	requestContent (NamedList &params, DataBlock &data)=0
virtual void	checkComponents ()
void	setTransactionType (SS7TCAP::TCAPUserTransActions type)
SS7TCAP::TCAPUserTransActions	transactionType ()
void	setState (TransactionState state)
TransactionState	transactionState ()
void	setTransmitState (TransactionTransmit state)
TransactionTransmit	transmitState ()
SS7TCAP *	tcap ()
const String &	toString () const
void	setUserName (const String &name)
const String &	userName ()
bool	basicEnd ()
void	addSCCPAddressing (NamedList &fillParams, bool local)
bool	endNow ()
void	endNow (bool endNow)
bool	timedOut ()
SS7TCAPComponent *	findComponent (const String &id)
virtual void	updateToEnd ()
virtual void	updateState (bool byUser=true)=0
virtual void	abnormalDialogInfo (NamedList &params)
virtual SS7TCAPError	decodeDialogPortion (NamedList &params, DataBlock &data)=0
virtual void	encodeDialogPortion (NamedList &params, DataBlock &data)=0
virtual SS7TCAPError	decodeComponents (NamedList &params, DataBlock &data)=0
virtual void	encodeComponents (NamedList &params, DataBlock &data)=0
Protected Attributes
SS7TCAP *	m_tcap
SS7TCAP::TCAPType	m_tcapType
String	m_userName
String	m_localID
String	m_remoteID
SS7TCAP::TCAPUserTransActions	m_type
TransactionState	m_state
TransactionTransmit	m_transmit
ObjList	m_components
NamedList	m_localSCCPAddr
NamedList	m_remoteSCCPAddr
bool	m_basicEnd
bool	m_endNow
SignallingTimer	m_timeout

Detailed Description

SS7 TCAP transaction implementation.

Implementation of SS7 Transactional Capabilities Application Part Transaction

Constructor & Destructor Documentation

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

Constructor

Parameters:

tcap	TCAP holding this transaction
type	Initiating type for transaction
transactID	Transaction ID
params	Decoded TCAP parameters for building the transaction
timeout	Transaction timeout
initLocal	True if the transaction was initiated locally, false if not

~SS7TCAPTransaction ( )

Destructor

Member Function Documentation

virtual void abnormalDialogInfo ( NamedList & params ) [virtual]

Set information in case of abnormal dialog detection

Parameters:

params List of parameters where to set the abnormal dialog information

Reimplemented in SS7TCAPTransactionITU.

void addSCCPAddressing	(	NamedList &	fillParams,
		bool	local
	)

Add SCCP Addressing information

Parameters:

fillParams	NamedList to fill with addressing information
local	True if the information is for the user, otherwise

bool basicEnd ( ) [inline]

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

virtual SS7TCAPError buildComponentError	(	SS7TCAPError &	error,
		NamedList &	params,
		DataBlock &	data
	)		`[virtual]`

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

Parameters:

error	The encountered error
params	Decoded TCAP message parameters
data	DataBlock containing the rest of the coded TCAP message

Returns:: A report error

virtual void checkComponents ( ) [virtual]

Check components for timeouts

virtual SS7TCAPError decodeComponents	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Parameters:

params	NamedList reference to fill with the decoded component information
data	DataBlock reference from which to decode the component information

Returns:: A TCAP error encountered whilst decoding

virtual SS7TCAPError decodeDialogPortion	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Parameters:

params	NamedList reference to fill with the decoded dialog information
data	DataBlock reference from which to decode the dialog information

Returns:: A TCAP error encountered whilst decoding

Implemented in SS7TCAPTransactionITU.

virtual void encodeComponents	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Parameters:

params	NamedList reference from which to take the component information to encode
data	DataBlock reference into which to put the encoded component information

virtual void encodeDialogPortion	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Parameters:

params	NamedList reference from which to take the dialog information to encode
data	DataBlock reference into which to put the encoded dialog information

Implemented in SS7TCAPTransactionITU.

bool endNow ( ) [inline]

Check if the flag to end this transaction immediately was set

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

void endNow ( bool endNow ) [inline]

Set the flag to end this transaction immediately

Parameters:

endNow Boolean value to set to the end flag

References SS7TCAPTransaction::endNow().

Referenced by SS7TCAPTransaction::endNow().

SS7TCAPComponent* findComponent ( const String & id )

Find a component with given id

Parameters:

id	Id of component to find

Returns:: The component with given id or null

virtual SS7TCAPError handleComponents	(	NamedList &	params,
		bool	updateByUser = `true`
	)		`[virtual]`

Update components

Parameters:

params	NamedList reference containing the update information
updateByUser	Flag if the update was issued by local user or by remote

Returns:: A report error

virtual SS7TCAPError handleData	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Process transaction data and fill the NamedList with the decoded data

Parameters:

params	NamedList to fill with decoded data
data	Data to decode

Returns:: A TCAP error encountered whilst decoding

Implemented in SS7TCAPTransactionITU, and SS7TCAPTransactionANSI.

virtual SS7TCAPError handleDialogPortion	(	NamedList &	params,
		bool	byUser = `true`
	)		`[pure virtual]`

Handle TCAP relevant dialog data

Parameters:

params	NamedList containing (if present) dialog information
byUser	True if the dialog information is provided by the local user, false otherwise

Returns:: A report error

Implemented in SS7TCAPTransactionITU, and SS7TCAPTransactionANSI.

virtual void requestComponents	(	NamedList &	params,
		DataBlock &	data
	)		`[virtual]`

Request encoding for the components of this transaction

Parameters:

params	Components parameters to encode
data	DataBlock reference in which to insert the encoded components

virtual void requestContent	(	NamedList &	params,
		DataBlock &	data
	)		`[pure virtual]`

Request content for this transaction

Parameters:

params	List of parameters of this tranaction
data	Data block to fill with encoded content

Implemented in SS7TCAPTransactionITU, and SS7TCAPTransactionANSI.

void setState ( TransactionState state ) [inline]

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

Parameters:

state The state to set for the transaction

void setTransactionType ( SS7TCAP::TCAPUserTransActions type ) [inline]

Set the current type of transaction primitive

Parameters:

type	The transaction primitive to be set

void setTransmitState ( TransactionTransmit state )

Set the transmission state for this transaction

Parameters:

state The transmission state to be set

void setUserName ( const String & name ) [inline]

Set the TCAP username to which this transaction belongs

Parameters:

name	The name of the user to set

SS7TCAP* tcap ( ) [inline]

The TCAP to which this transaction belongs

Returns:: A pointer to the TCAP component

bool timedOut ( ) [inline]

Check if the transaction has timed out

Returns:: True if the transaction timed out, false otherwise

const String& toString ( ) const [inline, virtual]

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

Returns:: A reference to the ID

Reimplemented from GenObject.

virtual void transactionData ( NamedList & params ) [virtual]

Fill the NamedList with transaction portion parameters

Parameters:

params NamedList reference to fill with transaction portion parameters

TransactionState transactionState ( ) [inline]

Retrieve the state of this transaction

Returns:: The state of this transaction

SS7TCAP::TCAPUserTransActions transactionType ( ) [inline]

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

Returns:: The transaction primitive type

TransactionTransmit transmitState ( ) [inline]

The transmission state for this transaction

Returns:: The current transmission state

virtual SS7TCAPError update	(	SS7TCAP::TCAPUserTransActions	type,
		NamedList &	params,
		bool	updateByUser = `true`
	)		`[pure virtual]`

An update request for this transaction

Parameters:

type	The type of transaction to which this transaction should be updated
params	Update parameter
updateByUser	True if the update is made by the local user, false if it's made by the remote end