diff options
Diffstat (limited to 'examples/Load_Balancing/Identity_Client.h')
| -rw-r--r-- | examples/Load_Balancing/Identity_Client.h | 91 |
1 files changed, 46 insertions, 45 deletions
diff --git a/examples/Load_Balancing/Identity_Client.h b/examples/Load_Balancing/Identity_Client.h index aa8123ad750..88c8d65e758 100644 --- a/examples/Load_Balancing/Identity_Client.h +++ b/examples/Load_Balancing/Identity_Client.h @@ -1,23 +1,20 @@ -// $Id$ // -*- C++ -*- -// ============================================================================ -// -// = LIBRARY -// TAO/examples/Load_Balancing -// -// = FILENAME -// Identity_Client.h -// -// = DESCRIPTION -// Code for Identity_Client, which is used in conjunction with -// Identity_Server to test/demonstrate the functionality of the -// Load Balancing service. -// -// = AUTHORS -// Marina Spivak <marina@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Identity_Client.h + * + * $Id$ + * + * Code for Identity_Client, which is used in conjunction with + * Identity_Server to test/demonstrate the functionality of the + * Load Balancing service. + * + * + * @author Marina Spivak <marina@cs.wustl.edu> + */ +//============================================================================= + #ifndef IDENTITY_CLIENT_H_ #define IDENTITY_CLIENT_H_ @@ -28,55 +25,59 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class Identity_Client + * + * Contacts the <Object_Group_Factory> in th Load Balancing Server + * to obtain a reference to the type of the <Object_Group> + * specified on the command line. Then, queries the + * <Object_Group> for its id and members, and prints that + * information. Finally, performs <number_of_invocations_> + * <Identity::get_name> calls, performing <Object_Group::resolve> + * before each <get_name> call in order to get the <Identity> + * reference to use for the call. (This provides an example of + * fine-grained, i.e., per call, Load Balancing among all the + * <Identity> objects registered with the <Object_Group> for the + * client's <get_name> calls. + */ class Identity_Client { - // =TITLE - // Contacts the <Object_Group_Factory> in th Load Balancing Server - // to obtain a reference to the type of the <Object_Group> - // specified on the command line. Then, queries the - // <Object_Group> for its id and members, and prints that - // information. Finally, performs <number_of_invocations_> - // <Identity::get_name> calls, performing <Object_Group::resolve> - // before each <get_name> call in order to get the <Identity> - // reference to use for the call. (This provides an example of - // fine-grained, i.e., per call, Load Balancing among all the - // <Identity> objects registered with the <Object_Group> for the - // client's <get_name> calls. - // public: + /// Default constructor. Identity_Client (void); - // Default constructor. + /// Destructor. ~Identity_Client (void); - // Destructor. + /// Initializes <orb_manager_>, and parses commandline arguments. int init (int argc, ACE_TCHAR *argv[]); - // Initializes <orb_manager_>, and parses commandline arguments. + /// See TITLE. int run (void); - // See TITLE. private: + /// Parses the commandline arguments. int parse_args (int argc, ACE_TCHAR *argv[]); - // Parses the commandline arguments. + /// The ORB manager. TAO_ORB_Manager orb_manager_; - // The ORB manager. + /// The ior of the <Object_Group_Factory> object we shall use to + /// to obtain an <Object_Group> object. const ACE_TCHAR *group_factory_ior_; - // The ior of the <Object_Group_Factory> object we shall use to - // to obtain an <Object_Group> object. + /// Number of times to invoke <get_name> method on <Identity> + /// objects. The default value is 5. size_t number_of_invocations_; - // Number of times to invoke <get_name> method on <Identity> - // objects. The default value is 5. + /** + * Flag indicating which <Object_Group> to use to obtain references + * to <Identity> objects. Random group should be used if the flag + * is set to 1, and round robin group otherwise. Round robin is the + * default. + */ size_t use_random_; - // Flag indicating which <Object_Group> to use to obtain references - // to <Identity> objects. Random group should be used if the flag - // is set to 1, and round robin group otherwise. Round robin is the - // default. }; #endif /* IDENTITY_CLIENT_H_ */ |