williamr@2: /*
williamr@2: * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name          : sipprofilealrobserver.h
williamr@2: * Part of       : SIP / SIP Profile Agent
williamr@2: * Version       : SIP/6.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef MSIPPROFILEALROBSERVER_H
williamr@2: #define MSIPPROFILEALROBSERVER_H
williamr@2: 
williamr@2: // INCLUDES
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * Callback to receive notifications about ALR (Application Level Roaming) 
williamr@2: * related events and errors.
williamr@2: */
williamr@2: class MSipProfileAlrObserver
williamr@2:     {
williamr@2:     public:
williamr@2:     
williamr@2:         /** SIP Profile ALR events */
williamr@2:         enum TEvent
williamr@2:             {
williamr@2:              /** 
williamr@2:             * A new IAP became available.
williamr@2:             * When receiving this event the client must call 
williamr@2:             * CSipProfileAlrController::AllowMigrationL or DisallowMigrationL.
williamr@2:             */           
williamr@2:             EIapAvailable = 0,
williamr@2:             /** 
williamr@2:             * All the clients have allowed the migration to the new IAP and
williamr@2:             * the migration to the new IAP for the SIP profile has started. 
williamr@2:             */
williamr@2:             EMigrationStarted,
williamr@2:             /** 
williamr@2:             * Migration to a new IAP for a SIP profile has been completed and
williamr@2:             * the related SIP profile has been registered via the new IAP.
williamr@2:             */
williamr@2:             EMigrationCompleted
williamr@2:             };
williamr@2:                                    
williamr@2:         /**
williamr@2:         * ALR related event occurred.
williamr@2:         * @param aEvent the event that occurred
williamr@2:         * @param aProfileId identifies the SIP profile related to the event
williamr@2:         * @param aSnapId the SNAP related to the event
williamr@2:         * @param aIapId the IAP related to the event
williamr@2:         */
williamr@2:         virtual void AlrEvent( TEvent aEvent,
williamr@2:                                TUint32 aProfileId,
williamr@2:                                TUint32 aSnapId,
williamr@2:                                TUint32 aIapId ) = 0;
williamr@2:                                
williamr@2:         /**
williamr@2:         * ALR related error occurred.
williamr@2:         * @param aError the error that occurred
williamr@2:         * @param aProfileId identifies the SIP profile related to the error
williamr@2:         * @param aSnapId the SNAP related to the error
williamr@2:         * @param aIapId the IAP related to the error
williamr@2:         */
williamr@2:         virtual void AlrError( TInt aError,
williamr@2:                                TUint32 aProfileId,
williamr@2:                                TUint32 aSnapId,
williamr@2:                                TUint32 aIapId ) = 0;                                                                  
williamr@2:     };
williamr@2: 
williamr@2: #endif // MSIPPROFILEALROBSERVER_H