service_root.h

Go to the documentation of this file.

#ifndef SERVICE_ROOT_CLASS
#define SERVICE_ROOT_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : service_root                                                      *
*  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; 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/convert_utf.h>
#include <basis/object_base.h>

// forward.
class internal_service_status;
class log_base;
class rendezvous;

#ifndef __WIN32__
  // definitions needed by derived services.
  enum surrogate_service_markers {
    // service statuses used in report_status.
    SERVICE_START_PENDING = 2000,
    SERVICE_RUNNING,
    SERVICE_STOPPED,
    SERVICE_STOP_PENDING,

    NO_ERROR = 0  // an extra definition of a commonly used win32 id.
  };

  #define __stdcall 
#endif


class service_root : public virtual object_base
{
public:
  service_root(const istring &service_name, const istring &display_name,
          const string_array &dependencies);

  virtual ~service_root();

  IMPLEMENT_CLASS_NAME("service_root");

  int initialize(int argc, char **argv, const istring &program_name);

  virtual void perform_service(int argc, char **argv) = 0;

  bool should_exit() const { return _leave_now; }

  void stop_service();

  // accessor functions for our info.
  const istring &service_name() const;
  const istring &display_name() const;
  const string_array &dependencies() const;

  bool normal_app() const { return _normal_app; }

  int error_code() const { return _error_code; }
  void error_code(int new_code) { _error_code = new_code; }

  int instruct(int argc, char **argv);

  u_int current_status();

//interpretations of these values exist where...?

  bool report_status(u_int current_state, u_int exit_code, u_int wait_hint);

  void log_event(const istring &message) const;

  static service_root &get_root();

  // this set of operations is invoked by our static methods; normal users
  // shouldn't need these.
  void install(bool set_auto, const istring &user, const istring &password);

  void remove();
  void standalone(int argc, char **argv);

private:
  bool _leave_now;  
  istring *_service_name;  
  istring *_display_name;  
  string_array *_dependencies;  
  int _error_code;  
  bool _normal_app;  
  int _checkpoint;  
  internal_service_status *_service_status;  
  void *_control_handle;  
  static service_root *_last_root;  
  rendezvous *_app_lock;  
  bool _got_lock;  

  static void stop_service_handler(int sig_num);

  static void __stdcall control_service(u_long control_code);

  static int __stdcall standalone_controller(u_long control_code);

  static void __stdcall setup(int argc, char **argv);

  flexichar *compute_dependency_string();

  bool already_running(const istring &program_name);
};

#endif

---