codhandler/codeng/inc/Timeout.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:28:30 +0100
branchRCL_3
changeset 94 919f36ff910f
parent 0 dd21522fd290
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201034 Kit: 201035

/*
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "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: 
*      Declaration of class CTimeout.   
*      
*
*/


#ifndef TIMEOUT_H
#define TIMEOUT_H

// INCLUDE FILES

#include <e32base.h>

// CLASS DECLARATION

/**
* Timeout timer.
*/
NONSHARABLE_CLASS( CTimeout ): public CTimer
    {
    public:     // Construct / destruct

        /**
        * Two phase constructor. Leaves on failure.
        * @param aPriority Active object priority.
        * @param aCallback Callback to be called when timer expires.
        * This callback must return EFalse - it will NOT be called only again.
        * @return The constructed timeout timer.
        */      
        static CTimeout* NewL( TInt aPriority, TCallBack aCallBack );
        
        /**
        * Destructor.
        */
        virtual ~CTimeout();

    protected:  // from CActive

        /**
        * Outstanding request completed (timed out). CAsyncCallBack
        */
        virtual void RunL();

    protected:  // Construct / destruct

        /**
        * Constructor.
        * @param aPriority Active object priority.
        * @param aCallback Callback to be called when timer expires.
        */      
        CTimeout( TInt aPriority, TCallBack aCallBack );
        
    private:    // data

        TCallBack iCallBack;                ///< Callback.
    };

#endif /* def TIMEOUT_H */