S60 3rd Edition API Reference: CSIPDialog Class Reference

CSIPDialog Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <sipdialog.h>

Detailed Description

PublishedAll
Released
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.


Public Types

enum  TState { EInit, EEarly, EConfirmed, ETerminated }
 Dialog states. More...

Public Member Functions

 ~CSIPDialog ()
 Destructor.
IMPORT_C CSIPDialog::TState State () const
 Gets dialog state.
IMPORT_C const RPointerArray<
CSIPDialogAssocBase > & 		SIPDialogAssociations () const
 Gets all dialog associations.
IMPORT_C const MSIPRegistrationContext * RegistrationContext () const
 Gets used registration context for this dialog.
IMPORT_C TBool IsAssociated (const CSIPDialogAssocBase &aDialogAssoc) const
 Checks if the dialog association belongs to this dialog.
IMPORT_C CSIPConnection * Connection ()
 Gets the SIP connection used for this dialog.
IMPORT_C const CSIPConnection * Connection () const
 Gets the SIP connection used for this dialog.
IMPORT_C const CSIPFromHeader & FromHeader () const
 Gets originator's address.
IMPORT_C const CSIPToHeader & ToHeader () const
 Gets recipient's address.
IMPORT_C const CUri8 & RemoteURI () const
 Gets remote-uri used during dialog creation.
IMPORT_C const CSIPCallIDHeader & CallIdL () const
 Gets Call-ID of SIP dialog.
IMPORT_C TBool operator== (const CSIPDialog &aDialog) const
 Compares this object to another object.
CSIPDialogImplementation & Implementation ()
 Returns the CSIPDialogImplementation.

Static Public Member Functions

static CSIPDialog * NewL (CSIPConnectionImplementation &aConnImplementation)
 Two-phased constructor.
static CSIPDialog * NewLC (CSIPConnectionImplementation &aConnImplementation)
 Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.
static CSIPDialog * NewL (CSIPConnectionImplementation &aConnImplementation, const MSIPRegistrationContext &aContext)
 Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.
static CSIPDialog * NewLC (CSIPConnectionImplementation &aConnImplementation, const MSIPRegistrationContext &aContext)
 Two-phased constructor This constructor should be used if the user has received SIP request that creates a SIP dialog association.

Member Enumeration Documentation

enum CSIPDialog::TState
 

Dialog states.

Enumerator:
EInit  Initiliazed state.
EEarly  Early state.
EConfirmed  Confirmed state.
ETerminated  Terminated state.

Constructor & Destructor Documentation

CSIPDialog::~CSIPDialog (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C const CSIPCallIDHeader& CSIPDialog::CallIdL (   )  const
 

Gets Call-ID of SIP dialog.

Precondition:
State()==CSIPDialogEEarly || State()==CSIPDialogEConfirmed
Returns:
Call-ID of SIP dialog
Leave:
KErrSIPInvalidDialogState if dialog doesn't yet have a Call-ID
IMPORT_C const CSIPConnection* CSIPDialog::Connection (   )  const
 

Gets the SIP connection used for this dialog.

Returns:
SIP connection used for the dialog, or 0-pointer if the connection has been deleted. Ownership isn't transferred.
IMPORT_C CSIPConnection* CSIPDialog::Connection (   ) 
 

Gets the SIP connection used for this dialog.

Returns:
SIP connection used for the dialog, or 0-pointer if the connection has been deleted. Ownership isn't transferred.
IMPORT_C const CSIPFromHeader& CSIPDialog::FromHeader (   )  const
 

Gets originator's address.

Returns:
originator's address (From-header)
CSIPDialogImplementation& CSIPDialog::Implementation (   ) 
 

Returns the CSIPDialogImplementation.

Returns:
CSIPDialogImplementation
IMPORT_C TBool CSIPDialog::IsAssociated ( const CSIPDialogAssocBase &  aDialogAssoc  )  const
 

Checks if the dialog association belongs to this dialog.

Parameters:
aDialogAssoc a dialog association
Returns:
ETrue if belongs, EFalse otherwise
static CSIPDialog* 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.
Returns:
New object, ownership is transferred.
static CSIPDialog* 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
Returns:
New object, ownership is transferred.
static CSIPDialog* 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.
Returns:
New object, ownership is transferred.
static CSIPDialog* 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
Returns:
New object, ownership is transferred.
IMPORT_C TBool CSIPDialog::operator== ( const CSIPDialog &  aDialog  )  const
 

Compares this object to another object.

Parameters:
aDialog CSIPDialog object to compare
Returns:
ETrue if the objects are equal, otherwise EFalse
IMPORT_C const MSIPRegistrationContext* CSIPDialog::RegistrationContext (   )  const
 

Gets used registration context for this dialog.

Returns:
associated registration or 0-pointer otherwise. Ownership is not transferred.
IMPORT_C const CUri8& CSIPDialog::RemoteURI (   )  const
 

Gets remote-uri used during dialog creation.

Returns:
Remote target uri
IMPORT_C const RPointerArray<CSIPDialogAssocBase>& CSIPDialog::SIPDialogAssociations (   )  const
 

Gets all dialog associations.

Returns:
All dialog associations. Ownership of the array or the items inside it, is not transferred.
IMPORT_C CSIPDialog::TState CSIPDialog::State (   )  const
 

Gets dialog state.

Returns:
dialog state
IMPORT_C const CSIPToHeader& CSIPDialog::ToHeader (   )  const
 

Gets recipient's address.

Returns:
recipient's address (To-header)
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top