ACE::Monitor_Control::Monitor_Admin Class Reference

#include <Monitor_Admin.h>

Collaboration diagram for ACE::Monitor_Control::Monitor_Admin:

[legend]List of all members.

Public Member Functions
	Monitor_Admin (void)
	~Monitor_Admin (void)
bool	monitor_point (Monitor_Base *monitor_point, const ACE_Time_Value &time)
Monitor_Base *	monitor_point (const char *name)
void	auto_query (ACE_Event_Handler *handler, MonitorQuery *query, const ACE_Time_Value &time)
void	reactor (ACE_Reactor *new_reactor)
ACE_Reactor *	reactor (void) const
Private Attributes
Monitor_Point_Auto_Updater	auto_updater_
ACE_Reactor *	reactor_
bool	default_reactor_

---

Detailed Description

Definition at line 67 of file Monitor_Admin.h.

---

Constructor & Destructor Documentation

ACE::Monitor_Control::Monitor_Admin::Monitor_Admin

(

void

)

Definition at line 30 of file Monitor_Admin.cpp.

      : reactor_ (ACE_Reactor::instance ()),
        default_reactor_ (true)
    {}

ACE::Monitor_Control::Monitor_Admin::~Monitor_Admin

(

void

)

Definition at line 35 of file Monitor_Admin.cpp.

References ACE::Monitor_Control::Monitor_Point_Registry::cleanup(), ACE_Reactor::close_singleton(), ACE::Monitor_Control::Monitor_Point_Registry::instance(), and ACE_Reactor::instance().

    {
      if (this->default_reactor_)
        {
          /// Destroys the timers associated with our event handler
          /// before its destructor is called.
          ACE_Reactor::instance ()->close_singleton ();
        }

      /// We access the registry through ACE_Singleton, which
      /// doesn't call the destructor, so we call this method to
      /// do a remove_ref() on all monitor points left in the registry.
      /// which needs to be done before the registry goes away.
      Monitor_Point_Registry::instance ()->cleanup ();
    }

---

Member Function Documentation

void ACE::Monitor_Control::Monitor_Admin::auto_query	(	ACE_Event_Handler *	handler,
		MonitorQuery *	query,
		const ACE_Time_Value &	time
	)

Works similarly to monitor_point() above, but registers the handler arg's handle_timeout() method with the reactor, instead of our auto_updater_'s handle_timeout().

Definition at line 85 of file Monitor_Admin.cpp.

References reactor_, ACE_Reactor::schedule_timer(), ACE_OS::time(), and ACE_Time_Value::zero.

    {
      this->reactor_->schedule_timer (handler,
                                      query,
                                      ACE_Time_Value::zero,
                                      time);
    }

Monitor_Base * ACE::Monitor_Control::Monitor_Admin::monitor_point

(

const char *

name

)

Definition at line 78 of file Monitor_Admin.cpp.

References ACE::Monitor_Control::Monitor_Point_Registry::get(), and ACE::Monitor_Control::Monitor_Point_Registry::instance().

    {
      ACE_CString name_str (name, 0, false);
      return Monitor_Point_Registry::instance ()->get (name_str);
    }

bool ACE::Monitor_Control::Monitor_Admin::monitor_point	(	Monitor_Base *	monitor_point,
		const ACE_Time_Value &	time
	)

Add or access monitor points in a global registry If the ACE_Time_Value arg is non-zero, the monitor point, the auto updater member, and the given time interval are passed to our reactor's register_timeout() method.

This call checks for a null monitor_point.

Definition at line 52 of file Monitor_Admin.cpp.

References ACE_ERROR_RETURN, ACE::Monitor_Control::Monitor_Point_Registry::add(), ACE::Monitor_Control::Monitor_Point_Registry::instance(), LM_ERROR, reactor_, ACE_Reactor::schedule_timer(), ACE_OS::time(), and ACE_Time_Value::zero.

Referenced by ACE::Monitor_Control::Monitor_Base::add_to_registry().

    {
      /// This call checks for a null monitor_point.
      bool good_reg_add =
        Monitor_Point_Registry::instance ()->add (monitor_point);

      if (!good_reg_add)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "registration of %s failed\n",
                             monitor_point->name ()),
                             good_reg_add);
        }
      else if (time != ACE_Time_Value::zero)
        {
          this->reactor_->schedule_timer (&this->auto_updater_,
                                          monitor_point,
                                          ACE_Time_Value::zero,
                                          time);
        }

      return good_reg_add;
    }

ACE_Reactor * ACE::Monitor_Control::Monitor_Admin::reactor

(

void

)

const

Definition at line 103 of file Monitor_Admin.cpp.

References reactor_.

    {
      return this->reactor_;
    }

void ACE::Monitor_Control::Monitor_Admin::reactor

(

ACE_Reactor *

new_reactor

)

This mutator allows the application to create its own reactor and substitute it for the default reactor.

Definition at line 96 of file Monitor_Admin.cpp.

References default_reactor_, and reactor_.

    {
      this->reactor_ = new_reactor;
      this->default_reactor_ = false;
    }

---

Member Data Documentation

Monitor_Point_Auto_Updater ACE::Monitor_Control::Monitor_Admin::auto_updater_ [private]

Definition at line 96 of file Monitor_Admin.h.

bool ACE::Monitor_Control::Monitor_Admin::default_reactor_ [private]

Definition at line 98 of file Monitor_Admin.h.

Referenced by reactor().

ACE_Reactor* ACE::Monitor_Control::Monitor_Admin::reactor_ [private]

Definition at line 97 of file Monitor_Admin.h.

Referenced by auto_query(), monitor_point(), and reactor().

---

The documentation for this class was generated from the following files:

• Monitor_Admin.h
• Monitor_Admin.cpp

---