include/vrfutil/splitContentTimer.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999-2001 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: splitContentTimer.h,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/


#ifndef DtSplitContentTimer_H_
#define DtSplitContentTimer_H_

#include "vrfutil/vrfutilDefines.h"

#include <map>
#include <vlutil/vlTime.h>

class DtSplitMessageKey;

typedef void (*DtSplitContentExpiredFcn)(const DtSplitMessageKey& key, void *pUsr);

class DT_DLL_vrfutil DtSplitContentTimer
{
public:
   
   typedef std::map<DtSplitMessageKey, DtTime> DtTimeoutMap;

public:

   DtSplitContentTimer();

   virtual ~DtSplitContentTimer();

   virtual void addTimeoutEntry(const DtSplitMessageKey& key, DtTime startTime);

   virtual void clear();

   virtual void evaluateTimeouts(DtTime timeNow, DtSplitContentExpiredFcn pFcn, void* pUsr);

   virtual bool findEntry(const DtSplitMessageKey& key, DtTime& retTime);

   virtual DtTime lastTimeoutCheckTime() const;
   virtual void setLastTimeoutCheckTime(DtTime nTime);

   virtual DtTime timeoutCheckInterval() const;
   virtual void setTimeoutCheckInterval(DtTime nSecs);

   virtual DtTime timeoutDuration() const;
   virtual void setTimeoutDuration(DtTime nSecs);

   virtual void removeTimeoutEntry(const DtSplitMessageKey& key);

protected:

   DtSplitContentTimer(const DtSplitContentTimer& orig);

   const DtSplitContentTimer& operator=(
      const DtSplitContentTimer& orig);

protected:
   DtTime         myLastTimeoutCheckTime;
   DtTime         myTimeoutCheckInterval;
   DtTime         myTimeoutDuration;
   DtTimeoutMap   myTimeoutMap;

   static const DtTime  theDefaultTimeoutCheckInterval;
   static const DtTime  theDefaultTimeoutDuration;
};

inline DtTime DtSplitContentTimer::lastTimeoutCheckTime() const
{
   return (myLastTimeoutCheckTime);
}

inline void DtSplitContentTimer::setLastTimeoutCheckTime(DtTime nTime)
{
   myLastTimeoutCheckTime = nTime;
}

inline DtTime DtSplitContentTimer::timeoutCheckInterval() const
{
   return (myTimeoutCheckInterval);
}

inline void DtSplitContentTimer::setTimeoutCheckInterval(DtTime nSecs)
{
   myTimeoutCheckInterval = nSecs;
}

inline DtTime DtSplitContentTimer::timeoutDuration() const
{
   return (myTimeoutDuration);
}

inline void DtSplitContentTimer::setTimeoutDuration(DtTime nSecs)
{
   myTimeoutDuration = nSecs;
}

#endif