Collapse all Symbian^3 Product Developer Library

CSipProfileAlrController Class Reference

class CSipProfileAlrController : public CBase

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.

sipprofilecli.lib

Inherits from

CSipProfileAlrController
- CBase

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)

Private Member Functions
	CSipProfileAlrController(CSIPProfileRegistryBase &)
void	ConstructL(MSipProfileAlrObserver &)

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

Private Attributes
CSIPProfileRegistryBase &	iRegistry

Constructor & Destructor Documentation

CSipProfileAlrController(CSIPProfileRegistryBase &)

CSipProfileAlrController

(

CSIPProfileRegistryBase &

aRegistry

)

[private]

Parameters

CSIPProfileRegistryBase & aRegistry

~CSipProfileAlrController()

~CSipProfileAlrController

(

)

Destructor.

Member Functions 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.

Parameters

TUint32 aProfileId	the SIP profile id
TUint32 aIapId	the new IAP id.

ConstructL(MSipProfileAlrObserver &)

void

ConstructL

(

MSipProfileAlrObserver &

aObserver

)

[private]

Parameters

MSipProfileAlrObserver & aObserver

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(...).

Parameters

TUint32 aProfileId	the SIP profile id
TUint32 aIapId	the new IAP id.

NewL(CSIPProfileRegistryBase &, MSipProfileAlrObserver &)

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

Two-phased constructor.

Parameters

CSIPProfileRegistryBase & aRegistry	a SIP profile registry instance.
MSipProfileAlrObserver & 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.

Parameters

CSIPProfileRegistryBase & aRegistry	a SIP profile registry instance.
MSipProfileAlrObserver & 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.

Parameters

TUint32 aProfileId

the SIP profile id

Member Data Documentation

CSIPProfileRegistryBase & iRegistry

CSIPProfileRegistryBase &

iRegistry

[private]