Class CSIPDialogAssocBase

class CSIPDialogAssocBase : public CBase;

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPDialogAssocBase - Base class for SIP dialog associations

Members

Defined in CSIPDialogAssocBase:
Dialog(), Dialog(), IsNonTargetRefreshRequest(), SendNonTargetRefreshRequestL(), Type()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C const CSIPDialog &Dialog() const;

Description

Gets the dialog this dialog association belongs to

Return value

const CSIPDialog & associated dialog

IMPORT_C CSIPDialog &Dialog();

Description

Gets dialog this dialog association belongs to

Return value

CSIPDialog & associated dialog

Capability:

NetworkServices

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

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"

Description

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.

Parameters

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

Return value

CSIPClientTransaction * 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

IMPORT_C RStringF Type() const;

Description

Gets dialog association type.

Return value

RStringF dialog association type e.g. "INVITE", "SUBSCRIBE" etc...

IMPORT_C TBool IsNonTargetRefreshRequest(RStringF aMethod) const;

Description

Tests if the request is a non target refresh request

Parameters

RStringF aMethod a method to test

Return value

TBool ETrue if is non target refresh request; EFalse otherwise