realtimenetprots/sipfw/ProfileAgent/Server/Src/sipextendedconcreteprofileobserver.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Name          : sipextendedconcreteprofileobserver.h
       
    16 * Part of       : SIP / SIP Profile Server
       
    17 * Version       : SIP/6.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 #ifndef MSIPEXTENDEDCONCRETEPROFILEOBSERVER_H
       
    29 #define MSIPEXTENDEDCONCRETEPROFILEOBSERVER_H
       
    30 
       
    31 // INCLUDES
       
    32 #include "sipconcreteprofileobserver.h"
       
    33 #include <e32base.h>
       
    34 
       
    35 // FORWARD DECLARATIONS
       
    36 class CSIPProfileCacheItem;
       
    37 
       
    38 // CLASS DECLARATION
       
    39 /**
       
    40 * This class extends the MSIPConcreteProfileObserver by adding callbacks related
       
    41 * to ALR, in order to pass information about availability and migration of
       
    42 * various IAPs of a SNAP id.
       
    43 *
       
    44 * @lib sipsrofilesrv.exe
       
    45 */
       
    46 class MSIPExtendedConcreteProfileObserver : public MSIPConcreteProfileObserver
       
    47     {
       
    48 	public: // From MSIPConcreteProfileObserver
       
    49 
       
    50 		virtual void RegistrationStatusChangedL(
       
    51             TUint32 aProfileId, 
       
    52             TInt aStatus,
       
    53             TUint32 aStatusId) = 0;
       
    54 
       
    55         virtual void AddedL(TUint32 aProfileId) = 0;
       
    56 
       
    57         virtual void RemovedL(TUint32 aProfileId) = 0;
       
    58 
       
    59         virtual void UpdatedL(TUint32 aProfileId, TUint aSize) = 0;
       
    60 
       
    61         virtual void ErrorOccurredL(
       
    62             TUint32 aProfileId,
       
    63             TInt aStatus,
       
    64             TInt aError) = 0;
       
    65 
       
    66 	public: // New pure virtual functions
       
    67 
       
    68 		/**
       
    69 		* An IAP has become available.
       
    70 		* @param aProfileId Profile id
       
    71 		* @param aSnapId SNAP id
       
    72 		* @param aIapId IAP id
       
    73 		* @return ETrue Must wait for Profile client to inform if migration to
       
    74 		*         the IAP is allowed or not.
       
    75 		*		  EFalse Migration is allowed by default, no need to wait for
       
    76 		*		         this observer.
       
    77         */
       
    78 		virtual TBool IapAvailableL(TUint32 aProfileId,
       
    79 								    TUint32 aSnapId,
       
    80 								    TUint32 aIapId) = 0;
       
    81 
       
    82 		/**
       
    83 		* Migration to an IAP has been initiated.
       
    84 		* @param aProfileId Profile id
       
    85 		* @param aSnapId SNAP id
       
    86 		* @param aIapId IAP id
       
    87         */
       
    88 		virtual void MigrationStartedL(TUint32 aProfileId,
       
    89 								   	   TUint32 aSnapId,
       
    90 								   	   TUint32 aIapId) = 0;
       
    91 
       
    92 		/**
       
    93 		* Migration to an IAP has been completed.
       
    94 		* @param aProfileId Profile id
       
    95 		* @param aSnapId SNAP id
       
    96 		* @param aIapId IAP id
       
    97         */
       
    98 		virtual void MigrationCompletedL(TUint32 aProfileId,
       
    99 								   	     TUint32 aSnapId,
       
   100 								   	     TUint32 aIapId) = 0;
       
   101 
       
   102 		/**
       
   103 		* ALR related error occurred.
       
   104 		* @param aProfileId Profile id
       
   105 		* @param aSnapId SNAP id
       
   106 		* @param aIapId IAP id
       
   107         */
       
   108 		virtual TInt AlrError(TInt aError,
       
   109 							  TUint32 aProfileId,
       
   110 							  TUint32 aSnapId,
       
   111 							  TUint32 aIapId) = 0;
       
   112     };
       
   113 
       
   114 #endif // MSIPEXTENDEDCONCRETEPROFILEOBSERVER_H