1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/BackupNotifier.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,234 @@
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 +// Implements the object that waits for notification of
1.18 +// Backup/Restore events from the SymbianOS
1.19 +//
1.20 +//
1.21 +
1.22 +#include "BackupNotifier.h"
1.23 +#include "TestUtilities.h" // For __FILE__LINE__
1.24 +
1.25 +const TInt KRetryDelayPeriod = 15000000; // 15 second delay before retry
1.26 +
1.27 +/**
1.28 + @since 7.0
1.29 + The timer Active object for providing backup server connection retries.
1.30 + Note that task execution is dependant upon the task priority
1.31 + The default priority is idle time execution only.
1.32 + It is first scheduled by the CBackupNotifier::ConstructL() call.
1.33 + */
1.34 +class CBackupNotifier::CRetryTimer : public CTimer
1.35 + {
1.36 +public:
1.37 + /**
1.38 + @fn NewL(CBackupNotifier& aBackupNotifier)
1.39 + Intended Usage : Standardised safe construction which leaves nothing
1.40 + on the cleanup stack.
1.41 + Error Condition : Not enough memory available.
1.42 + @leave KErrNoMemory
1.43 + @since 7.0
1.44 + @param aBackupNotifier A reference to the owning CBackupNotifier
1.45 + @return CRetryTimer* a pointer to the new class
1.46 + @pre None
1.47 + @post CRetryTimer is fully constructed, and initialised.
1.48 + */
1.49 + static CRetryTimer* NewL(CBackupNotifier& aBackupNotifier);
1.50 +
1.51 + /**
1.52 + @fn virtual ~CRetryTimer()
1.53 + Intended Usage : Standard default d'tor
1.54 + Error Condition : None
1.55 + @since 7.0
1.56 + @pre CRetryTimer is fully constructed.
1.57 + @post CRetryTimer is totally destroyed
1.58 + */
1.59 + virtual ~CRetryTimer();
1.60 +
1.61 +private:
1.62 + /**
1.63 + @fn CRetryTimer(CBackupNotifier& aBackupNotifier)
1.64 + Intended Usage : Standardised default c'tor made explicit to avoid unintentional
1.65 + conversion construction by the compiler.
1.66 + Error Condition : None
1.67 + @since 7.0
1.68 + @param aBackupNotifier A reference to its owning class instance.
1.69 + @pre None
1.70 + @post CRetryTimer is fully constructed
1.71 + */
1.72 + explicit CRetryTimer(CBackupNotifier& aBackupNotifier);
1.73 +
1.74 + /**
1.75 + @fn void ConstructL()
1.76 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.77 + Error Condition : Leaves with error code : usually KErrNoMemory.
1.78 + @leave KErrNoMemory.
1.79 + @since 7.0
1.80 + @return void
1.81 + @pre CRetryTimer is fully constructed.
1.82 + @post CRetryTimer is fully initialised.
1.83 + */
1.84 + void ConstructL();
1.85 +
1.86 + /**
1.87 + @fn DoCancel()
1.88 + Intended Usage : The cancel action called by CActive::Cancel().
1.89 + Error Condition : None
1.90 + @since 7.0
1.91 + @pre CRetryTimer is fully constructed.
1.92 + @post CRetryTimer is no longer active on the current scheduler.
1.93 + */
1.94 + void DoCancel();
1.95 +
1.96 + /**
1.97 + @fn RunL()
1.98 + Intended Usage : When the object activates, this method calls
1.99 + the CBackupNotifier to attempt a reconnection to the backup service notifier.
1.100 + @leave KErrNoMemory
1.101 + @since 7.0
1.102 + @pre CRetryTimer is fully constructed.
1.103 + @post The notification service has been sccessfully connected.
1.104 + */
1.105 + void RunL();
1.106 +
1.107 + /**
1.108 + @fn RunError(TInt aError)
1.109 + Intended Usage : Called when the backup notification connection
1.110 + failed by leaving.
1.111 + @since 7.0
1.112 + @param aError The error code that the RunL left with.
1.113 + @return TInt KErrNone.
1.114 + @pre CRetryTimer is fully constructed.
1.115 + @post CRetryTimer is re-activated.
1.116 + */
1.117 + TInt RunError(TInt aError);
1.118 +
1.119 +private:
1.120 + /** A reference to its owning class instance */
1.121 + CBackupNotifier& iNotifier;
1.122 + };
1.123 +
1.124 +// __________________________________________________________________________
1.125 +//
1.126 +/*
1.127 + The timer Active object for providing backup service connection retry attempts.
1.128 +*/
1.129 +CBackupNotifier::CRetryTimer* CBackupNotifier::CRetryTimer::NewL(CBackupNotifier& aBackupNotifier)
1.130 + {
1.131 + CRetryTimer* self = new(ELeave) CRetryTimer(aBackupNotifier);
1.132 + CleanupStack::PushL(self);
1.133 + self->ConstructL();
1.134 + CleanupStack::Pop(self);
1.135 + return self;
1.136 + }
1.137 +
1.138 +CBackupNotifier::CRetryTimer::CRetryTimer(CBackupNotifier& aBackupNotifier)
1.139 + : CTimer(CActive::EPriorityIdle), iNotifier(aBackupNotifier)
1.140 + {
1.141 + // Safe because it cannot fail
1.142 + CActiveScheduler::Add(this);
1.143 + }
1.144 +
1.145 +void CBackupNotifier::CRetryTimer::ConstructL()
1.146 + {
1.147 + CTimer::ConstructL();
1.148 + }
1.149 +
1.150 +CBackupNotifier::CRetryTimer::~CRetryTimer()
1.151 + {
1.152 + Cancel();
1.153 + }
1.154 +
1.155 +void CBackupNotifier::CRetryTimer::DoCancel()
1.156 + {
1.157 + // Call the base class to ensure the timer is cancelled
1.158 + CTimer::DoCancel();
1.159 + }
1.160 +
1.161 +void CBackupNotifier::CRetryTimer::RunL()
1.162 +// When the object activates, this is method is called
1.163 +// and delegates to the CBackupNotifier to re-attempt
1.164 +// the service connection.
1.165 +//
1.166 + {
1.167 + iNotifier.RegisterForNotificationsL();
1.168 + }
1.169 +
1.170 +TInt CBackupNotifier::CRetryTimer::RunError(TInt /*aError*/)
1.171 +// When the notification connection fails, the RunL of the retry timer
1.172 +// leaves. We trap this here and allow the BackupNotifier to clean up
1.173 +// and reset for a retry.
1.174 + {
1.175 + After(KRetryDelayPeriod);
1.176 + return KErrNone; // Do not pass error back, as retry will happen
1.177 + }
1.178 +
1.179 +
1.180 +//___________________________________________________________________________
1.181 +//
1.182 +CBackupNotifier* CBackupNotifier::NewL(MBackupNotifierObserver& aObserver)
1.183 + {
1.184 + CBackupNotifier* self = new(ELeave) CBackupNotifier(aObserver);
1.185 + CleanupStack::PushL(self);
1.186 + self->ConstructL();
1.187 + CleanupStack::Pop(self);
1.188 + return self;
1.189 + }
1.190 +
1.191 +CBackupNotifier::CBackupNotifier(MBackupNotifierObserver& aObserver)
1.192 +: CBase(), iObserver(aObserver)
1.193 + {
1.194 + // Do nothing
1.195 + }
1.196 +
1.197 +CBackupNotifier::~CBackupNotifier()
1.198 + {
1.199 + if(iBackupSession)
1.200 + {
1.201 + if(iIsRegistered)
1.202 + iBackupSession->DeRegisterBackupOperationObserver(*this);
1.203 + delete iBackupSession;
1.204 + }
1.205 + delete iRetryTimer;
1.206 + }
1.207 +
1.208 +void CBackupNotifier::HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)
1.209 + {
1.210 + switch(aBackupOperationAttributes.iOperation)
1.211 + {
1.212 + case EStart:
1.213 + iObserver.Suspend();
1.214 + break;
1.215 + case EEnd:
1.216 + iObserver.Resume();
1.217 + break;
1.218 + default:
1.219 + break;
1.220 + }
1.221 + }
1.222 +
1.223 +void CBackupNotifier::ConstructL()
1.224 + {
1.225 + iRetryTimer = CRetryTimer::NewL(*this);
1.226 + iRetryTimer->After(KRetryDelayPeriod);
1.227 + return;
1.228 + }
1.229 +
1.230 +void CBackupNotifier::RegisterForNotificationsL()
1.231 + {
1.232 + if(!iBackupSession)
1.233 + iBackupSession = CBaBackupSessionWrapper::NewL();
1.234 +
1.235 + iBackupSession->RegisterBackupOperationObserverL(*this);
1.236 + iIsRegistered = ETrue;
1.237 + }