CSIPClientTransaction Class Reference

#include <mw/sipclienttransaction.h>

Link against: sipclient

class CSIPClientTransaction : public CSIPTransactionBase

Inherits from

CSIPClientTransaction
- CSIPTransactionBase
  - CBase

Public Member Functions
	~CSIPClientTransaction()
virtual IMPORT_C TBool	CancelAllowed()
IMPORT_C CSIPClientTransaction *	CancelL()
CSIPClientTransaction *	NewL(RStringF, MTransactionAssociation &, CSIPRefresh *)
CSIPClientTransaction *	NewLC(RStringF, MTransactionAssociation &, CSIPRefresh *)
IMPORT_C const CSIPRefresh *	Refresh()
CSIPRefresh *	Refresh()
void	RemoveRefresh()
IMPORT_C const CSIPResponseElements *	ResponseElements()
void	SetRequestId(TUint32)

Protected Member Functions
	CSIPClientTransaction(MTransactionAssociation &, CSIPRefresh *)

Inherited Attributes
	CSIPTransactionBase::iAssociation
	CSIPTransactionBase::iRequestId

Inherited Enumerations
	CSIPTransactionBase:TState

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

Detailed Description

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.

Constructor & Destructor Documentation

CSIPClientTransaction ( MTransactionAssociation &, CSIPRefresh * )

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

~CSIPClientTransaction ( )

IMPORT_C

~CSIPClientTransaction

(

)

Destructor

Member Function Documentation

CancelAllowed ( )

IMPORT_C TBool

CancelAllowed

(

)

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.

Return Value: ETrue if client transaction can be cancelled; EFalse otherwise

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

Return Value: SIP CANCEL transaction, ownership is transferred.

Leave Codes
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.
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

Capability
NetworkServices

NewL ( RStringF, MTransactionAssociation &, CSIPRefresh * )

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

Instantiates a CSIPClientTransaction object, leaves on failure.

Parameters
aType	Identifies the transaction type
aAssociation	Object to which the transaction is associated with.
aRefresh	If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.

Return Value: SIP client transaction, ownership is transferred.

NewLC ( RStringF, MTransactionAssociation &, CSIPRefresh * )

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

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

Parameters
aType	Identifies the transaction type
aAssociation	Object to which the transaction is associated with.
aRefresh	If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.

Return Value: SIP client transaction, ownership is 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.

Return Value: associated refresh or 0-pointer if there's no associated refresh. Ownership isn't transferred.

Refresh ( )

CSIPRefresh *

Refresh

(

)

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

Return Value: associated refresh or 0-pointer if there's no associated refresh. Ownership isn't transferred.

RemoveRefresh ( )

void

RemoveRefresh

(

)

Clears the association from ClientTransaction to CSIPRefresh

ResponseElements ( )

IMPORT_C const CSIPResponseElements *

ResponseElements

(

)

const

Reimplemented from CSIPTransactionBase::ResponseElements()const

Gets response elements of the most recent response.

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

SetRequestId ( TUint32 )

void

SetRequestId

(

TUint32

aRequestId

)

Sets the RequestId.

Pre-condition: iRequestId == 0
aRequestId != 0

Parameters
aRequestId	RequestId obtained from SIP client