hoople_service.h

Go to the documentation of this file.

#ifndef HOOPLE_SERVICE_CLASS
#define HOOPLE_SERVICE_CLASS
 
// Name   : hoople_service
// Author : Chris Koeritz
// Copyright (c) 2000-$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:
//     http://www.gnu.org/licenses/gpl.html
// or under the terms of the GNU Library license:
//     http://www.gnu.org/licenses/lgpl.html
// at your preference.  Those licenses describe your legal rights to this
// software, and no other rights or warranties apply.
// Please send updates for this code to: fred@gruntose.com -- Thanks, fred.
 
#include <basis/astring.h>
#include <basis/definitions.h>
#include <timely/timer_driver.h>
 
namespace application {
 
 
class hoople_service
: public virtual basis::root_object, public timely::timeable
{
public:
  hoople_service();
 
  virtual ~hoople_service();
 
  DEFINE_CLASS_NAME("hoople_service");
 
  bool setup(const basis::astring &app_name, int timer_period = 0);
 
  static bool is_defunct() { return _defunct(); }
 
  static void make_defunct();
 
  bool saw_interrupt() { return _saw_interrupt(); }
 
  // these virtual methods can be overridden by applications derived from the
  // hoople_service.  they support a graceful shutdown process by which
  // applications can be alerted that they must shutdown, allowing them to take
  // care of releasing resources beforehand.
 
  virtual void handle_startup();
 
  virtual void handle_shutdown();
 
  virtual void handle_timer();
 
  // static methods that can be used by the program for starting up or for
  // graceful shutdown.
 
//why?
  static bool launch_console(hoople_service &alert, const basis::astring &app_name,
          int timer_period = 0);
 
#if 0  //not implemented.
#ifdef __WIN32__
  static bool launch_event_loop(hoople_service &alert,
          const basis::astring &app_name, int timer_period = 0);
 
#endif
#endif
 
  static void close_this_program();
 
  static bool close_application(const basis::astring &app_name);
 
  // internal methods not to be used by outside objects.
 
  static void handle_OS_signal(int sig_id);
 
private:
  static bool &_saw_interrupt();  
  static basis::astring &_app_name();  
  static bool &_defunct();  
  static int &_timer_period();  
 
  virtual void handle_timer_callback();  
 
  // not appropriate.
  hoople_service(const hoople_service &);
  hoople_service &operator =(const hoople_service &);
};
 
} //namespace.
 
#endif // outer guard.