Class CSIPDialog

class CSIPDialog : public CBase;

Description

Class for managing SIP dialogs. It provides services querying dialog state, obtaining the dialog related SIP headers and getting all dialog associations.

The user of the class cannot instantiate this class. sipclient

Derivation

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

• CSIPDialog - Class for managing SIP dialogs

Members

Defined in CSIPDialog:
CallIdL(), Connection(), Connection(), EConfirmed, EEarly, EInit, ETerminated, FromHeader(), IsAssociated(), RegistrationContext(), RemoteURI(), SIPDialogAssociations(), State(), TState, ToHeader(), operator==()

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

IMPORT_C CSIPDialog::TState State() const;

Description

Gets dialog state

Return value

CSIPDialog::TState dialog state

IMPORT_C const RPointerArray< CSIPDialogAssocBase > &SIPDialogAssociations() const;

Description

Gets all dialog associations.

Return value

const RPointerArray< CSIPDialogAssocBase > & All dialog associations. Ownership of the array or the items inside it, is not transferred.

IMPORT_C const MSIPRegistrationContext *RegistrationContext() const;

Description

Gets used registration context for this dialog

Return value

const MSIPRegistrationContext * associated registration or 0-pointer otherwise. Ownership is not transferred.

IMPORT_C TBool IsAssociated(const CSIPDialogAssocBase &aDialogAssoc) const;

Description

Checks if the dialog association belongs to this dialog

Parameters

const CSIPDialogAssocBase &aDialogAssoc a dialog association

Return value

TBool ETrue if belongs, EFalse otherwise

IMPORT_C CSIPConnection *Connection();

Description

Gets the SIP connection used for this dialog

Return value

CSIPConnection * SIP connection used for the dialog, or 0-pointer if the connection has been deleted. Ownership isn't transferred.

IMPORT_C const CSIPConnection *Connection() const;

Description

Gets the SIP connection used for this dialog.

Return value

const CSIPConnection * SIP connection used for the dialog, or 0-pointer if the connection has been deleted. Ownership isn't transferred.

IMPORT_C const CSIPFromHeader &FromHeader() const;

Description

Gets originator's address

Return value

const CSIPFromHeader & originator's address (From-header)

IMPORT_C const CSIPToHeader &ToHeader() const;

Description

Gets recipient's address

Return value

const CSIPToHeader & recipient's address (To-header)

IMPORT_C const CUri8 &RemoteURI() const;

Description

Gets remote-uri used during dialog creation

Return value

const CUri8 & Remote target uri

IMPORT_C const CSIPCallIDHeader &CallIdL() const;

Pre-Condition

State()==CSIPDialog::EEarly || State()==CSIPDialog::EConfirmed

Description

Gets Call-ID of SIP dialog

Return value

const CSIPCallIDHeader & Call-ID of SIP dialog

Leave codes

KErrSIPInvalidDialogState if dialog doesn't yet have a Call-ID

IMPORT_C TBool operator==(const CSIPDialog &aDialog) const;

Description

Compares this object to another object

Parameters

const CSIPDialog &aDialog CSIPDialog object to compare

Return value

TBool ETrue if the objects are equal, otherwise EFalse

TState

Description

Dialog states

EInit Initiliazed state EEarly Early state EConfirmed Confirmed state ETerminated Terminated state