Collapse all Symbian^3 Application Developer Library

CSIPTransactionBase Class Reference

class CSIPTransactionBase : public CBase

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. sipclient

Inherits from

CSIPTransactionBase
- CBase

Public Member Functions
	~CSIPTransactionBase ()
TBool	AffectsDialogState ()
void	ChangeState ( CSIPTransactionBase::TState )
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 ()

Private Member Functions
void	__DbgTestInvariant ()

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

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

Protected Attributes
MTransactionAssociation *	iAssociation
TUint32	iRequestId

Private Attributes
TBool	iAffectsDialogState
TBool	iIsClientTransaction
CSIPResponseElements *	iResponseElements
CSIPTransactionBase::TState	iState
RStringF	iType

Constructor & Destructor Documentation

CSIPTransactionBase(TBool, TUint32, MTransactionAssociation &)

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

Parameters

TBool aIsClientTransaction
TUint32 aRequestId
MTransactionAssociation & aAssociation

~CSIPTransactionBase()

~CSIPTransactionBase

(

)

[virtual]

Destructor

Member Functions Documentation

AffectsDialogState()

TBool

AffectsDialogState

(

)

const

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

ChangeState(CSIPTransactionBase::TState)

void

ChangeState

(

CSIPTransactionBase::TState

aNextState

)

Changes the transaction state.

Parameters

CSIPTransactionBase::TState 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]

Parameters

RStringF aType

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

const MTransactionAssociation & aAssociation

Object requesting the detach

IsSIPClientTransaction()

IMPORT_C TBool

IsSIPClientTransaction

(

)

const

Checks the if the actual object is of type CSIPClientTransaction .

IsTargetRefresh(RStringF)

TBool

IsTargetRefresh

(

RStringF

aType

)

[static]

Determines whether the transaction type is a target refresh request.

Parameters

RStringF aType

Type of transaction

RequestId()

TUint32

RequestId

(

)

const

Obtains the RequestId of the transaction.

ResponseElements()

const CSIPResponseElements *

ResponseElements

(

)

const [protected]

Gets response elements.

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

CSIPResponseElements * aElements

Response elements, ownership is transferred.

StateL()

IMPORT_C CSIPTransactionBase::TState

StateL

(

)

Gets SIP transaction state

leave: KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted

Type()

IMPORT_C RStringF

Type

(

)

const

Gets the SIP transaction type

__DbgTestInvariant()

void

__DbgTestInvariant

(

)

const [private]

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

const CSIPTransactionBase & aTransaction

a CSIPTransactionBase object to compare

Member Enumerations Documentation

Enum TState

SIP transaction state

Enumerators

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