basictimeout.h

来自「Linux下比较早的基于命令行的DVD播放器」· C头文件 代码 · 共 118 行

//
// Copyright (c) 2005 by Istv醤 V醨adi
//
// This file is part of dxr3Player, a DVD player written specifically 
// for the DXR3 (aka Hollywood+) decoder card.

// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef SCHED_BASICTIMEOUT_H
#define SCHED_BASICTIMEOUT_H
//------------------------------------------------------------------------------

#include "Timeout.h"

//------------------------------------------------------------------------------

namespace sched {

//------------------------------------------------------------------------------

/**
 * A basic timeout that stores the time value in a member variable and
 * provides some convenience functions to children.
 */
class BasicTimeout : public Timeout
{
protected:
    /**
     * The value of the timeout.
     */
    millis_t fireTime;

public:
    /**
     * Construct the timeout. The fire time will be INVALID_MILLIS
     */
    BasicTimeout();

    /**
     * Set the fire time.
     */
    void setFireTime(millis_t t);

    /**
     * Reset the fire time.
     */
    void resetFireTime();

    /**
     * Get the fire time.
     */
    millis_t getFireTime() const;

    /**
     * Fire the timeout if possible. The fire time will be reset, if a
     * timeout occurs.
     */
    virtual millis_t fire(millis_t atTime);

private:
    /**
     * Perform the real action.
     */
    virtual void handleTimeout() = 0;
};

//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------

inline BasicTimeout::BasicTimeout() : fireTime(INVALID_MILLIS)
{
}

//------------------------------------------------------------------------------

inline void BasicTimeout::setFireTime(millis_t t)
{
    fireTime = t;
}

//------------------------------------------------------------------------------

inline void BasicTimeout::resetFireTime()
{
    fireTime = INVALID_MILLIS;
}

//------------------------------------------------------------------------------

inline millis_t BasicTimeout::getFireTime() const
{
    return fireTime;
}

//------------------------------------------------------------------------------

} /* namespace sched */

//------------------------------------------------------------------------------
#endif // SCHED_BASICTIMEOUT_H

// Local variables:
// mode: c++
// End: