util/Timeout.h

Go to the documentation of this file.

/*-----------------------------------------------------------------------------
Name:      Timeout.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Allows you be called back after a given delay.
-----------------------------------------------------------------------------*/

#ifndef _UTIL_TIMEOUT_H
#define _UTIL_TIMEOUT_H

#include <util/xmlBlasterDef.h>
#include <util/I_Timeout.h>
#include <util/Timestamp.h>

#include <string>
#include <map>
#include <util/thread/ThreadImpl.h>

namespace org { namespace xmlBlaster { namespace util {

   typedef std::pair<I_Timeout*, void*> Container;
   typedef std::map<org::xmlBlaster::util::Timestamp, Container> TimeoutMap;


class Dll_Export Timeout : public org::xmlBlaster::util::thread::Thread
{

 private: 
   std::string ME; //  = "Timeout";
   std::string threadName_;
//   boost::thread* runningThread_;
   TimeoutMap timeoutMap_;
   // private TreeMap std::map = null;
   bool isRunning_; //  = true;
   bool isReady_; //  = false;

   bool mapHasNewEntry_;

   bool isActive_;
   const bool isDebug_; //  = false;

   const bool detached_;

   org::xmlBlaster::util::TimestampFactory& timestampFactory_;

   org::xmlBlaster::util::Global& global_;
   org::xmlBlaster::util::I_Log&    log_;

   org::xmlBlaster::util::thread::Mutex invocationMutex_;   
   org::xmlBlaster::util::thread::Mutex waitForTimeoutMutex_;
   org::xmlBlaster::util::thread::Condition waitForTimeoutCondition_;

   size_t getTimeoutMapSize();

    bool start(bool detached);

//   friend class TimeoutRunner;
 public:

   Timeout(org::xmlBlaster::util::Global& global);

   Timeout(org::xmlBlaster::util::Global& global, const std::string &name);

    ~Timeout();

   void join();

//   void operator()();

   int getSize() const {
      return (int)timeoutMap_.size();
   }

    org::xmlBlaster::util::Timestamp addTimeoutListener(I_Timeout *listener, long delay, void *userData);

   org::xmlBlaster::util::Timestamp refreshTimeoutListener(org::xmlBlaster::util::Timestamp key, long delay); 

    org::xmlBlaster::util::Timestamp addOrRefreshTimeoutListener(I_Timeout *listener, 
                                                  long delay, void *userData, org::xmlBlaster::util::Timestamp key);
   // throws org::xmlBlaster::util::XmlBlasterException

   void removeTimeoutListener(org::xmlBlaster::util::Timestamp key);

   bool isExpired(org::xmlBlaster::util::Timestamp key);

   long spanToTimeout(org::xmlBlaster::util::Timestamp key);

   long getTimeout(org::xmlBlaster::util::Timestamp key);

   void removeAll();

   void shutdown();

   void run();

};

}}} // namespaces

#endif