1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/Baksrv.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,310 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// generic backup server
1.18 +//
1.19 +//
1.20 +
1.21 +#if !defined(__BAKSRV_H__)
1.22 +#define __BAKSRV_H__
1.23 +
1.24 +#include <e32std.h>
1.25 +#include <e32base.h>
1.26 +#include <babackup.h>
1.27 +#include <badesca.h>
1.28 +#include <bsul/clientmessage.h>
1.29 +
1.30 +//Forward declarations
1.31 +class BSUL::CClientMessage;
1.32 +
1.33 +/**
1.34 +@internalTechnology
1.35 +*/
1.36 +const TInt KBakServMajorVN =0;
1.37 +const TInt KBakServMinorVN =1;
1.38 +const TInt KBakServBuildVN =1;
1.39 +const TInt KBakServMessageSlots =4; // no async messages to backup server
1.40 +
1.41 +/**
1.42 +@internalTechnology
1.43 +*/
1.44 +enum TBaBackupServPanic
1.45 + {
1.46 + EReqAlreadyOutstanding =0,
1.47 + EReqDoesNotExist =1,
1.48 + EBadFileName =2,
1.49 + ELocksAlreadyReleased =3,
1.50 + EBufferOverflow =4,
1.51 + ENoEventToFetch =5,
1.52 + EHandleNotClosed =6,
1.53 + };
1.54 +
1.55 +class CBaServBackupSession;
1.56 +
1.57 +/**
1.58 +@internalTechnology
1.59 +*/
1.60 +enum TCompletionType
1.61 + {
1.62 + ECompleteSync =0x00,
1.63 + ECompleteAsync =0x01,
1.64 + };
1.65 +
1.66 +
1.67 +/**
1.68 +@internalTechnology
1.69 +*/
1.70 +class CBaServBackupScheduler : public CActiveScheduler
1.71 + {
1.72 +public:
1.73 + IMPORT_C CBaServBackupScheduler();
1.74 + inline static CBaServBackupScheduler* Current();
1.75 + IMPORT_C void SetErrorHandler(CBaServBackupSession* aErrorHandler);
1.76 + IMPORT_C ~CBaServBackupScheduler();
1.77 +public: // from CActiveScheduler
1.78 + IMPORT_C virtual void Error(TInt aError) const;
1.79 +private:
1.80 + CBaServBackupSession* iErrorHandler;
1.81 + };
1.82 +
1.83 +/**
1.84 +@internalTechnology
1.85 +*/
1.86 +NONSHARABLE_CLASS(CBaServBackupMessageQueue) : public CBase
1.87 + {
1.88 +public:
1.89 + static CBaServBackupMessageQueue* NewL();
1.90 + ~CBaServBackupMessageQueue();
1.91 + void AddItemL(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlag);
1.92 + void AddItem(const TDesC& aFileName);
1.93 + TBool IsEmpty() const;
1.94 + void GetHead(TDes& aFileName,MBackupObserver::TFileLockFlags& aFlag) const;
1.95 + void RemoveHead();
1.96 + void RemoveItem(const TDesC& aFileName);
1.97 +private:
1.98 + TInt HeadIndex() const;
1.99 +private:
1.100 + enum TOperation
1.101 + {
1.102 + ENoOp =-1,
1.103 + ETakeLock =0,
1.104 + };
1.105 + class TQueueItem
1.106 + {
1.107 + public:
1.108 + inline TQueueItem(HBufC* aFileName,TInt aOperation);
1.109 + public:
1.110 + HBufC* iFileName;
1.111 + TInt iOperation;
1.112 + };
1.113 +private:
1.114 + RArray<TQueueItem> iQueue;
1.115 + };
1.116 +
1.117 +class CBaBackupServer;
1.118 +
1.119 +/**
1.120 +@internalTechnology
1.121 +*/
1.122 +class CBaServBackupSession : public CSession2
1.123 +
1.124 + {
1.125 +public:
1.126 + class TClosedFile
1.127 + {
1.128 + public:
1.129 + inline TBool operator==(const TClosedFile& aClosedFile) const;
1.130 + public:
1.131 + TFileName iDocName;
1.132 + TUid iUid;
1.133 + };
1.134 + enum TLockType
1.135 + {ENull,ERelease,ETake,EPendingReleaseReadOnly,EPendingReleaseNoAccess,EPendingTake};
1.136 + class TFileLock
1.137 + {
1.138 + public:
1.139 + RMessagePtr2 iMessagePtr;
1.140 + TLockType iRequest;
1.141 + HBufC* iFileName;
1.142 + };
1.143 +public:
1.144 + class CReRegistrationTimer;
1.145 +public:
1.146 + IMPORT_C ~CBaServBackupSession();
1.147 + inline CBaBackupServer* BackupServer() const;
1.148 +public:
1.149 + IMPORT_C virtual void HandleError(TInt aError);
1.150 +protected: // from CSession
1.151 + IMPORT_C virtual void ServiceL(const RMessage2& aMessage);
1.152 + IMPORT_C virtual void CreateL();
1.153 +protected:
1.154 + IMPORT_C virtual void ConstructL();
1.155 + IMPORT_C virtual TCompletionType CloseAllFilesL(const RMessage2& aMessage);
1.156 + IMPORT_C TCompletionType DoCloseAllFilesL(const RMessage2& aMessage);
1.157 + IMPORT_C virtual void RestartAll();
1.158 +protected:
1.159 + IMPORT_C CBaServBackupSession();
1.160 + inline CArrayFix<TClosedFile>* ClosedFiles() const;
1.161 + inline void SetClosedFiles(CArrayFix<TClosedFile>* aClosedFiles);
1.162 + inline TInt UniqueClientId() const;
1.163 +public:
1.164 + static CBaServBackupSession* NewL();
1.165 + void SignalReleaseAllFileLocksL(MBackupObserver::TFileLockFlags aFlag);
1.166 + void SignalRetakeAllFileLocks();
1.167 + void SignalReleaseFileLockL(MBackupObserver::TFileLockFlags aFlag,const TDesC& aFileName);
1.168 + void SignalRetakeFileLocks(const TDesC& aFileName);
1.169 + void SignalBackupOperation(const TBackupOperationAttributes& aBackupOperationAttributes);
1.170 +private:
1.171 + static void CleanupCloseAllFiles(TAny* aPtr);
1.172 + void HandleEventReadyL();
1.173 + void GetEventL();
1.174 + void RestartFileL();
1.175 + void NotifyLockChangeL();
1.176 + void NotifyLockChangeCancelL();
1.177 + void GetFileNameL(TDes& aFileName);
1.178 + void BackupOperationEventReadyL();
1.179 + void GetBackupOperationEventL(const RMessagePtr2& aPtr);
1.180 + void GetBackupOperationStateL();
1.181 + void DoRestartAll();
1.182 + void NotifyBackupOperationL();
1.183 + void DoServiceL(TCompletionType& aCompleteType);
1.184 + void CloseFileL();
1.185 + void StopNotifications();
1.186 +private:
1.187 + TUint32 iUniqueClientId;
1.188 + CBaServBackupMessageQueue* iMessageQueue;
1.189 + RMessagePtr2 iNotificationPullMsg;
1.190 + CArrayFix<TClosedFile>* iClosedFiles;
1.191 + CDesCArray* iFileLockObservers;
1.192 + CDesCArray* iReleasedFiles;
1.193 + RMessagePtr2 iBackupOperationMessagePtr;
1.194 + TBackupOperationAttributes iBackupOperationAttributes;
1.195 + TBool iBackupOperationObserverPresent;
1.196 + CReRegistrationTimer* iReRegistrationTimer; /* File lock re-registration timer */
1.197 + BSUL::CClientMessage* iClientMessage;
1.198 +
1.199 + };
1.200 +
1.201 +class CShutdownServer;
1.202 +
1.203 +/**
1.204 +@internalTechnology
1.205 +*/
1.206 +class CBaBackupServerExt : public CBase
1.207 + {
1.208 +public:
1.209 + TUint32 iCachedBusyClientId;
1.210 + TUint32 iUniqueBusyClientId;
1.211 + };
1.212 +
1.213 +//
1.214 +// CBaBackupServer
1.215 +//
1.216 +
1.217 +
1.218 +/**
1.219 +@internalTechnology
1.220 +*/
1.221 +class CBaBackupServer : public CServer2
1.222 +
1.223 + {
1.224 +public:
1.225 + class CBaServCloseAllOperationTimer;
1.226 +public:
1.227 + IMPORT_C static CBaBackupServer* NewL();
1.228 + IMPORT_C ~CBaBackupServer();
1.229 + IMPORT_C void SetBusy(TUint32 aUniqueClientId);
1.230 + IMPORT_C TBool IsClientBusy(TUint32 aUniqueClientId) const;
1.231 + IMPORT_C void SignalBackupOperation(const TBackupOperationAttributes& aBackupOperationAttributes);
1.232 + IMPORT_C TBool HaveAllCloseAllFilesClientsReRegistered();
1.233 + IMPORT_C void SetCloseAllOperationRunningState(TBool aRunning);
1.234 +public:
1.235 + inline TBool IsBackupOperationRunning() const;
1.236 + inline void SetBackupOperationRunning(TBool aBackupOperationRunning);
1.237 +public:
1.238 + IMPORT_C virtual void CloseAllFilesL(MBackupObserver::TFileLockFlags aFlag);
1.239 + IMPORT_C virtual void RestartAll();
1.240 + IMPORT_C virtual void ConstructL();
1.241 + IMPORT_C virtual void CompleteClosingFiles(CArrayFix<CBaServBackupSession::TClosedFile>* aClosedFiles);
1.242 + IMPORT_C virtual TBool IsOtherClientBusy(TUint32 aUniqueClientId) const;
1.243 +public:
1.244 + void CloseFileL(MBackupObserver::TFileLockFlags aFlag,const TDesC& aFileName);
1.245 + void RestartFile(const TDesC& aFileName);
1.246 + void AddSession();
1.247 + void DropSession();
1.248 + void IncrementRegisteredFilesCount();
1.249 + void DecrementRegisteredFilesCount(TInt aNumberFiles = 1);
1.250 + void IncrementFilesReRegistrationCount();
1.251 + void StartCloseAllFilesOperationTimer(const RMessagePtr2& aPtr);
1.252 + TBool IsCloseAllOperationRunning();
1.253 +public: // from CServer
1.254 + IMPORT_C TInt RunError(TInt aError);
1.255 +protected:
1.256 + IMPORT_C CBaBackupServer(TInt aPriority);
1.257 +protected: // from CServer
1.258 + IMPORT_C CSession2* NewSessionL(const TVersion &aVersion, const RMessage2& aMessage) const;
1.259 +private:
1.260 + CBaBackupServerExt* iExtension;
1.261 + TBool iBackupOperationRunning;
1.262 + TInt iSessionCount;
1.263 + CShutdownServer* iShutdown;
1.264 + TInt16 iRegisteredFilesCount;
1.265 + TInt16 iSessionLockReRegistrationCount; /* Number of file lock sessions currently registered */
1.266 + CBaServCloseAllOperationTimer* iCloseAllFilesOperationTimer; /* Base file lock re-registration timer */
1.267 + TBool iCloseAllOperationRunning; /* Indicates that a CloseAll operation is in progress */
1.268 + };
1.269 +
1.270 +inline CBaServBackupScheduler* CBaServBackupScheduler::Current()
1.271 + { // static
1.272 + return static_cast<CBaServBackupScheduler*>(CActiveScheduler::Current());
1.273 + }
1.274 +
1.275 +inline CBaBackupServer* CBaServBackupSession::BackupServer() const
1.276 + {
1.277 + return static_cast<CBaBackupServer*>(const_cast<CServer2*>(CSession2::Server()));
1.278 + }
1.279 +
1.280 +inline CArrayFix<CBaServBackupSession::TClosedFile>* CBaServBackupSession::ClosedFiles() const
1.281 + {
1.282 + return iClosedFiles;
1.283 + }
1.284 +
1.285 +inline void CBaServBackupSession::SetClosedFiles(CArrayFix<TClosedFile>* aClosedFiles)
1.286 + {
1.287 + if(!iClosedFiles)
1.288 + {
1.289 + iClosedFiles=aClosedFiles;
1.290 + }
1.291 + }
1.292 +
1.293 +inline TInt CBaServBackupSession::UniqueClientId() const
1.294 + {
1.295 + return iUniqueClientId;
1.296 + }
1.297 +
1.298 +inline TBool CBaServBackupSession::TClosedFile::operator==(const TClosedFile& aClosedFile) const
1.299 + {
1.300 + return iDocName==aClosedFile.iDocName && iUid==aClosedFile.iUid;
1.301 + }
1.302 +
1.303 +inline TBool CBaBackupServer::IsBackupOperationRunning() const
1.304 + {
1.305 + return iBackupOperationRunning;
1.306 + }
1.307 +
1.308 +inline void CBaBackupServer::SetBackupOperationRunning(TBool aBackupOperationRunning)
1.309 + {
1.310 + iBackupOperationRunning = aBackupOperationRunning;
1.311 + }
1.312 +
1.313 +#endif