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: // Implements the object that waits for notification of 
sl@0: // Backup/Restore events from the SymbianOS
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include "BackupNotifier.h"
sl@0: #include "TestUtilities.h"	// For __FILE__LINE__
sl@0: 
sl@0: const TInt KRetryDelayPeriod = 15000000;	// 15 second delay before retry
sl@0: 
sl@0: /**
sl@0: 	@since 7.0	
sl@0: 	The timer Active object for providing backup server connection retries. 
sl@0: 	Note that task execution is dependant upon the task priority
sl@0: 	The default priority is idle time execution only.
sl@0: 	It is first scheduled by the CBackupNotifier::ConstructL() call.
sl@0:  */
sl@0: class CBackupNotifier::CRetryTimer : public CTimer
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 		@fn				NewL(CBackupNotifier& aBackupNotifier)
sl@0: 		Intended Usage	: Standardised safe construction which leaves nothing
sl@0: 						  on the cleanup stack.
sl@0: 		Error Condition	: Not enough memory available.	
sl@0: 		@leave			KErrNoMemory
sl@0: 		@since			7.0
sl@0: 		@param			aBackupNotifier A reference to the owning CBackupNotifier
sl@0: 		@return			CRetryTimer* a pointer to the new class
sl@0: 		@pre 			None
sl@0: 		@post			CRetryTimer is fully constructed, and initialised.
sl@0: 	 */	
sl@0: 	static CRetryTimer* NewL(CBackupNotifier& aBackupNotifier);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				virtual ~CRetryTimer()
sl@0: 		Intended Usage	: Standard default d'tor	
sl@0: 		Error Condition	: None	
sl@0: 		@since			7.0
sl@0: 		@pre 			CRetryTimer is fully constructed.
sl@0: 		@post			CRetryTimer is totally destroyed
sl@0: 	 */
sl@0: 	virtual ~CRetryTimer();
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 		@fn				CRetryTimer(CBackupNotifier& aBackupNotifier)
sl@0: 		Intended Usage	: Standardised default c'tor made explicit to avoid unintentional
sl@0: 						conversion construction by the compiler.	
sl@0: 		Error Condition	: None	
sl@0: 		@since			7.0
sl@0: 		@param			aBackupNotifier A reference to its owning class instance.
sl@0: 		@pre 			None
sl@0: 		@post			CRetryTimer is fully constructed
sl@0: 	 */
sl@0: 	explicit CRetryTimer(CBackupNotifier& aBackupNotifier);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				void ConstructL()
sl@0: 		Intended Usage	: Standardised 2nd, (Initialisation) phase of two phase construction.
sl@0: 		Error Condition	: Leaves with error code : usually KErrNoMemory.
sl@0: 		@leave			KErrNoMemory.
sl@0: 		@since			7.0
sl@0: 		@return			void 
sl@0: 		@pre 			CRetryTimer is fully constructed.
sl@0: 		@post			CRetryTimer is fully initialised.
sl@0: 	 */
sl@0: 	void ConstructL();
sl@0: 
sl@0: 	/**
sl@0: 		@fn				DoCancel()
sl@0: 		Intended Usage	: The cancel action called by CActive::Cancel(). 
sl@0: 		Error Condition	: None	
sl@0: 		@since			7.0
sl@0: 		@pre 			CRetryTimer is fully constructed.
sl@0: 		@post			CRetryTimer is no longer active on the current scheduler.
sl@0: 	 */
sl@0: 	void DoCancel();
sl@0: 
sl@0: 	/**
sl@0: 		@fn				RunL()
sl@0: 		Intended Usage	: When the object activates, this method calls
sl@0: 						the CBackupNotifier to attempt a reconnection to the backup service notifier. 
sl@0: 		@leave  		KErrNoMemory
sl@0: 		@since			7.0
sl@0: 		@pre 			CRetryTimer is fully constructed.
sl@0: 		@post			The notification service has been sccessfully connected.
sl@0: 	 */
sl@0: 	void RunL();
sl@0: 
sl@0: 	/**
sl@0: 		@fn				RunError(TInt aError)
sl@0: 		Intended Usage	: Called when the backup notification connection
sl@0: 						failed by leaving.
sl@0: 		@since			7.0
sl@0: 		@param			aError The error code that the RunL left with.
sl@0: 		@return			TInt KErrNone. 
sl@0: 		@pre 			CRetryTimer is fully constructed.
sl@0: 		@post			CRetryTimer is re-activated.
sl@0: 	 */
sl@0: 	TInt RunError(TInt aError);
sl@0: 
sl@0: private:
sl@0: 	/** A reference to its owning class instance */
sl@0: 	CBackupNotifier& iNotifier;	
sl@0: 	};
sl@0: 
sl@0: // __________________________________________________________________________
sl@0: //
sl@0: /*
sl@0: 	The timer Active object for providing backup service connection retry attempts.
sl@0: */
sl@0: CBackupNotifier::CRetryTimer* CBackupNotifier::CRetryTimer::NewL(CBackupNotifier& aBackupNotifier)
sl@0: 	{
sl@0: 	CRetryTimer* self = new(ELeave) CRetryTimer(aBackupNotifier);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: CBackupNotifier::CRetryTimer::CRetryTimer(CBackupNotifier& aBackupNotifier)
sl@0: 	: CTimer(CActive::EPriorityIdle), iNotifier(aBackupNotifier)
sl@0: 	{
sl@0: 	// Safe because it cannot fail
sl@0: 	CActiveScheduler::Add(this);
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::CRetryTimer::ConstructL()
sl@0: 	{	
sl@0: 	CTimer::ConstructL();
sl@0: 	}
sl@0: 
sl@0: CBackupNotifier::CRetryTimer::~CRetryTimer()
sl@0: 	{
sl@0: 	Cancel();
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::CRetryTimer::DoCancel()
sl@0: 	{
sl@0: 	// Call the base class to ensure the timer is cancelled
sl@0: 	CTimer::DoCancel();
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::CRetryTimer::RunL()
sl@0: //	When the object activates, this is method is called
sl@0: //  and delegates to the CBackupNotifier to re-attempt
sl@0: //  the service connection.
sl@0: //
sl@0: 	{
sl@0: 	iNotifier.RegisterForNotificationsL();
sl@0: 	}
sl@0: 
sl@0: TInt CBackupNotifier::CRetryTimer::RunError(TInt /*aError*/)
sl@0: // When the notification connection fails, the RunL of the retry timer
sl@0: // leaves. We trap this here and allow the BackupNotifier to clean up
sl@0: // and reset for a retry.
sl@0: 	{
sl@0: 	After(KRetryDelayPeriod);
sl@0: 	return KErrNone;	// Do not pass error back, as retry will happen
sl@0: 	}
sl@0: 
sl@0: 
sl@0: //___________________________________________________________________________
sl@0: //
sl@0: CBackupNotifier* CBackupNotifier::NewL(MBackupNotifierObserver& aObserver)
sl@0: 	{
sl@0: 	CBackupNotifier* self = new(ELeave) CBackupNotifier(aObserver);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: CBackupNotifier::CBackupNotifier(MBackupNotifierObserver& aObserver)
sl@0: : CBase(), iObserver(aObserver)
sl@0: 	{
sl@0: 	// Do nothing
sl@0: 	}
sl@0: 
sl@0: CBackupNotifier::~CBackupNotifier()
sl@0: 	{
sl@0: 	if(iBackupSession)
sl@0: 		{
sl@0: 		if(iIsRegistered)
sl@0: 			iBackupSession->DeRegisterBackupOperationObserver(*this);
sl@0: 		delete iBackupSession;
sl@0: 		}
sl@0: 	delete iRetryTimer;
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)
sl@0: 	{
sl@0: 	switch(aBackupOperationAttributes.iOperation)
sl@0: 		{
sl@0: 		case EStart:
sl@0: 			iObserver.Suspend();
sl@0: 			break;
sl@0: 		case EEnd:
sl@0: 			iObserver.Resume();
sl@0: 			break;
sl@0: 		default:
sl@0: 			break;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::ConstructL()
sl@0: 	{
sl@0: 	iRetryTimer = CRetryTimer::NewL(*this);
sl@0: 	iRetryTimer->After(KRetryDelayPeriod);
sl@0: 	return;
sl@0: 	}
sl@0: 
sl@0: void CBackupNotifier::RegisterForNotificationsL()
sl@0: 	{
sl@0: 	if(!iBackupSession)
sl@0: 		iBackupSession = CBaBackupSessionWrapper::NewL();
sl@0: 
sl@0: 	iBackupSession->RegisterBackupOperationObserverL(*this);
sl@0: 	iIsRegistered = ETrue;
sl@0: 	}