CSipProfileAlrController Class Reference

#include <mw/sipprofilealrcontroller.h>

Link against: sipprofilecli.lib

class CSipProfileAlrController : public CBase

Inherits from

CSipProfileAlrController

Public Member Functions
	~CSipProfileAlrController()
IMPORT_C void	AllowMigrationL(TUint32, TUint32)
IMPORT_C void	DisallowMigrationL(TUint32, TUint32)
IMPORT_C CSipProfileAlrController *	NewL(CSIPProfileRegistryBase &, MSipProfileAlrObserver &)
IMPORT_C CSipProfileAlrController *	NewLC(CSIPProfileRegistryBase &, MSipProfileAlrObserver &)
IMPORT_C void	RefreshIapAvailabilityL(TUint32)

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

This class provides functions to control ALR (Application Level Roaming) for SIP profiles that have a SNAP (Service Network Access Point) ID configured. By default the clients allow automatic roaming between IAPs (Internet Access Point) for a SIP profile. The clients wanting to control the roaming must instantiate this class. After that all the IAP availability events received through MSipProfileAlrObserver::AlrEvent must be allowed or disallowed.

Constructor & Destructor Documentation

~CSipProfileAlrController ( )

~CSipProfileAlrController

(

)

Destructor.

Member Function Documentation

AllowMigrationL ( TUint32, TUint32 )

IMPORT_C void	AllowMigrationL	(	TUint32	aProfileId,
			TUint32	aIapId
		)

Allows SIP Profile Agent to start the migration to a new IAP for the profile. If also all the other clients allow the migration, migration will be started and all the clients are informed with MSipProfileAlrObserver::AlrEvent(EMigrationStarted,...). When MSipProfileAlrObserver::AlrEvent(EMigrationCompleted,...) gets called the migration has been completed and the related SIP profile has been registered via the new IAP.

Parameter	Description
aProfileId	the SIP profile id
aIapId	the new IAP id.

DisallowMigrationL ( TUint32, TUint32 )

IMPORT_C void	DisallowMigrationL	(	TUint32	aProfileId,
			TUint32	aIapId
		)

Disallows SIP Profile Agent to migrate to a new IAP for the profile. After the client calls this function all the clients are informed with MSipProfileAlrObserver::AlrError(...).

Parameter	Description
aProfileId	the SIP profile id
aIapId	the new IAP id.

NewL ( CSIPProfileRegistryBase &, MSipProfileAlrObserver & )

IMPORT_C CSipProfileAlrController *	NewL	(	CSIPProfileRegistryBase &	aRegistry,
			MSipProfileAlrObserver &	aObserver
		)	[static]

Two-phased constructor.

Parameter	Description
aRegistry	a SIP profile registry instance.
aObserver	a observer for IAP migration events.

NewLC ( CSIPProfileRegistryBase &, MSipProfileAlrObserver & )

IMPORT_C CSipProfileAlrController *	NewLC	(	CSIPProfileRegistryBase &	aRegistry,
			MSipProfileAlrObserver &	aObserver
		)	[static]

Two-phased constructor. Constructs an object and adds the pointer to the cleanup stack.

Parameter	Description
aRegistry	a SIP profile registry instance.
aObserver	a observer for IAP migration events.

RefreshIapAvailabilityL ( TUint32 )

IMPORT_C void

RefreshIapAvailabilityL

(

TUint32

aProfileId

)

Refreshes the list of available IAPs for the SNAP configured for the profile. If a new better IAP is available, it is offered via MSipProfileAlrObserver::AlrEvent(EIapAvailable,...). This function should be called if migration to a IAP has been previously disallowed and the client wants to check whether the better IAP is still available.

Parameter	Description
aProfileId	the SIP profile id