Symbian^3 Application Developer Library >

CSIPDialog Class Reference

class CSIPDialog : public CBase

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

Inherits from

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 &)
Private Member Functions
CSIPDialog ()
void ConstructL ( CSIPConnectionImplementation &)
void ConstructL ( CSIPConnectionImplementation &, const MSIPRegistrationContext &)
void __DbgTestInvariant ()
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()
Public Member Enumerations
enum TState { EInit , EEarly , EConfirmed , ETerminated }
Private Attributes
CSIPDialogImplementation * iImplementation

Constructor & Destructor Documentation

CSIPDialog()

CSIPDialog ( ) [private]

~CSIPDialog()

~CSIPDialog ( )

Destructor

Member Functions Documentation

CallIdL()

IMPORT_C const CSIPCallIDHeader & CallIdL ( ) const
Gets Call-ID of SIP dialog
Pre-condition
State() ==CSIPDialogEEarly || State() ==CSIPDialogEConfirmed
leave
KErrSIPInvalidDialogState if dialog doesn't yet have a Call-ID

Connection()

IMPORT_C CSIPConnection * Connection ( )

Gets the SIP connection used for this dialog

Connection()

IMPORT_C const CSIPConnection * Connection ( ) const

Gets the SIP connection used for this dialog.

ConstructL(CSIPConnectionImplementation &)

void ConstructL ( CSIPConnectionImplementation & aConnImplementation ) [private]

Parameters

CSIPConnectionImplementation & aConnImplementation

ConstructL(CSIPConnectionImplementation &, const MSIPRegistrationContext &)

void ConstructL ( CSIPConnectionImplementation & aConnImplementation,
const MSIPRegistrationContext & aContext
) [private]

Parameters

CSIPConnectionImplementation & aConnImplementation
const MSIPRegistrationContext & aContext

FromHeader()

IMPORT_C const CSIPFromHeader & FromHeader ( ) const

Gets originator's address

Implementation()

CSIPDialogImplementation & Implementation ( )

Returns the CSIPDialogImplementation .

IsAssociated(const CSIPDialogAssocBase &)

IMPORT_C TBool IsAssociated ( const CSIPDialogAssocBase & aDialogAssoc ) const

Checks if the dialog association belongs to this dialog

Parameters

const CSIPDialogAssocBase & aDialogAssoc a dialog association

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

CSIPConnectionImplementation & aConnImplementation Implementation of the used SIP connection

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

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

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

CSIPConnectionImplementation & aConnImplementation Implementation of the used SIP connection

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

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

RegistrationContext()

IMPORT_C const MSIPRegistrationContext * RegistrationContext ( ) const

Gets used registration context for this dialog

RemoteURI()

IMPORT_C const CUri8 & RemoteURI ( ) const

Gets remote-uri used during dialog creation

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() ==CSIPDialogETerminated

SIPDialogAssociations()

IMPORT_C const RPointerArray < CSIPDialogAssocBase > & SIPDialogAssociations ( ) const

Gets all dialog associations.

State()

IMPORT_C CSIPDialog::TState State ( ) const

Gets dialog state

ToHeader()

IMPORT_C const CSIPToHeader & ToHeader ( ) const

Gets recipient's address

__DbgTestInvariant()

void __DbgTestInvariant ( ) const [private]

operator==(const CSIPDialog &)

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

Compares this object to another object

Parameters

const CSIPDialog & aDialog CSIPDialog object to compare

Member Enumerations Documentation

Enum TState

Dialog states

Enumerators

EInit

Initiliazed state

EEarly

Early state

EConfirmed

Confirmed state

ETerminated

Terminated state

Member Data Documentation

CSIPDialogImplementation * iImplementation

CSIPDialogImplementation * iImplementation [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.