CSIPClientTransaction Class Reference

class CSIPClientTransaction : public CSIPTransactionBase

Class for managing SIP client transactions. It provides services for ending and getting the SIP client transaction parameters. Some client transactions can also be canceled.

The user of the class cannot instante this class. sipclient

Inherits from

Public Member Functions
~CSIPClientTransaction()
IMPORT_C TBoolCancelAllowed()
IMPORT_C CSIPClientTransaction *CancelL()
CSIPClientTransaction *NewL(RStringF, MTransactionAssociation &, CSIPRefresh *)
CSIPClientTransaction *NewLC(RStringF, MTransactionAssociation &, CSIPRefresh *)
IMPORT_C const CSIPRefresh *Refresh()
CSIPRefresh *Refresh()
voidRemoveRefresh()
IMPORT_C const CSIPResponseElements *ResponseElements()
voidSetRequestId(TUint32)
Protected Member Functions
CSIPClientTransaction(MTransactionAssociation &, CSIPRefresh *)
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()
CSIPTransactionBase::AffectsDialogState()const
CSIPTransactionBase::CSIPTransactionBase(TBool,TUint32,MTransactionAssociation &)
CSIPTransactionBase::ChangeState(CSIPTransactionBase::TState)
CSIPTransactionBase::CheckAssociationL()const
CSIPTransactionBase::ConstructL(RStringF)
CSIPTransactionBase::Detach(const MTransactionAssociation &)
CSIPTransactionBase::IsSIPClientTransaction()const
CSIPTransactionBase::IsTargetRefresh(RStringF)
CSIPTransactionBase::RequestId()const
CSIPTransactionBase::SetAffectsDialogState()
CSIPTransactionBase::SetResponseElements(CSIPResponseElements *)
CSIPTransactionBase::StateL()
CSIPTransactionBase::Type()const
CSIPTransactionBase::operator==(const CSIPTransactionBase &)const
CSIPTransactionBase::~CSIPTransactionBase()
Inherited Enumerations
CSIPTransactionBase:TState
Private Attributes
CSIPRefresh *iRefresh
Inherited Attributes
CSIPTransactionBase::iAssociation
CSIPTransactionBase::iRequestId

Constructor & Destructor Documentation

CSIPClientTransaction(MTransactionAssociation &, CSIPRefresh *)

CSIPClientTransaction(MTransactionAssociation &aAssociation,
CSIPRefresh *aRefresh
)[protected]

Parameters

MTransactionAssociation & aAssociation
CSIPRefresh * aRefresh

~CSIPClientTransaction()

IMPORT_C~CSIPClientTransaction()

Destructor

Member Functions Documentation

CancelAllowed()

IMPORT_C TBoolCancelAllowed()const [virtual]

Checks if the client transaction is such that it can be cancelled. This does no check whether the transaction is currently in such a state that the canceling can be done now.

CancelL()

IMPORT_C CSIPClientTransaction *CancelL()
Cancels client transaction i.e. creates a CANCEL request and sends it to the remote UA.
Pre-condition
State()==EProceeding
CancelAllowed()==ETrue
Connection().State()==EActive
leave
KErrSIPInvalidTransactionState if canceling is not possible at all, or because the transaction is not in a proper state or the transaction is not related to a dialog.
leave
KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted
capability
NetworkServices

NewL(RStringF, MTransactionAssociation &, CSIPRefresh *)

CSIPClientTransaction *NewL(RStringFaType,
MTransactionAssociation &aAssociation,
CSIPRefresh *aRefresh = 0
)[static]

Instantiates a CSIPClientTransaction object, leaves on failure.

Parameters

RStringF aTypeIdentifies the transaction type
MTransactionAssociation & aAssociationObject to which the transaction is associated with.
CSIPRefresh * aRefresh = 0If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.

NewLC(RStringF, MTransactionAssociation &, CSIPRefresh *)

CSIPClientTransaction *NewLC(RStringFaType,
MTransactionAssociation &aAssociation,
CSIPRefresh *aRefresh = 0
)[static]

Instantiates a CSIPClientTransaction object and pushes it into CleanupStack, leaves on failure.

Parameters

RStringF aTypeIdentifies the transaction type
MTransactionAssociation & aAssociationObject to which the transaction is associated with.
CSIPRefresh * aRefresh = 0If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.

Refresh()

IMPORT_C const CSIPRefresh *Refresh()const

Gets the associated refresh with the transaction. If the refresh is associated with the transaction, transaction will be refreshed at defined interval.

Refresh()

CSIPRefresh *Refresh()

Gets the associated refresh with the transaction and allows modification fo the refresh. This method is for internal use only.

RemoveRefresh()

voidRemoveRefresh()

Clears the association from ClientTransaction to CSIPRefresh

ResponseElements()

IMPORT_C const CSIPResponseElements *ResponseElements()const

Gets response elements of the most recent response.

SetRequestId(TUint32)

voidSetRequestId(TUint32aRequestId)

Sets the RequestId.

Pre-condition
iRequestId == 0
aRequestId != 0

Parameters

TUint32 aRequestIdRequestId obtained from SIP client

Member Data Documentation

CSIPRefresh * iRefresh

CSIPRefresh *iRefresh[private]