ACE::Monitor_Control::Monitor_Point_Registry Class Reference

Storage for instantiated monitor points. More...

#include <Monitor_Point_Registry.h>

Collaboration diagram for ACE::Monitor_Control::Monitor_Point_Registry:

[legend]List of all members.

Public Member Functions
bool	add (Monitor_Base *type)
	Adds a monitor to the registry.
bool	remove (const char *name)
	Remove a monitor from the registry.
Monitor_Control_Types::NameList	names (void)
	Returns a list of names stored in the registry.
Monitor_Base *	get (const ACE_CString &name) const
long	constraint_id (void)
	Returns a unique id for a constraint when it is created.
void	cleanup (void)
Static Public Member Functions
static Monitor_Point_Registry *	instance (void)
Private Types
typedef ACE_Hash_Map_Manager< ACE_CString, Monitor_Base *, ACE_SYNCH_NULL_MUTEX >	Map
	Underlying container for the registry.
Private Member Functions
	Monitor_Point_Registry (void)
	Prevent that users can make an instance.
Private Attributes
ACE_SYNCH_MUTEX	mutex_
Map	map_
long	constraint_id_
Friends
class	ACE_Singleton< Monitor_Point_Registry, ACE_SYNCH_MUTEX >

---

Detailed Description

Storage for instantiated monitor points.

Definition at line 46 of file Monitor_Point_Registry.h.

---

Member Typedef Documentation

typedef ACE_Hash_Map_Manager<ACE_CString, Monitor_Base*, ACE_SYNCH_NULL_MUTEX> ACE::Monitor_Control::Monitor_Point_Registry::Map [private]

Underlying container for the registry.

Definition at line 82 of file Monitor_Point_Registry.h.

---

Constructor & Destructor Documentation

ACE::Monitor_Control::Monitor_Point_Registry::Monitor_Point_Registry

(

void

)

[private]

Prevent that users can make an instance.

Definition at line 22 of file Monitor_Point_Registry.cpp.

      : constraint_id_ (0)
    {
    }

---

Member Function Documentation

bool ACE::Monitor_Control::Monitor_Point_Registry::add

(

Monitor_Base *

type

)

Adds a monitor to the registry.

Definition at line 28 of file Monitor_Point_Registry.cpp.

References ACE_ERROR_RETURN, ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, ACE::Monitor_Control::Monitor_Base::add_ref(), ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::bind(), LM_ERROR, map_, and ACE::Monitor_Control::Monitor_Base::name().

Referenced by ACE::Monitor_Control::Monitor_Admin::monitor_point().

    {
      if (type == 0)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "registry add: null type\n"),
                            false);
        }

      int status = 0;

      {
        ACE_GUARD_RETURN (ACE_SYNCH_MUTEX, guard, this->mutex_, false);

        type->add_ref ();

        status = this->map_.bind (type->name (), type);
      }

      if (status == -1)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "registry add: map bind failed\n"),
                            false);
        }

      return (status == 0);
    }

void ACE::Monitor_Control::Monitor_Point_Registry::cleanup

(

void

)

Decrements the reference count on all remaining entries, called right before we go out of scope (i.e., process exits).

Definition at line 143 of file Monitor_Point_Registry.cpp.

References ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::end(), and map_.

Referenced by ACE::Monitor_Control::Monitor_Admin::~Monitor_Admin().

    {
      for (Map::ITERATOR i = this->map_.begin ();
           i != this->map_.end ();
           i.advance ())
        {
          Map::ENTRY* entry = 0;
          i.next (entry);
          entry->int_id_->remove_ref ();
        }
    }

long ACE::Monitor_Control::Monitor_Point_Registry::constraint_id

(

void

)

Returns a unique id for a constraint when it is created.

Definition at line 129 of file Monitor_Point_Registry.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, and constraint_id_.

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

    {
      long retval = 0;

      {
        ACE_GUARD_RETURN (ACE_SYNCH_MUTEX, guard, this->mutex_, -1);

        retval = this->constraint_id_++;
      }

      return retval;
    }

Monitor_Base * ACE::Monitor_Control::Monitor_Point_Registry::get

(

const ACE_CString &

name

)

const

Increments the refcount, so the caller is responsible for decrementing it when finished.

Definition at line 110 of file Monitor_Point_Registry.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::find(), and map_.

Referenced by ACE::Monitor_Control::Monitor_Admin::monitor_point().

    {
      Map::data_type mp = 0;

      {
        ACE_GUARD_RETURN (ACE_SYNCH_MUTEX, guard, this->mutex_, 0);

        this->map_.find (name, mp);
      }

      if (mp != 0)
        {
          mp->add_ref ();
        }

      return mp;
    }

Monitor_Point_Registry * ACE::Monitor_Control::Monitor_Point_Registry::instance

(

void

)

[static]

Used to help ensure that there is only a single instance per process of Monitor_Point_Registry.

Definition at line 16 of file Monitor_Point_Registry.cpp.

References ACE_Singleton< TYPE, ACE_LOCK >::instance().

Referenced by ACE::Monitor_Control::Monitor_Base::add_constraint(), ACE::Monitor_Control::Monitor_Admin::monitor_point(), ACE::Monitor_Control::Monitor_Base::remove_from_registry(), and ACE::Monitor_Control::Monitor_Admin::~Monitor_Admin().

    {
      return
        ACE_Singleton<Monitor_Point_Registry, ACE_SYNCH_MUTEX>::instance ();
    }

Monitor_Control_Types::NameList ACE::Monitor_Control::Monitor_Point_Registry::names

(

void

)

Returns a list of names stored in the registry.

Definition at line 93 of file Monitor_Point_Registry.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, ACE_Hash_Map_Const_Iterator_Base_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::done(), and ACE_Vector< T, DEFAULT_SIZE >::push_back().

    {
      Monitor_Control_Types::NameList name_holder_;

      {
        ACE_GUARD_RETURN (ACE_SYNCH_MUTEX, guard, this->mutex_, 0);

        for (Map::CONST_ITERATOR i (this->map_); !i.done (); i.advance ())
          {
            name_holder_.push_back (i->key ());
          }
      }

      return name_holder_;
    }

bool ACE::Monitor_Control::Monitor_Point_Registry::remove

(

const char *

name

)

Remove a monitor from the registry.

Definition at line 58 of file Monitor_Point_Registry.cpp.

References ACE_ERROR_RETURN, ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, LM_ERROR, map_, and ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::unbind().

    {
      if (name == 0)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "registry remove: null name\n"),
                            false);
        }

      int status = 0;
      Map::data_type mp = 0;

      {
        ACE_GUARD_RETURN (ACE_SYNCH_MUTEX, guard, this->mutex_, false);

        ACE_CString name_str (name, 0, false);
        status = this->map_.unbind (name_str, mp);
      }

      if (status == -1)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "registry remove: unbind failed for %s\n",
                             name),
                            false);
        }
      else
        {
          mp->remove_ref ();
        }

      return (status == 0);
    }

---

Friends And Related Function Documentation

friend class ACE_Singleton< Monitor_Point_Registry, ACE_SYNCH_MUTEX > [friend]

Definition at line 49 of file Monitor_Point_Registry.h.

---

Member Data Documentation

long ACE::Monitor_Control::Monitor_Point_Registry::constraint_id_ [private]

Since we're accessed as a singleton, we can keep track of dispensing unique ids for constraints.

Definition at line 89 of file Monitor_Point_Registry.h.

Referenced by constraint_id().

Map ACE::Monitor_Control::Monitor_Point_Registry::map_ [private]

Definition at line 85 of file Monitor_Point_Registry.h.

Referenced by add(), cleanup(), get(), and remove().

ACE_SYNCH_MUTEX ACE::Monitor_Control::Monitor_Point_Registry::mutex_ [mutable, private]

Definition at line 84 of file Monitor_Point_Registry.h.

---

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

• Monitor_Point_Registry.h
• Monitor_Point_Registry.cpp

---