---

timeout.cpp

Go to the documentation of this file.

// $Id$

//**********************************************************************
//                                                                     *
//                                                                     *
//    Description:   Timeout class.  Invokes a callback function on    *
//                   expiration.                                       *
//                                                                     *
//    Author:        Chris White (whitecf@bcs.org.uk)                  *
//                                                                     *
//    Copyright (C) 2003  Monitor Computing Services Ltd.              *
//                                                                     *
//    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 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 (http://www.gnu.org/copyleft/gpl.html) along with this   *
//    program; if not, write to:                                       *
//       The Free Software Foundation Inc.,                            *
//       59 Temple Place - Suite 330,                                  *
//       Boston, MA  02111-1307,                                       *
//       USA.                                                          *
//                                                                     *
//**********************************************************************
//                                                                     *
//    Notes:                                                           *
//                                                                     *
//**********************************************************************

#include <mytrace.h>
#include <tmoutlst.h>

#include "timeout.h"


using namespace Monitor::Utility;



Timeout::Timeout(const CallbackBase&    newWatch,
                 unsigned               newPeriod,
                 const string&          newName) :
    Watchable(),
    period(newPeriod), timeoutName(newName), expiredFlag(0)
{
#ifdef _DOENTRYTRACE_
    string    traceString("Timeout::Timeout[");

    traceString += timeoutName;
    traceString += "](newWatch, newPeriod, newName)";

    _USEMYTRACE_(traceString.c_str())
#endif
    addWatch(newWatch);

    reset(newPeriod);

    TimeoutList::addTimeout(*this);
}


Timeout::Timeout(unsigned               newPeriod,
                 const string&          newName) :
    Watchable(),
    period(newPeriod), timeoutName(newName), expiredFlag(0)
{
#ifdef _DOENTRYTRACE_
    string    traceString("Timeout::Timeout[");

    traceString += timeoutName;
    traceString += "](newPeriod, newName)";

    _USEMYTRACE_(traceString.c_str())
#endif

    reset(newPeriod);
}


Timeout::~Timeout()
{
#ifdef _DOENTRYTRACE_
    string    traceString("Timeout::~Timeout[");

    traceString += timeoutName;
    traceString += "]()";

    _USEMYTRACE_(traceString.c_str())
#endif
    TimeoutList::removeTimeout(*this);
}


int
Timeout::operator==(const Timeout&    other)
{
    return (&other == this);
}



void
Timeout::reset(unsigned    newPeriod)
{
#ifdef _DOENTRYTRACE_
    string    traceString("Timeout::reset[");

    traceString += timeoutName;
    traceString += "](newPeriod)";

    _USEMYTRACE_(traceString.c_str())
#endif
    if (0 < newPeriod)
    {
        period = newPeriod;
    }

    endTime = period;

    if (0 < endTime)
    {
        endTime *= CLK_TCK;
        endTime /= 1000;
    }
    
    endTime += clock();

    expiredFlag = 0;
}



int
Timeout::hasExpired() const
{
    return expiredFlag;
}



int
Timeout::run()
{
    int    retVal = 0;

    if (canRun())
    {
        retVal = !0;

        if (clock() >= endTime)
        {
            retVal = 0;

            expire();
        }
    }

    return retVal;
}



const string&
Timeout::getTimeoutName() const
{
    return timeoutName;
}



int
Timeout::canRun()
{
    return ((0 < endTime) &&
            !expiredFlag);
}



void
Timeout::expire()
{
#ifdef _DOENTRYTRACE_
    string    traceString("Timeout::expire[");

    traceString += timeoutName;
    traceString += "]()";

    _USEMYTRACE_(traceString.c_str())
#endif
    updated();

    expiredFlag = !0;
}

---