CSIPTransactionBase Class Reference

#include <mw/siptransactionbase.h>

Link against: sipclient

class CSIPTransactionBase : public CBase

Inherits from

CSIPTransactionBase
- CBase

Protected Attributes
MTransactionAssociation *	iAssociation
TUint32	iRequestId

Public Member Enumerations
enum	TState { ETrying, ECalling, EProceeding, ECompleted, ..., EConstructing }

Public Member Functions
virtual	~CSIPTransactionBase()
TBool	AffectsDialogState()
void	ChangeState(CSIPTransactionBase::TState)
virtual void	Detach(const MTransactionAssociation &)
IMPORT_C TBool	IsSIPClientTransaction()
TBool	IsTargetRefresh(RStringF)
TUint32	RequestId()
void	SetAffectsDialogState()
void	SetResponseElements(CSIPResponseElements *)
IMPORT_C CSIPTransactionBase::TState	StateL()
IMPORT_C RStringF	Type()
IMPORT_C TBool	operator==(const CSIPTransactionBase &)

Protected Member Functions
	CSIPTransactionBase(TBool, TUint32, MTransactionAssociation &)
void	CheckAssociationL()
void	ConstructL(RStringF)
const CSIPResponseElements *	ResponseElements()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Base class for managing SIP transactions. It provides services for querying transaction type and its state.

This class is an abstract class and cannot be instantiated.

Member Attribute Documentation

iAssociation

MTransactionAssociation *

iAssociation

[protected]

Every transaction is associated to exactly one other object: CSIP, CSIPConnection, CSIPRegistrationBinding or CSIPDialogAssocBase

iRequestId

TUint32

iRequestId

[protected]

RequestId received from SIP client

Member Enumeration Documentation

Enum TState

SIP transaction state

Enumerator	Value	Description
ETrying		Trying state
ECalling		Calling state
EProceeding		Proceeding state
ECompleted		Completed state
EConfirmed		Confirmed state
ETerminated		Terminated state
EConstructing		Object is being constructed and is not yet ready for use

Constructor & Destructor Documentation

CSIPTransactionBase ( TBool, TUint32, MTransactionAssociation & )

CSIPTransactionBase	(	TBool	aIsClientTransaction,
		TUint32	aRequestId,
		MTransactionAssociation &	aAssociation
	)	[protected]

~CSIPTransactionBase ( )

~CSIPTransactionBase

(

)

[virtual]

Destructor

Member Function Documentation

AffectsDialogState ( )

TBool

AffectsDialogState

(

)

const

Determines whether this transaction has an effect on the associated dialog's state.

Return Value: ETrue if transaction has an effect on the dialog's state, EFalse otherwise.

ChangeState ( CSIPTransactionBase::TState )

void

ChangeState

(

CSIPTransactionBase::TState

aNextState

)

Changes the transaction state.

Parameters
aNextState	State into which transaction moves

CheckAssociationL ( )

void

CheckAssociationL

(

)

const [protected]

Checks that iAssociation is available (not NULL). If iAssociation is NULL, it means user has deleted a resource needed by CSIPTransactionBase, and this function leaves.

ConstructL ( RStringF )

void

ConstructL

(

RStringF

aType

)

[protected]

Detach ( const MTransactionAssociation & )

void

Detach

(

const MTransactionAssociation &

aAssociation

)

[virtual]

Clears the MTransactionAssociation. After this the object can't be used anymore and it is expected that user will delete it soon.

Parameters
aAssociation	Object requesting the detach

IsSIPClientTransaction ( )

IMPORT_C TBool

IsSIPClientTransaction

(

)

const

Checks the if the actual object is of type CSIPClientTransaction.

Return Value: ETrue if object is of type CSIPClientTransaction and EFalse otherwise

IsTargetRefresh ( RStringF )

TBool

IsTargetRefresh

(

RStringF

aType

)

[static]

Determines whether the transaction type is a target refresh request.

Parameters
aType	Type of transaction

Return Value: ETrue If the transaction is a target refresh request, EFalse otherwise.

RequestId ( )

TUint32

RequestId

(

)

const

Obtains the RequestId of the transaction.

Return Value: RequestId

ResponseElements ( )

const CSIPResponseElements *

ResponseElements

(

)

const [protected]

Gets response elements.

Return Value: Response elements. Ownership isn't transferred.

SetAffectsDialogState ( )

void

SetAffectsDialogState

(

)

Sets this transaction to affect the dialog state.

SetResponseElements ( CSIPResponseElements * )

void

SetResponseElements

(

CSIPResponseElements *

aElements

)

Stores response elements. Depending on the status code, transaction may enter another state.

Parameters
aElements	Response elements, ownership is transferred.

StateL ( )

IMPORT_C CSIPTransactionBase::TState

StateL

(

)

Gets SIP transaction state

Return Value: SIP transaction state

Leave Codes
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

Type ( )

IMPORT_C RStringF

Type

(

)

const

Gets the SIP transaction type

Return Value: SIP transaction type

operator== ( const CSIPTransactionBase & )

IMPORT_C TBool

operator==

(

const CSIPTransactionBase &

aTransaction

)

const

Compares this object to another object also having CSIPTransactionBase base class The function has to be implemented in each of the sub-classes.

Parameters
aTransaction	a CSIPTransactionBase object to compare

Return Value: ETrue if the objects are equal otherwise EFalse