Humble Framework for SkyOS

---

HTimer.h

Go to the documentation of this file.

/****************************************************************************
**
**  $Header: /SkyOS.root/pig/Humble/HTimer.h 1     12/23/04 1:34p Neusel $
**
****************************************************************************/
#ifndef HTIMER_H
#   define  HTIMER_H

class HTimer : public HObjNoCopy
    {
    typedef HObjNoCopy  base_class;
    static StringPtr    ClassName(void) { return "HTimer"; }
/*  ----------------------------------------------------------------------
    VARIABLES
    ----------------------------------------------------------------------  */
protected:
    uint32              m_tid;          
    int32               m_nTimeOut;     
    HANDLE              m_hwndTarget;   
/*  ----------------------------------------------------------------------
    CTOR / DTOR
    ----------------------------------------------------------------------  */
public:
    HTimer(int32 nTimeOut = 0) : m_tid(0), m_nTimeOut(nTimeOut), m_hwndTarget(NULL)
        { ASSERT(nTimeOut >= 0); }
        
    virtual             
    ~HTimer(void)
        { (void) Stop(); }
/*  ----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------  */
public:
    ErrCode     
    Reached(void)
        {
        ErrCode     ec = HError::NoError();
        
        if (IsActive())
            {
            DEBUG_LOG("HTimer::Reached() => #%lu.\n", m_tid);
            m_tid = 0;
            }
            
        return ec;
        }
    ErrCode     
    Restart(void)
        { 
        ErrCode     ec = HError::NoError();
        
        DEBUG_LOG("HTimer::Restart() => #%lu.\n", m_tid);

        if (!IsActive() || 
            (ec = Stop()) == NO_ERROR)
            {
            ec = Start();
            }
                
        return ec;
        }
    ErrCode
    Start(HANDLE hWnd = NULL, int32 nTimeOut = 0)
        {
        ErrCode     ec = HError::NoError();

        if (m_nTimeOut <= 0 || nTimeOut > 0)
            m_nTimeOut = nTimeOut;
        
        if (NULL_HND(m_hwndTarget) || GOOD_HND(hWnd))
            m_hwndTarget = hWnd;

        if (GOOD_HND(hWnd) && m_nTimeOut > 0)
            {
            if (IsActive())
                {
                DEBUG_LOG("HTimer::Start() => started an active timer.\n");
                (void) Stop();
                }

            m_tid = GI_set_timer(m_hwndTarget, m_nTimeOut);
                
            if (IsActive())
                {
                DEBUG_LOG(  "HTimer::Start() => started #%lu with %ld second timeout.\n", 
                            m_tid, m_nTimeOut);
                }
            else
                ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);
            }
        else
            ec = HError::Set(ERR_BAD_PARAMETER, __FILE__, __LINE__);

        return ec;
        }
    ErrCode
    Stop(void)
        {
        ErrCode     ec = HError::NoError();
        
        if (IsActive())
            {
            if (GI_kill_timer(m_tid) == S_OK)
                {
                DEBUG_LOG("HTimer::Stop() => stopped #%lu.\n", m_tid);
                }
            else
                ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);

            m_tid = 0;
            m_hwndTarget = NULL;
            }

        return ec;
        }
/*  ----------------------------------------------------------------------
    GETTERS & SETTERS
    ----------------------------------------------------------------------  */
public:
    inline uint32       GetID(void) const
                            { return m_tid; }
    inline HANDLE       GetTarget(void) const
                            { return m_hwndTarget; }
    inline int32        GetTimeOut(void) const
                            { return m_nTimeOut; }
    ErrCode             SetTarget(HANDLE hWnd)
                            { 
                            ErrCode ec = HError::NoError();
                            
                            if (GOOD_HND(hWnd))
                                m_hwndTarget = hWnd;
                            else
                                ec = HError::Set(ERR_BAD_PARAMETER, __FILE__, __LINE__);
                            
                            return ec;
                            }
    ErrCode             SetTimeOut(int32 nTimeOut)
                            {
                            ErrCode ec = HError::NoError();
                            
                            if (nTimeOut > 0)
                                {
                                if (!IsActive())
                                    m_nTimeOut = nTimeOut;
                                else
                                    ec = HError::Set(ERR_NOT_IMPLEMENTED, __FILE__, __LINE__);
                                }
                            else
                                ec = HError::Set(ERR_BAD_PARAMETER, __FILE__, __LINE__);

                            return ec;
                            }
/*  ----------------------------------------------------------------------
    INLINES
    ----------------------------------------------------------------------  */
    inline bool         IsActive(void) const
                            { return (m_tid > 0); }
    };
#endif  // HTIMER_H
/****************************************************************************
**
**  $History: HTimer.h $
 * 
 * *****************  Version 1  *****************
 * User: Neusel       Date: 12/23/04   Time: 1:34p
 * Created in $/SkyOS.root/pig/Humble
 * Posted as HFramework-debug 20041223
**
**  -------------------------------------------------------------------------
**
**  End of HTimer.h
**
****************************************************************************/

---