ANSI SS7 TCAP transaction implementation. More...

#include <yatesig.h>

Inheritance diagram for SS7TCAPTransactionANSI:

Public Types
enum	TCAPANSIComponentType { CompUnknown = 0x0 , Local = 0x1 , InvokeLast = 0xe9 , ReturnResultLast = 0xea , ReturnError = 0xeb , Reject = 0xec , InvokeNotLast = 0xed , ReturnResultNotLast = 0xee }

enum	ANSITransactionType { Unknown = 0x0 , Unidirectional = 0xe1 , QueryWithPermission = 0xe2 , QueryWithoutPermission = 0xe3 , Response = 0xe4 , ConversationWithPermission = 0xe5 , ConversationWithoutPermission = 0xe6 , Abort = 0xf6 }

Public Types inherited from SS7TCAPTransaction
enum	TransactionState { Idle = 0 , PackageSent = 1 , PackageReceived = 2 , Active = 3 }

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

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

	~SS7TCAPTransactionANSI ()

virtual SS7TCAPError	handleData (NamedList &params, DataBlock &data)

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

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

virtual void	updateToEnd ()

virtual void	updateState (bool byUser)

virtual void	requestContent (NamedList &params, DataBlock &data)

Public Member Functions inherited from SS7TCAPTransaction
	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

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 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)

Public Member Functions inherited from Mutex
	Mutex (bool recursive=false, const char *name=0)

	Mutex (const Mutex &original)

	~Mutex ()

Mutex &	operator= (const Mutex &original)

virtual bool	lock (long maxwait=-1)

virtual bool	unlock ()

virtual bool	locked () const

const char *	owner () const

bool	recursive () const

Public Member Functions inherited from Lockable
virtual	~Lockable ()

virtual bool	lock (long maxwait=-1)=0

virtual bool	unlock ()=0

virtual bool	locked () const =0

virtual bool	check (long maxwait=-1)

virtual bool	unlockAll ()

Static Public Member Functions
static void	encodePAbort (SS7TCAPTransaction *tr, NamedList &params, DataBlock &data)

static SS7TCAPError	decodePAbort (SS7TCAPTransaction *tr, NamedList &params, DataBlock &data)

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 ()

Static Public Member Functions inherited from Mutex
static int	count ()

static int	locks ()

static bool	efficientTimedLock ()

Static Public Member Functions inherited from Lockable
static void	wait (unsigned long maxwait)

static unsigned long	wait ()

static void	startUsingNow ()

static void	enableSafety (bool safe=true)

static bool	safety ()

Static Public Attributes
static const TokenDict	s_ansiTransactTypes []

Additional Inherited Members
Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()

bool	resurrect ()

virtual void	destroyed ()

Protected Attributes inherited from SS7TCAPTransaction
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

ANSI SS7 TCAP transaction implementation.

Implementation of SS7 Transactional Capabilities Application Part Transaction - specification ANSI

Constructor & Destructor Documentation

◆ SS7TCAPTransactionANSI()

SS7TCAPTransactionANSI	(	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

◆ ~SS7TCAPTransactionANSI()

~SS7TCAPTransactionANSI ( )

Destructor

Member Function Documentation

◆ decodePAbort()

static SS7TCAPError decodePAbort	(	SS7TCAPTransaction *	tr,
		NamedList &	params,
		DataBlock &	data
	)

static

Decode P-Abort TCAP message portion

Parameters

tr	The transaction on which the abort was signalled
params	NamedList reference to fill with the decoded P-Abort information
data	DataBlock reference from which to decode P-Abort information

◆ encodePAbort()

static void encodePAbort	(	SS7TCAPTransaction *	tr,
		NamedList &	params,
		DataBlock &	data
	)

static

Encode P-Abort information

Parameters

tr	The transaction on which the abort was signalled
params	NamedList reference from which to get the P-Abort information
data	DataBlock reference in which to insert the encoded P-Abort information

◆ handleData()

virtual SS7TCAPError handleData	(	NamedList &	params,
		DataBlock &	data
	)

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

Implements SS7TCAPTransaction.

◆ handleDialogPortion()

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

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

Implements SS7TCAPTransaction.

◆ requestContent()

virtual void requestContent	(	NamedList &	params,
		DataBlock &	data
	)

virtual

Request content for this transaction

Parameters

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

Implements SS7TCAPTransaction.

◆ update()

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

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

Returns: A TCAP Error

Implements SS7TCAPTransaction.

◆ updateState()

virtual void updateState ( bool byUser )

virtual

Update transaction state

Parameters

byUser True if update is requested by user, false if by remote

Implements SS7TCAPTransaction.

◆ updateToEnd()

virtual void updateToEnd ( )

virtual

Update the state of this transaction to end the transaction

Reimplemented from SS7TCAPTransaction.

Member Data Documentation

◆ s_ansiTransactTypes

const TokenDict s_ansiTransactTypes[]

static

Dictionary keeping string versions of transaction types

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

yatesig.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SS7TCAPTransactionANSI()

◆ ~SS7TCAPTransactionANSI()

Member Function Documentation

◆ decodePAbort()

◆ encodePAbort()

◆ handleData()

◆ handleDialogPortion()

◆ requestContent()

◆ update()

◆ updateState()

◆ updateToEnd()

Member Data Documentation

◆ s_ansiTransactTypes