diff options
Diffstat (limited to 'TAO/tao/CORBALOC_Parser.h')
| -rw-r--r-- | TAO/tao/CORBALOC_Parser.h | 98 |
1 files changed, 51 insertions, 47 deletions
diff --git a/TAO/tao/CORBALOC_Parser.h b/TAO/tao/CORBALOC_Parser.h index 6bef830524c..dbe869b9deb 100644 --- a/TAO/tao/CORBALOC_Parser.h +++ b/TAO/tao/CORBALOC_Parser.h @@ -1,18 +1,15 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CORBALOC_Parser.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// Priyanka Gontla (pgontla@uci.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file CORBALOC_Parser.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + * @author Priyanka Gontla (pgontla@uci.edu) + */ +//============================================================================= + #ifndef TAO_CORBALOC_PARSER_H #define TAO_CORBALOC_PARSER_H @@ -33,99 +30,106 @@ #include "ace/Service_Config.h" +/** + * @class TAO_CORBALOC_Parser + * + * @brief Implements the <corbaloc:> IOR format + * + * This class implements the <corbaloc:> IOR format. + * It is dynamically loaded by the ORB and used to parse the + * string to separate the individual <obj_addr> from the list of object + * addresses <obj_addr_list>. + */ class TAO_Export TAO_CORBALOC_Parser : public TAO_IOR_Parser { - // = TITLE - // Implements the <corbaloc:> IOR format - // - // = DESCRIPTION - // This class implements the <corbaloc:> IOR format. - // It is dynamically loaded by the ORB and used to parse the - // string to separate the individual <obj_addr> from the list of object - // addresses <obj_addr_list>. - // public: + /// Constructor TAO_CORBALOC_Parser (void); - // Constructor + /// The destructor virtual ~TAO_CORBALOC_Parser (void); - // The destructor + /// = The IOR_Parser methods, please read the documentation in + /// IOR_Parser.h virtual int match_prefix (const char *ior_string) const; - // = The IOR_Parser methods, please read the documentation in - // IOR_Parser.h + /// Parse the ior-string that is passed. virtual CORBA::Object_ptr parse_string (const char *ior, CORBA::ORB_ptr orb, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Parse the ior-string that is passed. private: // @@ Priyanka: do you really need this (see next comment)? BTW, in // general we put private data members *after* private methods. + /// ORB CORBA::ORB_var orb_; - // ORB // @@ Priyanka: this makes the class non-reentrant, only one thread // can parse a string at a time. The "Right Thing"[tm] is to // pass the MProfile to whatever helper methods you have, so they // can add stuff to it. That way there is no resource // contention. + /// One big mprofile which consists the profiles of all the endpoints. TAO_MProfile mprofile_; - // One big mprofile which consists the profiles of all the endpoints. + /// Checks the prefix to see if it is RIR. virtual int check_prefix (const char *endpoint); - // Checks the prefix to see if it is RIR. + /// Helps count the length of the <obj_addr_list> and the number of + /// individual <obj_addr> in the <obj_addr_list>. virtual void parse_string_count_helper (const char * &corbaloc_name, CORBA::ULong &addr_list_length, CORBA::ULong &count_addr, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Helps count the length of the <obj_addr_list> and the number of - // individual <obj_addr> in the <obj_addr_list>. + /** + * Creates a MProfile for the endpoint passed and each such mprofile + * is added to the big mprofile <mprofile_> from which a pointer to + * the Object represented by the key_string is obtained and passed + * to the application. + */ virtual void parse_string_mprofile_helper (CORBA::String_var end_point, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Creates a MProfile for the endpoint passed and each such mprofile - // is added to the big mprofile <mprofile_> from which a pointer to - // the Object represented by the key_string is obtained and passed - // to the application. + /** + * Make a stub from the MProfile that is created in + * parse_string_mprofile_helper. Using this stub, create an object + * reference which is sent to the application. + */ virtual CORBA::Object_ptr make_stub_from_mprofile (CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Make a stub from the MProfile that is created in - // parse_string_mprofile_helper. Using this stub, create an object - // reference which is sent to the application. + /// Gets the pointer to the key_string when the protocol used is RIR virtual CORBA::Object_ptr parse_string_rir_helper (const char * &corbaloc_name, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Gets the pointer to the key_string when the protocol used is RIR + /// Tokenizes the <obj_addr_list> using "," as the seperator. Assigns + /// individual endpoints to the elements of the ACE_Array_Base. virtual void parse_string_assign_helper (CORBA::ULong &addr_list_length, ACE_CString &key_string, ACE_CString &cloc_name, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Tokenizes the <obj_addr_list> using "," as the seperator. Assigns - // individual endpoints to the elements of the ACE_Array_Base. + /** + * Helps parse_string_assign_helper by assigning in the case when + * the protocol name is present and we have to append jsut the key + * string. + */ virtual void assign_key_string(char * &cloc_name_ptr, ACE_CString &key_string, CORBA::ULong &addr_list_length, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Helps parse_string_assign_helper by assigning in the case when - // the protocol name is present and we have to append jsut the key - // string. }; |