1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptomgmtlibs/securityutils/inc/callbacktimer.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,71 @@
1.4 +/*
1.5 +* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Contains functionality for a callback timer
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +/**
1.24 + @file
1.25 + @publishedPartner
1.26 + @released
1.27 +*/
1.28 +
1.29 +#ifndef __CALLBACKTIMER_H__
1.30 +#define __CALLBACKTIMER_H__
1.31 +
1.32 +#include <e32base.h>
1.33 +
1.34 +/**
1.35 + * Interface class for using the services of CCallbackTimer
1.36 + */
1.37 +class MTimerObserver
1.38 + {
1.39 +public:
1.40 + virtual ~MTimerObserver() {};
1.41 +
1.42 + /**
1.43 + * Call back function to handle the expiry of the timer
1.44 + * @param aError KErrNone if timer expired normally else any of the system-wide error codes to indicate a system error
1.45 + */
1.46 + virtual void TimerRun(TInt aError) = 0;
1.47 + };
1.48 +
1.49 +/**
1.50 + * A timer class that provides a call back on timer expiry
1.51 + */
1.52 +class CCallbackTimer : public CTimer
1.53 + {
1.54 + public:
1.55 +
1.56 + /**
1.57 + * Create and return a new instance of the CCallbackTimer. An ongoing timer operation can be cancelled by the client by calling the Cancel() method on this object.
1.58 + * @param aCallBackIf Callback interface that implements TimerRun() function
1.59 + * @param aEnableCancelCallback If ETrue cancel events (client initiated by calling Cancel() method) are notified. Default is EFalse
1.60 + */
1.61 + IMPORT_C static CCallbackTimer* NewL(MTimerObserver& aCallBackIf, TBool aEnableCancelCallback = EFalse);
1.62 +
1.63 +private:
1.64 + CCallbackTimer(MTimerObserver& aCallBackIf, TBool aEnableCancelCallback);
1.65 +
1.66 + // Methods from CTimer/CActive
1.67 + void RunL();
1.68 +
1.69 +private:
1.70 + MTimerObserver& iCallBackIf;
1.71 + TBool iEnableCancelCallback;
1.72 + };
1.73 +
1.74 +#endif // __CALLBACKTIMER_H__