sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Defines the object that waits for notification of 
sl@0: // Backup/Restore events from the EPOC OS
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __BACKUPNOTIFIER_H__
sl@0: #define __BACKUPNOTIFIER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <babackup.h>
sl@0: #include "BackupNotifierObserver.h"
sl@0: 
sl@0:  /**
sl@0: 	@internalComponent
sl@0: 	@since 7.0
sl@0: 	The notification object which waits for a signal that backup has begun/ended.
sl@0: 	When its RunL method is called, it notifies its owning CRegistrar class
sl@0: 	object to suspend/resume persistant storage of the Interface Implementation
sl@0: 	registration details.
sl@0:  */
sl@0: 
sl@0: class CBackupNotifier : public CBase, private MBackupOperationObserver
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 		@fn				NewL(MBackupNotifierObserver& aObserver)
sl@0: 		Intended Usage	: Standardised safe construction which leaves nothing 
sl@0: 						on the cleanup stack.
sl@0: 		Error Condition	: Cannot fully construct because of memory limitations.	
sl@0: 		@leave  		KErrNoMemory
sl@0: 		@since			7.0
sl@0: 		@param			aRegistrar A reference to its owning class instance.
sl@0: 		@return			CBackupNotifier* A pointer to the new class
sl@0: 		@pre 			None
sl@0: 		@post			CBackupNotifier is fully constructed, and initialised.
sl@0: 	 */
sl@0: 	
sl@0: 	static CBackupNotifier* NewL(MBackupNotifierObserver& aObserver);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				~CBackupNotifier()
sl@0: 		Intended Usage	: Standard default d'tor	
sl@0: 		Error Condition	: None	
sl@0: 		@since			7.0
sl@0: 		@pre 			CBackupNotifier is fully constructed.
sl@0: 		@post			CBackupNotifier is totally destroyed
sl@0: 	 */
sl@0: 	
sl@0: 	virtual ~CBackupNotifier();
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 		@fn				CBackupNotifier(MBackupNotifierObserver& aObserver)
sl@0: 		Intended Usage	: Default c'tor	
sl@0: 		Error Condition	: None	
sl@0: 		@since			7.0
sl@0: 		@param			aRegistrar A reference to its owning class instance.
sl@0: 		@pre 			None
sl@0: 		@post			CBackupNotifier is fully constructed
sl@0: 	 */
sl@0: 	
sl@0: 	CBackupNotifier(MBackupNotifierObserver& aObserver);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				void ConstructL()
sl@0: 		Intended Usage	: Initialisation phase of two phase construction.
sl@0: 		Error Condition	: None
sl@0: 		@leave  		None
sl@0: 		@since			7.0
sl@0: 		@pre 			CBackupNotifier is fully constructed.
sl@0: 		@post			CBackupNotifier is fully initialised.
sl@0: 	 */
sl@0: 	
sl@0: 	void ConstructL();
sl@0: 
sl@0: 	/**
sl@0: 		@fn				HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)
sl@0: 		Intended Usage	: To allow a response to be made by an interested party fo a change in state of the 
sl@0: 						backup operation.
sl@0: 		@leave  		: @see CBaBackupSessionWrapper::NewL
sl@0: 		@leave  		: @see CBaBackupSessionWrapper::RegisterBackupOperationObserverL
sl@0: 		@since			7.0
sl@0: 		@param			aBackupOperationAttributes The current state of the backup operation.
sl@0: 		@return			void 
sl@0: 		@pre 			CBackupNotifier is fully constructed.
sl@0: 		@post			The aBackupOperationAttributes value will have been used
sl@0: 						to drive the suspend and restore behaviours of the ECOM Server.
sl@0: 	 */
sl@0: 	
sl@0: 	void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				RegisterForNotificationsL()
sl@0: 		Intended Usage	: To allow registration for notifications from the backup operation.
sl@0: 		Error Condition	: None
sl@0: 		@since			7.0
sl@0: 		@pre 			CBackupNotifier is fully constructed.
sl@0: 		@post			CBackupNotifier is registered for notification messages.
sl@0: 	 */
sl@0: 	
sl@0: 	void RegisterForNotificationsL();
sl@0: 
sl@0: private:
sl@0: 	/** A reference to its observer instance */
sl@0: 	
sl@0: 	MBackupNotifierObserver& iObserver;
sl@0: 	/** The owned notification control object */
sl@0: 	
sl@0: 	CBaBackupSessionWrapper* iBackupSession;
sl@0: 	// Forward declare the retry controller as a friend
sl@0: 	class CRetryTimer;
sl@0: 	friend class CRetryTimer;
sl@0: 	/** The friendly timer for connection retries */
sl@0: 	
sl@0: 	CRetryTimer* iRetryTimer;
sl@0: 
sl@0: 	/** The flag indicating that registration occurred sucessfully */
sl@0: 	
sl@0: 	TBool iIsRegistered;
sl@0: 	/** Friendship declaration for testing purposes */
sl@0: 	friend class TBackupNotifier_StateAccessor;
sl@0: 	};
sl@0: 
sl@0: #endif	// __BACKUPNOTIFIER_H__