/*

* Copyright (c) 2002 - 2007 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Implements timeout for asynchronous operations.

*

*/

#include <e32svr.h>

#include <StifParser.h>

#include <StifLogger.h>

#include <Stiftestinterface.h>

/* This class is used to notify the observer 

*  about the timeout 

*/

class MTimeoutObserver

{

    public: // New functions

    /**

    * Timeout 

    */

    virtual void HandleTimeout(TInt error) = 0;

};

_LIT(KFormatTimeStamp, "%:0%J%:1%T%:2%S%.%*C4%:3%+B");

/* This class is used for extra time controlling

*  The STIF timeout isn't enough

*/

class CSimpleTimeout : public CActive

{

    public:     // Enumerations

    // None

    private:    // Enumerations

    // None

    public:     // Constructors and destructor

    /**

    * Two-phased constructor.

    */

    static CSimpleTimeout* NewL( MTimeoutObserver* aObserver, CStifLogger* aLogger);

    /**

    * Destructor.

    */

    ~CSimpleTimeout();

    public:     // New functions

    /**

    * Starts timeout counting

    */

    void Start(TTimeIntervalMicroSeconds aTimeout);

    /**

    * Cancel timeout counting

    */

    void Stop();

    public:     // Functions from base classes

    /**

    * RunL derived from CActive handles the completed requests.

    */

    void RunL();

    /**

    * DoCancel derived from CActive handles the cancel

    */

    void DoCancel();

    /**

    * RunError derived from CActive handles errors from active handler.

    */

    TInt RunError( TInt aError );

    protected:  // New functions

    // None

    protected:  // Functions from base classes

    // None

    private:

    /**

    * By default Symbian OS constructor is private.

    */

    void ConstructL(MTimeoutObserver* aObserver, CStifLogger* aLogger);

    /**

    * C++ constructor.

    */

    CSimpleTimeout();

    public:     // Data

    // None

    protected:  // Data

    // None

    private:    // Data

    MTimeoutObserver*   iObserver;

    RTimer 						  iTimer;

    // Storage for testcase timeout.

    TTime 						iTestCaseTimeout;

    CStifLogger*				iLog;

    public:     // Friend classes

    // None

    protected:  // Friend classes

    // None

    private:    // Friend classes

    // None

};