heartbeat.h

Go to the documentation of this file.

#ifndef HEARTBEAT_CLASS
#define HEARTBEAT_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : heartbeat                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1996-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/contracts.h>
#include <timely/time_stamp.h>
 
namespace processes {
 
 
class heartbeat : public virtual basis::root_object
{
public:
  heartbeat(int misses_allowed = 500, int check_interval = 10000);
 
  heartbeat(const heartbeat &to_copy);
 
  ~heartbeat();
 
  DEFINE_CLASS_NAME("heartbeat");
 
  heartbeat &operator =(const heartbeat &to_copy);
 
  basis::astring text_form(bool detailed = false) const;
 
  void reset(int misses_allowed, int check_interval);
 
  bool due() const;
 
  bool dead() const;
 
  void made_request();
 
  void need_beat() { made_request(); }
 
  void kabump();
 
  void recycle() { kabump(); }
 
  // reporting functions for internal state...
 
  int missed_so_far() const { return _misses; }
  int misses_left() const { return _misses_allowed - _misses; }
 
  int allowed_misses() const { return _misses_allowed; }
  int checking_interval() const { return _check_interval; }
 
  timely::time_stamp heartbeat_time() const;
 
  int time_left() const;
 
private:
  timely::time_stamp *_next_heartbeat;
  int _check_interval;
  int _misses_allowed;
  int _misses;
 
  void reset_next_beat();  
};
 
} //namespace.
 
#endif