diff options
Diffstat (limited to 'ace/Name_Space.h')
| -rw-r--r-- | ace/Name_Space.h | 126 |
1 files changed, 68 insertions, 58 deletions
diff --git a/ace/Name_Space.h b/ace/Name_Space.h index 97e7a7b954c..58ebeb110f6 100644 --- a/ace/Name_Space.h +++ b/ace/Name_Space.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ACE -// -// = FILENAME -// Name_Space.h -// -// = AUTHOR -// Prashant Jain -// -// ============================================================================ + +//============================================================================= +/** + * @file Name_Space.h + * + * $Id$ + * + * @author Prashant Jain + */ +//============================================================================= + #ifndef ACE_NAME_SPACE_H #define ACE_NAME_SPACE_H @@ -30,40 +27,43 @@ typedef ACE_Unbounded_Set<ACE_WString> ACE_WSTRING_SET; +/** + * @class ACE_Name_Binding + * + * @brief Maintains a mapping from name to value and type. + */ class ACE_Export ACE_Name_Binding { - // = TITLE - // Maintains a mapping from name to value and type. public: // = Initialization and termination. + /// Main constructor that initializes all the fields. ACE_Name_Binding (const ACE_WString &n, const ACE_WString &v, const char *t); - // Main constructor that initializes all the fields. + /// Default constructor. ACE_Name_Binding (void); - // Default constructor. + /// Copy constructor. ACE_Name_Binding (const ACE_Name_Binding &); - // Copy constructor. + /// Assignment operator. void operator= (const ACE_Name_Binding &); - // Assignment operator. + /// Destructor. ~ACE_Name_Binding (void); - // Destructor. + /// Test for equality. int operator == (const ACE_Name_Binding &s) const; - // Test for equality. + /// Name of the binding. ACE_WString name_; - // Name of the binding. + /// Value of the binding. ACE_WString value_; - // Value of the binding. + /// Type of the binding. char *type_; - // Type of the binding. }; typedef ACE_Unbounded_Set<ACE_Name_Binding> ACE_BINDING_SET; @@ -72,79 +72,89 @@ typedef ACE_Unbounded_Set_Iterator<ACE_Name_Binding> ACE_BINDING_ITERATOR; typedef ACE_Unbounded_Set<ACE_WString> ACE_PWSTRING_SET; typedef ACE_Unbounded_Set_Iterator<ACE_WString> ACE_PWSTRING_ITERATOR; +/** + * @class ACE_Name_Space + * + * @brief Abstract base class that provides an abstract interface to + * the database without exposing any implemenation details. + * + * Manages a Naming Service Name Space. Provides the basic + * methods -- bind, unbind, rebind, find, and listnames. + */ class ACE_Export ACE_Name_Space { - // = TITLE - // Abstract base class that provides an abstract interface to - // the database without exposing any implemenation details. - // - // = DESCRIPTION - // Manages a Naming Service Name Space. Provides the basic - // methods -- bind, unbind, rebind, find, and listnames. public: + /// virtual destructor to ensure destructors of subclasses get + /// called. virtual ~ACE_Name_Space (void); - // virtual destructor to ensure destructors of subclasses get - // called. + /// Bind a new name to a naming context (Wide character strings). virtual int bind (const ACE_WString &name_in, const ACE_WString &value_in, const char *type_in = "") = 0; - // Bind a new name to a naming context (Wide character strings). + /** + * Overwrite the value or type of an existing name in a + * ACE_Name_Space or bind a new name to the context, if it didn't + * exist yet. (Wide charcter strings interface). + */ virtual int rebind (const ACE_WString &name_in, const ACE_WString &value_in, const char *type_in = "") = 0; - // Overwrite the value or type of an existing name in a - // ACE_Name_Space or bind a new name to the context, if it didn't - // exist yet. (Wide charcter strings interface). + /// Delete a name from a ACE_Name_Space (Wide charcter strings + /// Interface). virtual int unbind (const ACE_WString &name_in) = 0; - // Delete a name from a ACE_Name_Space (Wide charcter strings - // Interface). + /// Get value and type of a given name binding (Wide chars). The + /// caller is responsible for deleting both <value_out> and <type_out>! virtual int resolve (const ACE_WString &name_in, ACE_WString &value_out, char *&type_out) = 0; - // Get value and type of a given name binding (Wide chars). The - // caller is responsible for deleting both <value_out> and <type_out>! + /// Get a set of names matching a specified pattern (wchars). Matching + /// means the names must begin with the pattern string. virtual int list_names (ACE_WSTRING_SET &set_out, const ACE_WString &pattern_in) = 0; - // Get a set of names matching a specified pattern (wchars). Matching - // means the names must begin with the pattern string. + /// Get a set of values matching a specified pattern (wchars). Matching + /// means the values must begin with the pattern string. virtual int list_values (ACE_WSTRING_SET &set_out, const ACE_WString &pattern_in) = 0; - // Get a set of values matching a specified pattern (wchars). Matching - // means the values must begin with the pattern string. + /// Get a set of types matching a specified pattern (wchars). Matching + /// means the types must begin with the pattern string. virtual int list_types (ACE_WSTRING_SET &set_out, const ACE_WString &pattern_in) = 0; - // Get a set of types matching a specified pattern (wchars). Matching - // means the types must begin with the pattern string. + /** + * Get a set of names matching a specified pattern (wchars). Matching + * means the names must begin with the pattern string. Returns the + * complete binding associated each pattern match. + */ virtual int list_name_entries (ACE_BINDING_SET &set, const ACE_WString &pattern) = 0; - // Get a set of names matching a specified pattern (wchars). Matching - // means the names must begin with the pattern string. Returns the - // complete binding associated each pattern match. + /** + * Get a set of values matching a specified pattern (wchars). Matching + * means the values must begin with the pattern string. Returns the + * complete binding associated each pattern match. + */ virtual int list_value_entries (ACE_BINDING_SET &set, const ACE_WString &pattern) = 0; - // Get a set of values matching a specified pattern (wchars). Matching - // means the values must begin with the pattern string. Returns the - // complete binding associated each pattern match. + /** + * Get a set of types matching a specified pattern (wchars). Matching + * means the types must begin with the pattern string. Returns the + * complete binding associated each pattern match. + */ virtual int list_type_entries (ACE_BINDING_SET &set, const ACE_WString &pattern) = 0; - // Get a set of types matching a specified pattern (wchars). Matching - // means the types must begin with the pattern string. Returns the - // complete binding associated each pattern match. + /// Dump the state of the object virtual void dump (void) const = 0; - // Dump the state of the object }; #include "ace/post.h" |