CSIPDialog Class Reference

#include <mw/sipdialog.h>

Link against: sipclient

class CSIPDialog : public CBase

Inherits from

CSIPDialog
- CBase

Public Member Enumerations
enum	TState { EInit, EEarly, EConfirmed, ETerminated }

Public Member Functions
	~CSIPDialog()
IMPORT_C const CSIPCallIDHeader &	CallIdL()
IMPORT_C CSIPConnection *	Connection()
IMPORT_C const CSIPConnection *	Connection()
IMPORT_C const CSIPFromHeader &	FromHeader()
CSIPDialogImplementation &	Implementation()
IMPORT_C TBool	IsAssociated(const CSIPDialogAssocBase &)
CSIPDialog *	NewL(CSIPConnectionImplementation &)
CSIPDialog *	NewL(CSIPConnectionImplementation &, const MSIPRegistrationContext &)
CSIPDialog *	NewLC(CSIPConnectionImplementation &)
CSIPDialog *	NewLC(CSIPConnectionImplementation &, const MSIPRegistrationContext &)
IMPORT_C const MSIPRegistrationContext *	RegistrationContext()
IMPORT_C const CUri8 &	RemoteURI()
IMPORT_C TInt	ReuseInitialRequestData()
IMPORT_C const RPointerArray< CSIPDialogAssocBase > &	SIPDialogAssociations()
IMPORT_C CSIPDialog::TState	State()
IMPORT_C const CSIPToHeader &	ToHeader()
IMPORT_C TBool	operator==(const CSIPDialog &)

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

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.

Member Enumeration Documentation

Enum TState

Dialog states

Enumerator	Value	Description
EInit		Initiliazed state
EEarly		Early state
EConfirmed		Confirmed state
ETerminated		Terminated state

Constructor & Destructor Documentation

~CSIPDialog ( )

~CSIPDialog

(

)

Destructor

Member Function Documentation

CallIdL ( )

IMPORT_C const CSIPCallIDHeader &

CallIdL

(

)

const

Gets Call-ID of SIP dialog

Pre-condition: State()==CSIPDialog::EEarly || State()==CSIPDialog::EConfirmed

Return Value: Call-ID of SIP dialog

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

Connection ( )

IMPORT_C CSIPConnection *

Connection

(

)

Gets the SIP connection used for this dialog

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

Connection ( )

IMPORT_C const CSIPConnection *

Connection

(

)

const

Gets the SIP connection used for this dialog.

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

FromHeader ( )

IMPORT_C const CSIPFromHeader &

FromHeader

(

)

const

Gets originator's address

Return Value: originator's address (From-header)

Implementation ( )

CSIPDialogImplementation &

Implementation

(

)

Returns the CSIPDialogImplementation.

Return Value: CSIPDialogImplementation

IsAssociated ( const CSIPDialogAssocBase & )

IMPORT_C TBool

IsAssociated

(

const CSIPDialogAssocBase &

aDialogAssoc

)

const

Checks if the dialog association belongs to this dialog

Parameters
aDialogAssoc	a dialog association

Return Value: ETrue if belongs, EFalse otherwise

NewL ( CSIPConnectionImplementation & )

CSIPDialog *

NewL

(

CSIPConnectionImplementation &

aConnImplementation

)

[static]

Two-phased constructor. This constructor should be used if the user has received SIP request that creates a SIP dialog association.

Parameters
aConnImplementation	Implementation of the used SIP connection

Return Value: New object, ownership is transferred.

NewL ( CSIPConnectionImplementation &, const MSIPRegistrationContext & )

CSIPDialog *	NewL	(	CSIPConnectionImplementation &	aConnImplementation,
			const MSIPRegistrationContext &	aContext
		)	[static]

Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.

Parameters
aConnImplementation	Implementation of the used SIP connection
aContext	Registration context whose outbound proxy and other parameters are to be used.

Return Value: New object, ownership is transferred.

NewLC ( CSIPConnectionImplementation & )

CSIPDialog *

NewLC

(

CSIPConnectionImplementation &

aConnImplementation

)

[static]

Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.

Parameters
aConnImplementation	Implementation of the used SIP connection

Return Value: New object, ownership is transferred.

NewLC ( CSIPConnectionImplementation &, const MSIPRegistrationContext & )

CSIPDialog *	NewLC	(	CSIPConnectionImplementation &	aConnImplementation,
			const MSIPRegistrationContext &	aContext
		)	[static]

Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.

Parameters
aConnImplementation	Implementation of the used SIP connection
aContext	Registration context whose outbound proxy and other parameters are to be used.

Return Value: New object, ownership is transferred.

RegistrationContext ( )

IMPORT_C const MSIPRegistrationContext *

RegistrationContext

(

)

const

Gets used registration context for this dialog

Return Value: associated registration or 0-pointer otherwise. Ownership is not transferred.

RemoteURI ( )

IMPORT_C const CUri8 &

RemoteURI

(

)

const

Gets remote-uri used during dialog creation

Return Value: Remote target uri

ReuseInitialRequestData ( )

IMPORT_C TInt

ReuseInitialRequestData

(

)

Sets the dialog to state to CSIPDialog::EInit. The local dialog identifier data (Call-ID, CSeq and From-header's tag) will be reused. After calling this function, the dialog that was already terminated can be used for sending the dialog initiating request such as INVITE or SUBSCRIBE reusing the stored Call-ID and From-header's tag and the stored CSeq incremented by one.

Pre-condition: State()==CSIPDialog::ETerminated

Return Value: KErrNone if succesful and KErrNoMemory if the memory is low.

SIPDialogAssociations ( )

IMPORT_C const RPointerArray< CSIPDialogAssocBase > &

SIPDialogAssociations

(

)

const

Gets all dialog associations.

Return Value: All dialog associations. Ownership of the array or the items inside it, is not transferred.

State ( )

IMPORT_C CSIPDialog::TState

State

(

)

const

Gets dialog state

Return Value: dialog state

ToHeader ( )

IMPORT_C const CSIPToHeader &

ToHeader

(

)

const

Gets recipient's address

Return Value: recipient's address (To-header)

operator== ( const CSIPDialog & )

IMPORT_C TBool

operator==

(

const CSIPDialog &

aDialog

)

const

Compares this object to another object

Parameters
aDialog	CSIPDialog object to compare

Return Value: ETrue if the objects are equal, otherwise EFalse