1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/BackupNotifier.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,137 @@
     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 +// Defines the object that waits for notification of 
    1.18 +// Backup/Restore events from the EPOC OS
    1.19 +// 
    1.20 +//
    1.21 +
    1.22 +#ifndef __BACKUPNOTIFIER_H__
    1.23 +#define __BACKUPNOTIFIER_H__
    1.24 +
    1.25 +#include <e32base.h>
    1.26 +#include <babackup.h>
    1.27 +#include "BackupNotifierObserver.h"
    1.28 +
    1.29 + /**
    1.30 +	@internalComponent
    1.31 +	@since 7.0
    1.32 +	The notification object which waits for a signal that backup has begun/ended.
    1.33 +	When its RunL method is called, it notifies its owning CRegistrar class
    1.34 +	object to suspend/resume persistant storage of the Interface Implementation
    1.35 +	registration details.
    1.36 + */
    1.37 +
    1.38 +class CBackupNotifier : public CBase, private MBackupOperationObserver
    1.39 +	{
    1.40 +public:
    1.41 +	/**
    1.42 +		@fn				NewL(MBackupNotifierObserver& aObserver)
    1.43 +		Intended Usage	: Standardised safe construction which leaves nothing 
    1.44 +						on the cleanup stack.
    1.45 +		Error Condition	: Cannot fully construct because of memory limitations.	
    1.46 +		@leave  		KErrNoMemory
    1.47 +		@since			7.0
    1.48 +		@param			aRegistrar A reference to its owning class instance.
    1.49 +		@return			CBackupNotifier* A pointer to the new class
    1.50 +		@pre 			None
    1.51 +		@post			CBackupNotifier is fully constructed, and initialised.
    1.52 +	 */
    1.53 +	
    1.54 +	static CBackupNotifier* NewL(MBackupNotifierObserver& aObserver);
    1.55 +
    1.56 +	/**
    1.57 +		@fn				~CBackupNotifier()
    1.58 +		Intended Usage	: Standard default d'tor	
    1.59 +		Error Condition	: None	
    1.60 +		@since			7.0
    1.61 +		@pre 			CBackupNotifier is fully constructed.
    1.62 +		@post			CBackupNotifier is totally destroyed
    1.63 +	 */
    1.64 +	
    1.65 +	virtual ~CBackupNotifier();
    1.66 +
    1.67 +private:
    1.68 +	/**
    1.69 +		@fn				CBackupNotifier(MBackupNotifierObserver& aObserver)
    1.70 +		Intended Usage	: Default c'tor	
    1.71 +		Error Condition	: None	
    1.72 +		@since			7.0
    1.73 +		@param			aRegistrar A reference to its owning class instance.
    1.74 +		@pre 			None
    1.75 +		@post			CBackupNotifier is fully constructed
    1.76 +	 */
    1.77 +	
    1.78 +	CBackupNotifier(MBackupNotifierObserver& aObserver);
    1.79 +
    1.80 +	/**
    1.81 +		@fn				void ConstructL()
    1.82 +		Intended Usage	: Initialisation phase of two phase construction.
    1.83 +		Error Condition	: None
    1.84 +		@leave  		None
    1.85 +		@since			7.0
    1.86 +		@pre 			CBackupNotifier is fully constructed.
    1.87 +		@post			CBackupNotifier is fully initialised.
    1.88 +	 */
    1.89 +	
    1.90 +	void ConstructL();
    1.91 +
    1.92 +	/**
    1.93 +		@fn				HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)
    1.94 +		Intended Usage	: To allow a response to be made by an interested party fo a change in state of the 
    1.95 +						backup operation.
    1.96 +		@leave  		: @see CBaBackupSessionWrapper::NewL
    1.97 +		@leave  		: @see CBaBackupSessionWrapper::RegisterBackupOperationObserverL
    1.98 +		@since			7.0
    1.99 +		@param			aBackupOperationAttributes The current state of the backup operation.
   1.100 +		@return			void 
   1.101 +		@pre 			CBackupNotifier is fully constructed.
   1.102 +		@post			The aBackupOperationAttributes value will have been used
   1.103 +						to drive the suspend and restore behaviours of the ECOM Server.
   1.104 +	 */
   1.105 +	
   1.106 +	void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes);
   1.107 +
   1.108 +	/**
   1.109 +		@fn				RegisterForNotificationsL()
   1.110 +		Intended Usage	: To allow registration for notifications from the backup operation.
   1.111 +		Error Condition	: None
   1.112 +		@since			7.0
   1.113 +		@pre 			CBackupNotifier is fully constructed.
   1.114 +		@post			CBackupNotifier is registered for notification messages.
   1.115 +	 */
   1.116 +	
   1.117 +	void RegisterForNotificationsL();
   1.118 +
   1.119 +private:
   1.120 +	/** A reference to its observer instance */
   1.121 +	
   1.122 +	MBackupNotifierObserver& iObserver;
   1.123 +	/** The owned notification control object */
   1.124 +	
   1.125 +	CBaBackupSessionWrapper* iBackupSession;
   1.126 +	// Forward declare the retry controller as a friend
   1.127 +	class CRetryTimer;
   1.128 +	friend class CRetryTimer;
   1.129 +	/** The friendly timer for connection retries */
   1.130 +	
   1.131 +	CRetryTimer* iRetryTimer;
   1.132 +
   1.133 +	/** The flag indicating that registration occurred sucessfully */
   1.134 +	
   1.135 +	TBool iIsRegistered;
   1.136 +	/** Friendship declaration for testing purposes */
   1.137 +	friend class TBackupNotifier_StateAccessor;
   1.138 +	};
   1.139 +
   1.140 +#endif	// __BACKUPNOTIFIER_H__