Symaptic: os/persistentdata/featuremgmt/featuremgr/src/serverexe/featmgrserver.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2007-2010 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 *

    16 */

    21 #ifndef FEATMGRSERVER_H

    22 #define FEATMGRSERVER_H

    24 //  INCLUDES

    25 #include <e32svr.h>

    26 #include <featmgr/featurecmn.h>

    27 #include <babackup.h>

    28 #include "featmgrclientserver.h"

    29 #include <featmgr/featureinfoplugin.h>

    30 #include "featmgrtimer.h"

    31 #include "featmgrfeatureregistry.h"

    32 #include "burstate.h"

    34 #ifdef FEATURE_MANAGER_STARTUP_TEST

    35     inline void FmgrFatalErrorL(TInt err, const TDesC&, TInt)

    36         {

    37         User::Leave(err);

    38         }

    39 #else

    40     inline void FmgrFatalErrorL(TInt, const TDesC& aPanicCategory, TInt aPanicCode)

    41         {

    42         User::Panic(aPanicCategory, aPanicCode);

    43         }

    44 #endif

    46 // FORWARD DECLARATIONS

    47 class CFeatMgrPluginHandler;

    48 class CFeatMgrFeatureRegistry;

    50 enum TFeatureSupport

    51     {

    52     EFeatureSupportDisable = EFalse,

    53     EFeatureSupportEnable = ETrue,

    54     EFeatureSupportUntouch = 2

    55     };

    57 // CLASS DECLARATIONS

    59 #ifdef EXTENDED_FEATURE_MANAGER_TEST

    60 /**

    61  Auto shutdown class (standard pattern) for testing purposes

    63 */

    64 class CShutdown : public CTimer

    65 	{

    66 	enum TMemScanShutdown

    67 	    {

    68 	    EMemScanServShutdownDelay=0x200000

    69 	    };

    70 public:

    71 	inline CShutdown();

    72 	inline void ConstructL();

    73 	inline void Start();

    74 private:

    75 	void RunL();

    76 	};

    77 #endif // EXTENDED_FEATURE_MANAGER_TEST

    79 /**

    80   Feature Manager server implementation

    82 */

    83 NONSHARABLE_CLASS(CFeatMgrServer) :

    84     public CPolicyServer,

    85     public MFeatMgrTimerCallback,

    86     public MFeatMgrRegistryObserver,

    87     private MBackupOperationObserver,

    88     private MBackupObserver

    89     {

    90     public:  // Constructors and destructor

    92         /**

    93          Creates a new server. Newly created instance is left in the cleanup stack.

    94          @param aPriority Priority of the server.

    95          @return A pointer to the created object.

    96         */

    97         static CFeatMgrServer* NewLC( const TInt aPriority );

    99         /**

   100          Destructor.

   101         */

   102         virtual ~CFeatMgrServer();

   104     public: // New functions

   106         /**

   107          Called by plugin handler to inform feature info to server.

   108         */

   109         void FeatureInfoL( RArray<FeatureInfoCommand::TFeature>& aFeatureList,

   110                            CFeatMgrPluginHandler* aPluginHandler );

   112         /**

   113          Called by plugin handler to inform feature info to server.

   114         */

   115         void FeatureInfoL( RFeatureArray& aFeatureList, CFeatMgrPluginHandler* aPluginHandler );

   117         /**

   118          Returns ETrue if all plugins are ready and

   119          Feature info received.

   120          Else returns EFalse.

   122          @return plugins loading status

   123         */

   124         TBool PluginsReady() const;

   126         /**

   127          Returns ETrue if backup is in progress

   128          Else returns EFalse.

   129          @return backup status

   130         */

   131         TBool BURIsInProgress() const;

   133 #ifdef EXTENDED_FEATURE_MANAGER_TEST

   134         /**

   135          Called by session to indicate addition of session.

   136         */

   137         void AddSession();

   139         /**

   140          Called by session to indicate end of session.

   141         */

   142         void DropSession();

   143 #endif // EXTENDED_FEATURE_MANAGER_TEST

   145     public: // Functions from base classes

   147     	// From MFeatMgrTimerCallback

   148     	virtual void TimerFired();

   150         // From MFeatMgrRegistryObserver

   151     	virtual void HandleFeatureChange( TFeatureServerEntry& aFeature, TFeatureChangeType aType );

   153        	/**

   154 		Function from MBackupOperationObserver in response to a change in the state of the backup and

   155 		restore operation(s). This function is called to notify the Feature Manager that a backup and

   156 		restore operation is in progress. However, this is not the whole story, and notification using

   157 		the callback ChangeLockFileL() is also used.

   158 		@param			aBackupOperationAttributes The current state of the backup operation. Made up of

   159 		                MBackupObserver::TFileLockFlags and TOperationType types.

   160 		@see			MBackupObserver::TFileLockFlags

   161 		@see			TOperationType.

   162 	    */

   163         void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes);

   165        	/**

   166 		 * Function from MBackupObserver in response to a change in the state of the file to be subject to

   167 		 * the BUR operation. This function is called to notify the Feature Manager that a filelock has

   168 		 * changed.

   169 		 * @param aFileName name of the file whose status has changed.

   170 		 * @param	aFlags the lock status information for the file.

   171 	     */

   172         void ChangeFileLockL( const TDesC& aFileName, TFileLockFlags aFlags );

   174     public:

   176     /**

   177      * Feature manager state machine function.

   178      * This returns the feature manager back to a normal state.

   179      * @param BURStatus current state

   180      * @return BURStatus the next state

   181      */

   182     BURStatus Goto_NormalState( BURStatus aCurrent );

   183     /**

   184      * Feature manager state machine function.

   185      * This will put the Feature Manager into the "start backup" state. Where the Feature Manager

   186      * is expecting the BUR backup to start.

   187      * @param BURStatus current state

   188      * @return BURStatus the next state

   189      */

   190     BURStatus Goto_StartBackupState( BURStatus aCurrent );

   191     /**

   192      * Feature manager state machine function.

   193      * This will put the Feature Manager into the "end backup" state. Where the Feature Manager

   194      * is expecting the BUR backup has just ended, and it is required to return itself to a

   195      * normal operating mode.

   196      * @param BURStatus current state

   197      * @return BURStatus the next state

   198      */

   199     BURStatus Goto_EndBackupState( BURStatus aCurrent );

   200     /**

   201      * Feature manager state machine function.

   202      * This will put the Feature Manager into the "start restore" state. Where the Feature Manager

   203      * is expecting the BUR restore operation to start.

   204      * @param BURStatus current state

   205      * @return BURStatus the next state

   206      */

   207     BURStatus Goto_StartRestoreState( BURStatus aCurrent );

   208     /**

   209      * Feature manager state machine function.

   210      * This will put the Feature Manager into the "end restore" state. Where the Feature Manager

   211      * is expecting the BUR restore operation has just ended, and it is required to return itself

   212      * to a normal operating mode.

   213      * @param BURStatus current state

   214      * @return BURStatus the next state

   215      */

   216     BURStatus Goto_EndRestoreState( BURStatus aCurrent );

   217     /**

   218      * Feature manager state machine function.

   219      * This will return the Feature Manager from its current state, and into a "safe" state whereby

   220      * a normal operating mode is possible again. This is an error recovery function.

   221      * @param BURStatus current state

   222      * @return BURStatus the next state

   223      */

   224     BURStatus Goto_ErrorState( BURStatus aCurrent );

   226     private:

   228     /* Clears the feature array ready to re-populate it during a restore operation */

   229     void ClearFeaturesL( void );

   230     /* Reloads the feature array and merges features during a restore operation */

   231     void LoadFeaturesL( void );

   232     /* Handles any outstanding notifications after a restore operation */

   233     void HandleRestoredNotificationsL( void );

   235     private:

   237         /**

   238          C++ constructor.

   239         */

   240         CFeatMgrServer( const TInt aPriority,

   241                         const TServerType aType = EUnsharableSessions );

   242         /**

   243          By default Symbian 2nd phase constructor is private.

   244         */

   245         void ConstructL();

   247         /**

   248          Creates a new session when client connects.

   249          @param aVersion Version

   250          @param aMessage 'connect' message from the client

   251          @return Pointer to created session or leaves with codes

   252                  KErrNotSupported if versions does not match

   253                  KErrNoMemory if creation of new session fails.

   254         */

   255         CSession2* NewSessionL( const TVersion& aVersion,

   256                                 const RMessage2& aMessage ) const;

   257         /**

   258          Panics the server thread

   259          @param aCategory Panicer's id

   260          @param aPanic    Reason of panic

   261          @return void

   262         */

   263         void Panic( const TDesC& aCategory, const TInt aReason );

   265         /**

   266          Lists and loads Feature Manager plugins.

   267         */

   268         TBool LoadPluginsL();

   270         /**

   271          Deletes plugin handler if feature info is ready.

   272         */

   273         void DeletePlugins();

   275         /**

   276          Check whether plugins have finished processing.

   277         */

   278         void CheckPluginsReadyL();

   280         /**

   281          Calls ServicePendingRequestsL of sessions

   282         */

   283         void ServicePendingRequests();

   285     private:    // Data

   287         // Timer pointer.

   288         CFeatMgrTimer* iTimer;

   290         CBurState iBurState;

   292         // ETrue when backup in progress

   293         TBool iBURInProgress;

   295         // ETrue when feature info received from all plugins

   296         TBool iPluginsReady;

   298         // Struct to contain information of found Feature Manager plugins

   299         struct SFeatMgrPluginInfo

   300             {

   301             // Plugin handler of the plugin

   302             CFeatMgrPluginHandler*  iPluginHandler;

   303             // ETrue if feature info received from plugin handler

   304             TBool iPluginReady;

   305             };

   307 	    // Array of found Feature Manager plugins

   308 	    RArray<SFeatMgrPluginInfo>  iPluginList;

   310         // ETrue if all plugin handlers are deleted

   311         TBool  iPluginsDeleted;

   313         // ETrue if ServicePendingRequest not called yet.

   314         TBool iPendingRequests;

   316         // File server session

   317         RFs iFs;

   319         // ETrue when iPluginsReady is ETrue and all feature files have been read.

   320         TBool iFeaturesReady;

   322         CFeatMgrFeatureRegistry* iRegistry;

   324         // Backup Notification

   325         TUint32                   iBackupFlag;

   326         CBaBackupSessionWrapper * iBackupNotification;

   328 #ifdef EXTENDED_FEATURE_MANAGER_TEST

   329         TInt iSessionCount;

   330         CShutdown iShutdown;

   331 #endif

   332     };

   334 #endif      // FEATMGRSERVER_H

   336 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--