CSIPDialogAssocBase Class Reference

#include <mw/sipdialogassocbase.h>

Link against: sipclient

class CSIPDialogAssocBase : public CBase

Inherits from

CSIPDialogAssocBase
- CBase

Protected Attributes
CSIPDialogAssocImplementation *	iImplementation

Public Member Functions
virtual	~CSIPDialogAssocBase()
virtual void	DeletingRefresh(CSIPRefresh &, TUint32)
IMPORT_C const CSIPDialog &	Dialog()
IMPORT_C CSIPDialog &	Dialog()
virtual CSIPRefresh *	FindRefresh(TUint32)
CSIPDialogAssocImplementation &	Implementation()
IMPORT_C TBool	IsNonTargetRefreshRequest(RStringF)
virtual IMPORT_C CSIPClientTransaction *	SendNonTargetRefreshRequestL(RStringF, CSIPMessageElements *)
IMPORT_C RStringF	Type()

Protected Member Functions
	CSIPDialogAssocBase()
void	ConstructL(RStringF, CSIPDialog &)
void	ConstructL(RStringF, CSIPDialog &, CSIPServerTransaction &)

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 SIP dialog associations. It provides services for getting associated SIP dialog, actual dialog association type and for sending non target refresh requests within the dialog association.

Member Attribute Documentation

iImplementation

CSIPDialogAssocImplementation *

iImplementation

[protected]

Implementation instance, CSIPDialogAssocBase owns it

Constructor & Destructor Documentation

CSIPDialogAssocBase ( )

CSIPDialogAssocBase

(

)

[protected]

~CSIPDialogAssocBase ( )

~CSIPDialogAssocBase

(

)

[virtual]

Destructor

Member Function Documentation

ConstructL ( RStringF, CSIPDialog & )

void	ConstructL	(	RStringF	aType,
			CSIPDialog &	aDialog
		)	[protected]

ConstructL ( RStringF, CSIPDialog &, CSIPServerTransaction & )

void	ConstructL	(	RStringF	aType,
			CSIPDialog &	aDialog,
			CSIPServerTransaction &	aTransaction
		)	[protected]

DeletingRefresh ( CSIPRefresh &, TUint32 )

void	DeletingRefresh	(	CSIPRefresh &	aRefresh,
			TUint32	aRefreshId
		)	[virtual]

Dialog ( )

IMPORT_C const CSIPDialog &

Dialog

(

)

const

Gets the dialog this dialog association belongs to

Return Value: associated dialog

Dialog ( )

IMPORT_C CSIPDialog &

Dialog

(

)

Gets dialog this dialog association belongs to

Return Value: associated dialog

FindRefresh ( TUint32 )

CSIPRefresh *

FindRefresh

(

TUint32

aRefreshId

)

[virtual]

Searches for a refresh with the matching id. Default implementation returns NULL. Those classes derived from CSIPDialogAssocBase, which can contain refreshes must implement this function for searching the correct refresh.

Return Value: CSIPRefresh if found, NULL otherwise. The ownership is not transferred.

Implementation ( )

CSIPDialogAssocImplementation &

Implementation

(

)

Returns the implementation instance.

Return Value: CSIPDialogAssocImplementation

IsNonTargetRefreshRequest ( RStringF )

IMPORT_C TBool

IsNonTargetRefreshRequest

(

RStringF

aMethod

)

const

Tests if the request is a non target refresh request

Parameters
aMethod	a method to test

Return Value: ETrue if is non target refresh request; EFalse otherwise

SendNonTargetRefreshRequestL ( RStringF, CSIPMessageElements * )

IMPORT_C CSIPClientTransaction *	SendNonTargetRefreshRequestL	(	RStringF	aMethod,
			CSIPMessageElements *	aElements
		)	[virtual]

Creates SIP request and sends it to the remote target. This function should be used for sending SIP extension requests within dialog assocation that do not cause sip dialog associations to be created. In SIP terms this request is non target refresh request.

Pre-condition: SIPDialog().State() != CSIPDialog::EInit && SIPDialog().State() != CSIPDialog::ETerminated
Dialog().Connection().State() == EActive aMethod != "REGISTER" |"INVITE" | "BYE" | "CANCEL" | "ACK" | "SUBSCRIBE" | "NOTIFY" | "UPDATE" | "PRACK" | "REFER"

Parameters
aElements	contains optional SIP message headers and body. Ownership is transferred.

Return Value: SIP extension client transaction. Ownership is transferred.

Leave Codes
KErrSIPInvalidDialogState	If dialog's state is not correct
KErrArgument	if invalid value has been set to aMethod
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

Capability
NetworkServices

Type ( )

IMPORT_C RStringF

Type

(

)

const

Gets dialog association type.

Return Value: dialog association type e.g. "INVITE", "SUBSCRIBE" etc...