CSIPDialogAssocBase Class Reference

class CSIPDialogAssocBase : public CBase

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

Inherits from

Constructor & Destructor Documentation

CSIPDialogAssocBase()

CSIPDialogAssocBase ( ) [protected]

~CSIPDialogAssocBase()

~CSIPDialogAssocBase ( ) [virtual]

Destructor

Member Functions Documentation

ConstructL(RStringF, CSIPDialog &)

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

Parameters

RStringF aType
CSIPDialog & aDialog

ConstructL(RStringF, CSIPDialog &, CSIPServerTransaction &)

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

Parameters

RStringF aType
CSIPDialog & aDialog
CSIPServerTransaction & aTransaction

DeletingRefresh(CSIPRefresh &, TUint32)

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

Parameters

CSIPRefresh & aRefresh
TUint32 aRefreshId

Dialog()

IMPORT_C const CSIPDialog & Dialog ( ) const

Gets the dialog this dialog association belongs to

Dialog()

IMPORT_C CSIPDialog & Dialog ( )

Gets dialog this dialog association belongs to

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.

Parameters

TUint32 aRefreshId

Implementation()

CSIPDialogAssocImplementation & Implementation ( )

Returns the implementation instance.

IsNonTargetRefreshRequest(RStringF)

IMPORT_C TBool IsNonTargetRefreshRequest ( RStringF aMethod ) const

Tests if the request is a non target refresh request

Parameters

RStringF aMethod a method to test

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"
leave
KErrSIPInvalidDialogState If dialog's state is not correct
leave
KErrArgument if invalid value has been set to aMethod
leave
KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted
capability
NetworkServices

Parameters

RStringF aMethod
CSIPMessageElements * aElements contains optional SIP message headers and body. Ownership is transferred.

Type()

IMPORT_C RStringF Type ( ) const

Gets dialog association type.

__DbgTestInvariant()

void __DbgTestInvariant ( ) const [private]

Member Data Documentation

CSIPDialogAssocImplementation * iImplementation

CSIPDialogAssocImplementation * iImplementation [protected]

Implementation instance, CSIPDialogAssocBase owns it