CSIPDialogAssocBase Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <sipdialogassocbase.h>

Inherited by CSIPInviteDialogAssoc, CSIPNotifyDialogAssoc, CSIPReferDialogAssoc, and CSIPSubscribeDialogAssoc.

Detailed Description

PublishedAll

Released

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.


Public Member Functions
virtual�	~CSIPDialogAssocBase ()
�	Destructor.
IMPORT_C const CSIPDialog &�	Dialog () const
�	Gets the dialog this dialog association belongs to.
IMPORT_C CSIPDialog &�	Dialog ()
�	Gets dialog this dialog association belongs to.
virtual IMPORT_C CSIPClientTransaction *�	SendNonTargetRefreshRequestL (RStringF aMethod, CSIPMessageElements *aElements)
�	Creates SIP request and sends it to the remote target.
IMPORT_C RStringF�	Type () const
�	Gets dialog association type.
IMPORT_C TBool�	IsNonTargetRefreshRequest (RStringF aMethod) const
�	Tests if the request is a non target refresh request.
CSIPDialogAssocImplementation &�	Implementation ()
�	Returns the implementation instance.
virtual CSIPRefresh *�	FindRefresh (TUint32 aRefreshId)
�	Searches for a refresh with the matching id.
virtual void�	DeletingRefresh (CSIPRefresh &aRefresh, TUint32 aRefreshId)
Protected Member Functions
�	CSIPDialogAssocBase ()
void�	ConstructL (RStringF aType, CSIPDialog &aDialog)
void�	ConstructL (RStringF aType, CSIPDialog &aDialog, CSIPServerTransaction &aTransaction)
Protected Attributes
CSIPDialogAssocImplementation *�	iImplementation

Constructor & Destructor Documentation

virtual CSIPDialogAssocBase::~CSIPDialogAssocBase (� �)� [virtual]

�	Destructor.

CSIPDialogAssocBase::CSIPDialogAssocBase (� �)� [protected]

�

Member Function Documentation

void CSIPDialogAssocBase::ConstructL	(�	RStringF�	aType,
		CSIPDialog &�	aDialog,
		CSIPServerTransaction &�	aTransaction
	)�	`[protected]`

�

void CSIPDialogAssocBase::ConstructL	(�	RStringF�	aType,
		CSIPDialog &�	aDialog
	)�	`[protected]`

�

virtual void CSIPDialogAssocBase::DeletingRefresh	(�	CSIPRefresh &�	aRefresh,
		TUint32�	aRefreshId
	)�	`[virtual]`

�	Reimplemented in CSIPSubscribeDialogAssoc.

IMPORT_C CSIPDialog& CSIPDialogAssocBase::Dialog

(�

�)�

�	Gets dialog this dialog association belongs to. Returns: associated dialog

IMPORT_C const CSIPDialog& CSIPDialogAssocBase::Dialog

(�

�)�

const

�	Gets the dialog this dialog association belongs to. Returns: associated dialog

virtual CSIPRefresh* CSIPDialogAssocBase::FindRefresh (� TUint32� aRefreshId �)� [virtual]

�

Searches for a refresh with the matching id.

Default implementation returns NULL. Those classes derived from CSIPDialogAssocBase, which can contain refreshes must implement this function for searching the correct refresh.

Returns:: CSIPRefresh if found, NULL otherwise. Ownership is not transferred

Reimplemented in CSIPSubscribeDialogAssoc.

CSIPDialogAssocImplementation& CSIPDialogAssocBase::Implementation

(�

�)�

�	Returns the implementation instance. Returns: CSIPDialogAssocImplementation

IMPORT_C TBool CSIPDialogAssocBase::IsNonTargetRefreshRequest

Tests if the request is a non target refresh request.

Parameters:

aMethod�

a method to test

Returns:: ETrue if is non target refresh request; EFalse otherwise

virtual IMPORT_C CSIPClientTransaction* CSIPDialogAssocBase::SendNonTargetRefreshRequestL	(�	RStringF�	aMethod,
		CSIPMessageElements *�	aElements
	)�	`[virtual]`

�

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.

Precondition:

SIPDialog().State() != CSIPDialog::EInit && SIPDialog().State() != CSIPDialog::ETerminated

Dialog().Connection().State() == EActive

Parameters:

aElements�

contains optional SIP message headers and body. Ownership is transferred.