1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/featuremgmt/featuremgr/src/serverexe/featmgrserver.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,336 @@
1.4 +/*
1.5 +* Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +
1.24 +#ifndef FEATMGRSERVER_H
1.25 +#define FEATMGRSERVER_H
1.26 +
1.27 +// INCLUDES
1.28 +#include <e32svr.h>
1.29 +#include <featmgr/featurecmn.h>
1.30 +#include <babackup.h>
1.31 +#include "featmgrclientserver.h"
1.32 +#include <featmgr/featureinfoplugin.h>
1.33 +#include "featmgrtimer.h"
1.34 +#include "featmgrfeatureregistry.h"
1.35 +#include "burstate.h"
1.36 +
1.37 +#ifdef FEATURE_MANAGER_STARTUP_TEST
1.38 + inline void FmgrFatalErrorL(TInt err, const TDesC&, TInt)
1.39 + {
1.40 + User::Leave(err);
1.41 + }
1.42 +#else
1.43 + inline void FmgrFatalErrorL(TInt, const TDesC& aPanicCategory, TInt aPanicCode)
1.44 + {
1.45 + User::Panic(aPanicCategory, aPanicCode);
1.46 + }
1.47 +#endif
1.48 +
1.49 +// FORWARD DECLARATIONS
1.50 +class CFeatMgrPluginHandler;
1.51 +class CFeatMgrFeatureRegistry;
1.52 +
1.53 +enum TFeatureSupport
1.54 + {
1.55 + EFeatureSupportDisable = EFalse,
1.56 + EFeatureSupportEnable = ETrue,
1.57 + EFeatureSupportUntouch = 2
1.58 + };
1.59 +
1.60 +// CLASS DECLARATIONS
1.61 +
1.62 +#ifdef EXTENDED_FEATURE_MANAGER_TEST
1.63 +/**
1.64 + Auto shutdown class (standard pattern) for testing purposes
1.65 +
1.66 +*/
1.67 +class CShutdown : public CTimer
1.68 + {
1.69 + enum TMemScanShutdown
1.70 + {
1.71 + EMemScanServShutdownDelay=0x200000
1.72 + };
1.73 +public:
1.74 + inline CShutdown();
1.75 + inline void ConstructL();
1.76 + inline void Start();
1.77 +private:
1.78 + void RunL();
1.79 + };
1.80 +#endif // EXTENDED_FEATURE_MANAGER_TEST
1.81 +
1.82 +/**
1.83 + Feature Manager server implementation
1.84 +
1.85 +*/
1.86 +NONSHARABLE_CLASS(CFeatMgrServer) :
1.87 + public CPolicyServer,
1.88 + public MFeatMgrTimerCallback,
1.89 + public MFeatMgrRegistryObserver,
1.90 + private MBackupOperationObserver,
1.91 + private MBackupObserver
1.92 + {
1.93 + public: // Constructors and destructor
1.94 +
1.95 + /**
1.96 + Creates a new server. Newly created instance is left in the cleanup stack.
1.97 + @param aPriority Priority of the server.
1.98 + @return A pointer to the created object.
1.99 + */
1.100 + static CFeatMgrServer* NewLC( const TInt aPriority );
1.101 +
1.102 + /**
1.103 + Destructor.
1.104 + */
1.105 + virtual ~CFeatMgrServer();
1.106 +
1.107 + public: // New functions
1.108 +
1.109 + /**
1.110 + Called by plugin handler to inform feature info to server.
1.111 + */
1.112 + void FeatureInfoL( RArray<FeatureInfoCommand::TFeature>& aFeatureList,
1.113 + CFeatMgrPluginHandler* aPluginHandler );
1.114 +
1.115 + /**
1.116 + Called by plugin handler to inform feature info to server.
1.117 + */
1.118 + void FeatureInfoL( RFeatureArray& aFeatureList, CFeatMgrPluginHandler* aPluginHandler );
1.119 +
1.120 + /**
1.121 + Returns ETrue if all plugins are ready and
1.122 + Feature info received.
1.123 + Else returns EFalse.
1.124 +
1.125 + @return plugins loading status
1.126 + */
1.127 + TBool PluginsReady() const;
1.128 +
1.129 + /**
1.130 + Returns ETrue if backup is in progress
1.131 + Else returns EFalse.
1.132 + @return backup status
1.133 + */
1.134 + TBool BURIsInProgress() const;
1.135 +
1.136 +#ifdef EXTENDED_FEATURE_MANAGER_TEST
1.137 + /**
1.138 + Called by session to indicate addition of session.
1.139 + */
1.140 + void AddSession();
1.141 +
1.142 + /**
1.143 + Called by session to indicate end of session.
1.144 + */
1.145 + void DropSession();
1.146 +#endif // EXTENDED_FEATURE_MANAGER_TEST
1.147 +
1.148 + public: // Functions from base classes
1.149 +
1.150 + // From MFeatMgrTimerCallback
1.151 + virtual void TimerFired();
1.152 +
1.153 + // From MFeatMgrRegistryObserver
1.154 + virtual void HandleFeatureChange( TFeatureServerEntry& aFeature, TFeatureChangeType aType );
1.155 +
1.156 + /**
1.157 + Function from MBackupOperationObserver in response to a change in the state of the backup and
1.158 + restore operation(s). This function is called to notify the Feature Manager that a backup and
1.159 + restore operation is in progress. However, this is not the whole story, and notification using
1.160 + the callback ChangeLockFileL() is also used.
1.161 + @param aBackupOperationAttributes The current state of the backup operation. Made up of
1.162 + MBackupObserver::TFileLockFlags and TOperationType types.
1.163 + @see MBackupObserver::TFileLockFlags
1.164 + @see TOperationType.
1.165 + */
1.166 + void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes);
1.167 +
1.168 + /**
1.169 + * Function from MBackupObserver in response to a change in the state of the file to be subject to
1.170 + * the BUR operation. This function is called to notify the Feature Manager that a filelock has
1.171 + * changed.
1.172 + * @param aFileName name of the file whose status has changed.
1.173 + * @param aFlags the lock status information for the file.
1.174 + */
1.175 + void ChangeFileLockL( const TDesC& aFileName, TFileLockFlags aFlags );
1.176 +
1.177 + public:
1.178 +
1.179 + /**
1.180 + * Feature manager state machine function.
1.181 + * This returns the feature manager back to a normal state.
1.182 + * @param BURStatus current state
1.183 + * @return BURStatus the next state
1.184 + */
1.185 + BURStatus Goto_NormalState( BURStatus aCurrent );
1.186 + /**
1.187 + * Feature manager state machine function.
1.188 + * This will put the Feature Manager into the "start backup" state. Where the Feature Manager
1.189 + * is expecting the BUR backup to start.
1.190 + * @param BURStatus current state
1.191 + * @return BURStatus the next state
1.192 + */
1.193 + BURStatus Goto_StartBackupState( BURStatus aCurrent );
1.194 + /**
1.195 + * Feature manager state machine function.
1.196 + * This will put the Feature Manager into the "end backup" state. Where the Feature Manager
1.197 + * is expecting the BUR backup has just ended, and it is required to return itself to a
1.198 + * normal operating mode.
1.199 + * @param BURStatus current state
1.200 + * @return BURStatus the next state
1.201 + */
1.202 + BURStatus Goto_EndBackupState( BURStatus aCurrent );
1.203 + /**
1.204 + * Feature manager state machine function.
1.205 + * This will put the Feature Manager into the "start restore" state. Where the Feature Manager
1.206 + * is expecting the BUR restore operation to start.
1.207 + * @param BURStatus current state
1.208 + * @return BURStatus the next state
1.209 + */
1.210 + BURStatus Goto_StartRestoreState( BURStatus aCurrent );
1.211 + /**
1.212 + * Feature manager state machine function.
1.213 + * This will put the Feature Manager into the "end restore" state. Where the Feature Manager
1.214 + * is expecting the BUR restore operation has just ended, and it is required to return itself
1.215 + * to a normal operating mode.
1.216 + * @param BURStatus current state
1.217 + * @return BURStatus the next state
1.218 + */
1.219 + BURStatus Goto_EndRestoreState( BURStatus aCurrent );
1.220 + /**
1.221 + * Feature manager state machine function.
1.222 + * This will return the Feature Manager from its current state, and into a "safe" state whereby
1.223 + * a normal operating mode is possible again. This is an error recovery function.
1.224 + * @param BURStatus current state
1.225 + * @return BURStatus the next state
1.226 + */
1.227 + BURStatus Goto_ErrorState( BURStatus aCurrent );
1.228 +
1.229 + private:
1.230 +
1.231 + /* Clears the feature array ready to re-populate it during a restore operation */
1.232 + void ClearFeaturesL( void );
1.233 + /* Reloads the feature array and merges features during a restore operation */
1.234 + void LoadFeaturesL( void );
1.235 + /* Handles any outstanding notifications after a restore operation */
1.236 + void HandleRestoredNotificationsL( void );
1.237 +
1.238 + private:
1.239 +
1.240 + /**
1.241 + C++ constructor.
1.242 + */
1.243 + CFeatMgrServer( const TInt aPriority,
1.244 + const TServerType aType = EUnsharableSessions );
1.245 + /**
1.246 + By default Symbian 2nd phase constructor is private.
1.247 + */
1.248 + void ConstructL();
1.249 +
1.250 + /**
1.251 + Creates a new session when client connects.
1.252 + @param aVersion Version
1.253 + @param aMessage 'connect' message from the client
1.254 + @return Pointer to created session or leaves with codes
1.255 + KErrNotSupported if versions does not match
1.256 + KErrNoMemory if creation of new session fails.
1.257 + */
1.258 + CSession2* NewSessionL( const TVersion& aVersion,
1.259 + const RMessage2& aMessage ) const;
1.260 + /**
1.261 + Panics the server thread
1.262 + @param aCategory Panicer's id
1.263 + @param aPanic Reason of panic
1.264 + @return void
1.265 + */
1.266 + void Panic( const TDesC& aCategory, const TInt aReason );
1.267 +
1.268 + /**
1.269 + Lists and loads Feature Manager plugins.
1.270 + */
1.271 + TBool LoadPluginsL();
1.272 +
1.273 + /**
1.274 + Deletes plugin handler if feature info is ready.
1.275 + */
1.276 + void DeletePlugins();
1.277 +
1.278 + /**
1.279 + Check whether plugins have finished processing.
1.280 + */
1.281 + void CheckPluginsReadyL();
1.282 +
1.283 + /**
1.284 + Calls ServicePendingRequestsL of sessions
1.285 + */
1.286 + void ServicePendingRequests();
1.287 +
1.288 + private: // Data
1.289 +
1.290 + // Timer pointer.
1.291 + CFeatMgrTimer* iTimer;
1.292 +
1.293 + CBurState iBurState;
1.294 +
1.295 + // ETrue when backup in progress
1.296 + TBool iBURInProgress;
1.297 +
1.298 + // ETrue when feature info received from all plugins
1.299 + TBool iPluginsReady;
1.300 +
1.301 + // Struct to contain information of found Feature Manager plugins
1.302 + struct SFeatMgrPluginInfo
1.303 + {
1.304 + // Plugin handler of the plugin
1.305 + CFeatMgrPluginHandler* iPluginHandler;
1.306 + // ETrue if feature info received from plugin handler
1.307 + TBool iPluginReady;
1.308 + };
1.309 +
1.310 + // Array of found Feature Manager plugins
1.311 + RArray<SFeatMgrPluginInfo> iPluginList;
1.312 +
1.313 + // ETrue if all plugin handlers are deleted
1.314 + TBool iPluginsDeleted;
1.315 +
1.316 + // ETrue if ServicePendingRequest not called yet.
1.317 + TBool iPendingRequests;
1.318 +
1.319 + // File server session
1.320 + RFs iFs;
1.321 +
1.322 + // ETrue when iPluginsReady is ETrue and all feature files have been read.
1.323 + TBool iFeaturesReady;
1.324 +
1.325 + CFeatMgrFeatureRegistry* iRegistry;
1.326 +
1.327 + // Backup Notification
1.328 + TUint32 iBackupFlag;
1.329 + CBaBackupSessionWrapper * iBackupNotification;
1.330 +
1.331 +#ifdef EXTENDED_FEATURE_MANAGER_TEST
1.332 + TInt iSessionCount;
1.333 + CShutdown iShutdown;
1.334 +#endif
1.335 + };
1.336 +
1.337 +#endif // FEATMGRSERVER_H
1.338 +
1.339 +// End of File