summaryrefslogtreecommitdiff
path: root/TAO/examples
diff options
context:
space:
mode:
authorJohnny Willemsen <jwillemsen@remedy.nl>2011-03-28 08:44:53 +0000
committerJohnny Willemsen <jwillemsen@remedy.nl>2011-03-28 08:44:53 +0000
commit17c10ee9a7f204f6190250dc64bde3a039050575 (patch)
tree8c669040dc33a8daac94e5516e39e4c1115cc136 /TAO/examples
parent2ad17376fb503f128711aba7fe2f52d489bc4a71 (diff)
downloadATCD-17c10ee9a7f204f6190250dc64bde3a039050575.tar.gz
Mon Mar 28 07:27:37 UTC 2011 Johnny Willemsen <jwillemsen@remedy.nl>
Converted files below to use doxygen style documentation * TAO_IDL/be/be_visitor_array/array_ci.cpp: * TAO_IDL/be/be_visitor_exception/any_op_cs.cpp: * TAO_IDL/be/be_visitor_interface/any_op_cs.cpp: * TAO_IDL/be/be_visitor_interface/interface_ci.cpp: * TAO_IDL/be/be_visitor_root/root.cpp: * TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp: * TAO_IDL/be_include/be_helper.h: * TAO_IDL/be_include/be_visitor_argument/invoke_cs.h: * TAO_IDL/be_include/be_visitor_exception/ctor.h: * TAO_IDL/be_include/be_visitor_exception/ctor_assign.h: * TAO_IDL/be_include/be_visitor_exception/exception_ctor.h: * TAO_IDL/include/utl_idlist.h: * docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp: * docs/tutorials/Quoter/Simple/Persistent/server.cpp: * examples/AMI/FL_Callback/Peer_i.h: * examples/AMI/FL_Callback/Progress_i.h: * examples/Advanced/ch_12/client.cpp: * examples/Advanced/ch_12/icp.h: * examples/Advanced/ch_12/icp.cpp: * examples/Advanced/ch_12/server.h: * examples/Advanced/ch_12/server.cpp: * examples/Advanced/ch_18/client.cpp: * examples/Advanced/ch_18/icp.h: * examples/Advanced/ch_18/icp.cpp: * examples/Advanced/ch_18/server.h: * examples/Advanced/ch_18/server.cpp: * examples/Advanced/ch_21/client.cpp: * examples/Advanced/ch_21/icp.h: * examples/Advanced/ch_21/icp.cpp: * examples/Advanced/ch_21/server.h: * examples/Advanced/ch_21/server.cpp: * examples/Advanced/ch_3/client.cpp: * examples/Advanced/ch_3/server.h: * examples/Advanced/ch_3/server.cpp: * examples/Advanced/ch_8_and_10/client.cpp: * examples/Advanced/ch_8_and_10/icp.h: * examples/Advanced/ch_8_and_10/icp.cpp: * examples/Advanced/ch_8_and_10/server.h: * examples/Advanced/ch_8_and_10/server.cpp: * examples/Buffered_AMI/client.cpp: * examples/Buffered_AMI/test_i.h: * examples/Buffered_Oneways/client.cpp: * examples/Buffered_Oneways/test_i.h: * examples/Callback_Quoter/Consumer_Handler.h: * examples/Callback_Quoter/Consumer_Handler.cpp: * examples/Callback_Quoter/Consumer_Input_Handler.h: * examples/Callback_Quoter/Consumer_Input_Handler.cpp: * examples/Callback_Quoter/Consumer_Signal_Handler.h: * examples/Callback_Quoter/Consumer_Signal_Handler.cpp: * examples/Callback_Quoter/Consumer_i.h: * examples/Callback_Quoter/Consumer_i.cpp: * examples/Callback_Quoter/Notifier_Input_Handler.h: * examples/Callback_Quoter/Notifier_Input_Handler.cpp: * examples/Callback_Quoter/Notifier_i.h: * examples/Callback_Quoter/Notifier_i.cpp: * examples/Callback_Quoter/Supplier_Timer_Handler.h: * examples/Callback_Quoter/Supplier_Timer_Handler.cpp: * examples/Callback_Quoter/Supplier_i.h: * examples/Callback_Quoter/Supplier_i.cpp: * examples/Content_Server/AMI_Iterator/Content_Iterator_i.h: * examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h: * examples/Content_Server/AMI_Iterator/Iterator_Handler.h: * examples/Content_Server/AMI_Observer/Callback_Handler.h: * examples/Content_Server/AMI_Observer/Callback_i.h: * examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h: * examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h: * examples/Content_Server/SMI_Iterator/Content_Iterator_i.h: * examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h: * examples/Event_Comm/Consumer_Handler.h: * examples/Event_Comm/Consumer_Input_Handler.h: * examples/Event_Comm/Event_Comm_i.h: * examples/Event_Comm/Notifier_Handler.h: * examples/Event_Comm/Notifier_Server.h: * examples/Event_Comm/Supplier_Input_Handler.h: * examples/Event_Comm/notifier.h: * examples/Event_Comm/supplier.h: * examples/Kokyu_dsrt_schedulers/fp_example/test_i.h: * examples/Kokyu_dsrt_schedulers/mif_example/test_i.h: * examples/Kokyu_dsrt_schedulers/muf_example/test_i.h: * examples/Load_Balancing/Identity_Client.h: * examples/Load_Balancing/Identity_Client.cpp: * examples/Load_Balancing/Identity_Server.h: * examples/Load_Balancing/Identity_Server.cpp: * examples/Load_Balancing/Identity_i.h: * examples/Load_Balancing/Identity_i.cpp: * examples/Load_Balancing/Load_Balancer_i.h: * examples/Load_Balancing/Load_Balancer_i.cpp: * examples/Load_Balancing/Load_Balancing_Service.h: * examples/Load_Balancing/Load_Balancing_Service.cpp: * examples/Load_Balancing_persistent/Identity_Client.h: * examples/Load_Balancing_persistent/Identity_Client.cpp: * examples/Load_Balancing_persistent/Identity_Server.h: * examples/Load_Balancing_persistent/Identity_i.h: * examples/Load_Balancing_persistent/Identity_i.cpp: * examples/Load_Balancing_persistent/Load_Balancer_i.h: * examples/Load_Balancing_persistent/Load_Balancing_Service.h: * examples/Load_Balancing_persistent/Load_Balancing_Service.cpp: * examples/Logging/Logger_i.h: * examples/Logging/Logging_Service_i.h: * examples/Logging/Logging_Test_i.h: * examples/OBV/Simple_util.h: * examples/OBV/Typed_Events/Client_i.h: * examples/OBV/Typed_Events/Server_i.h: * examples/Persistent_Grid/Grid_Client_i.h: * examples/Persistent_Grid/Grid_i.h: * examples/Persistent_Grid/Persistent_Client.h: * examples/Persistent_Grid/Simple_util.h: * examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h: * examples/PluggableUDP/tests/Performance/UDP_i.h: * examples/PluggableUDP/tests/Performance/client.cpp: * examples/PluggableUDP/tests/Performance/server.cpp: * examples/PluggableUDP/tests/SimplePerformance/client.cpp: * examples/PluggableUDP/tests/SimplePerformance/server.cpp: * examples/PluggableUDP/tests/SimplePerformance/test_i.h: * examples/Quoter/Factory_Finder.h: * examples/Quoter/Factory_Finder.cpp: * examples/Quoter/Factory_Finder_i.h: * examples/Quoter/Factory_Finder_i.cpp: * examples/Quoter/Generic_Factory.h: * examples/Quoter/Generic_Factory.cpp: * examples/Quoter/Generic_Factory_i.h: * examples/Quoter/Generic_Factory_i.cpp: * examples/Quoter/Quoter_i.h: * examples/Quoter/Quoter_i.cpp: * examples/Quoter/client.h: * examples/Quoter/server.h: * examples/Quoter/server.cpp: * examples/Simple/Simple_util.h: * examples/Simple/bank/AccountManager_i.h: * examples/Simple/bank/Account_i.h: * examples/Simple/bank/Bank_Client_i.h: * examples/Simple/chat/Broadcaster_i.h: * examples/Simple/chat/Broadcaster_i.cpp: * examples/Simple/chat/Client_i.h: * examples/Simple/chat/Client_i.cpp: * examples/Simple/chat/Receiver_i.h: * examples/Simple/chat/Receiver_i.cpp: * examples/Simple/chat/Server.h: * examples/Simple/chat/Server_i.h: * examples/Simple/chat/Server_i.cpp: * examples/Simple/chat/client.cpp: * examples/Simple/chat/server.cpp: * examples/Simple/echo/Echo_Client_i.h: * examples/Simple/echo/Echo_i.h: * examples/Simple/grid/Grid_Client_i.h: * examples/Simple/grid/Grid_i.h: * examples/Simple/time-date/Time_Date_Client_i.h: * examples/Simple/time-date/Time_Date_i.h: * examples/Simple/time-date/server.cpp: * examples/Simple/time/Time_Client_i.h: * examples/Simple/time/Time_i.h: * examples/Simulator/Event_Supplier/DOVE_Supplier.h: * examples/Simulator/Event_Supplier/DOVE_Supplier.cpp: * examples/Simulator/Event_Supplier/DualEC_Sup.h: * examples/Simulator/Event_Supplier/DualEC_Sup.cpp: * examples/Simulator/Event_Supplier/Event_Con.h: * examples/Simulator/Event_Supplier/Event_Con.cpp: * examples/Simulator/Event_Supplier/Event_Sup.h: * examples/Simulator/Event_Supplier/Event_Sup.cpp: * examples/Simulator/Event_Supplier/Logging_Sup.h: * examples/Simulator/Event_Supplier/Logging_Sup.cpp: * examples/ior_corbaloc/client.cpp: * examples/ior_corbaloc/ior_corbaloc_client_i.h: * examples/ior_corbaloc/ior_corbaloc_client_i.cpp: * interop-tests/wchar/client.cpp: * interop-tests/wchar/server.cpp: * interop-tests/wchar/wchar_reference.h: * interop-tests/wchar/wchar_reference.cpp: * orbsvcs/IFR_Service/IFR_Service.h: * orbsvcs/IFR_Service/be_global.h: * orbsvcs/IFR_Service/be_global.cpp: * orbsvcs/IFR_Service/ifr_adding_visitor.h: * orbsvcs/IFR_Service/ifr_adding_visitor_exception.h: * orbsvcs/IFR_Service/ifr_adding_visitor_operation.h: * orbsvcs/IFR_Service/ifr_adding_visitor_structure.h: * orbsvcs/IFR_Service/ifr_adding_visitor_union.h: * orbsvcs/IFR_Service/ifr_removing_visitor.h: * orbsvcs/IFR_Service/ifr_visitor.h: * orbsvcs/LifeCycle_Service/Criteria_Evaluator.h: * orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp: * orbsvcs/LifeCycle_Service/Factory_Trader.h: * orbsvcs/LifeCycle_Service/Factory_Trader.cpp: * orbsvcs/LifeCycle_Service/LifeCycle_Service.h: * orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp: * orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h: * orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp: * orbsvcs/Naming_Service/NT_Naming_Server.cpp: * orbsvcs/Notify_Service/NT_Notify_Server.cpp: * orbsvcs/TAO_Service/TAO_Service.cpp: * orbsvcs/Time_Service/Clerk_i.h: * orbsvcs/Time_Service/Server_i.h: * orbsvcs/Trading_Service/Trading_Service.h: * orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h: * orbsvcs/examples/CosEC/Factory/FactoryDriver.h: * orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h: * orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h: * orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h: * orbsvcs/examples/CosEC/Simple/Consumer.h: * orbsvcs/examples/CosEC/Simple/Supplier.h: * orbsvcs/examples/Notify/Filter/Filter.h: * orbsvcs/examples/Notify/Subscribe/Subscribe.h: * orbsvcs/examples/RtEC/Kokyu/Consumer.h: * orbsvcs/examples/RtEC/Kokyu/Supplier.h: * orbsvcs/examples/RtEC/MCast/AddrServer.h: * orbsvcs/examples/RtEC/MCast/Consumer.h: * orbsvcs/examples/RtEC/MCast/Supplier.h: * orbsvcs/examples/RtEC/Schedule/Consumer.h: * orbsvcs/examples/RtEC/Schedule/Supplier.h: * orbsvcs/examples/RtEC/Simple/Consumer.h: * orbsvcs/examples/RtEC/Simple/Supplier.h: * orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h: * orbsvcs/examples/Security/Send_File/test_i.h: * orbsvcs/orbsvcs/Trader/Constraint_l.cpp: * orbsvcs/orbsvcs/Trader/Constraint_y.cpp: * orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h: * orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h: * orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h: * orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h: * orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h: * orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h: * orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h: * orbsvcs/tests/AVStreams/Component_Switching/distributer.h: * orbsvcs/tests/AVStreams/Component_Switching/receiver.h: * orbsvcs/tests/AVStreams/Component_Switching/sender.h: * orbsvcs/tests/AVStreams/Latency/ping.h: * orbsvcs/tests/AVStreams/Latency/pong.h: * orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h: * orbsvcs/tests/AVStreams/Multiple_Flows/sender.h: * orbsvcs/tests/AVStreams/Pluggable/ftp.h: * orbsvcs/tests/AVStreams/Pluggable/server.h: * orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h: * orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h: * orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h: * orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h: * orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h: * orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h: * orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h: * orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h: * orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h: * orbsvcs/tests/Bug_2248_Regression/Client_i.h: * orbsvcs/tests/Concurrency/CC_client.h: * orbsvcs/tests/Concurrency/CC_client.cpp: * orbsvcs/tests/Concurrency/CC_command.h: * orbsvcs/tests/Concurrency/CC_command.cpp: * orbsvcs/tests/Concurrency/CC_naming_service.h: * orbsvcs/tests/Concurrency/CC_naming_service.cpp: * orbsvcs/tests/Concurrency/CC_test_utils.h: * orbsvcs/tests/Concurrency/CC_test_utils.cpp: * orbsvcs/tests/Concurrency/CC_tests.h: * orbsvcs/tests/Concurrency/CC_tests.cpp: * orbsvcs/tests/Concurrency/lex.CC_command.cpp: * orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h: * orbsvcs/tests/CosEvent/Basic/Random.h: * orbsvcs/tests/CosEvent/lib/Counting_Consumer.h: * orbsvcs/tests/CosEvent/lib/Counting_Supplier.h: * orbsvcs/tests/Event/Performance/Connect.h: * orbsvcs/tests/Event/Performance/Inversion.h: * orbsvcs/tests/Event/Performance/Latency.h: * orbsvcs/tests/Event/Performance/Throughput.h: * orbsvcs/tests/Event/UDP/AddrServer.h: * orbsvcs/tests/Event/UDP/Consumer.h: * orbsvcs/tests/Event/UDP/Supplier.h: * orbsvcs/tests/FaultTolerance/IOGR/Client_i.h: * orbsvcs/tests/FaultTolerance/IOGR/Manager.h: * orbsvcs/tests/FaultTolerance/IOGR/test_i.h: * orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp: * orbsvcs/tests/HTIOP/AMI/ami_test_i.h: * orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp: * orbsvcs/tests/HTIOP/AMI/client.cpp: * orbsvcs/tests/HTIOP/AMI/server.cpp: * orbsvcs/tests/HTIOP/AMI/simple_client.cpp: * orbsvcs/tests/HTIOP/BiDirectional/test_i.h: * orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h: * orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h: * orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h: * orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h: * orbsvcs/tests/Interoperable_Naming/client.cpp: * orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h: * orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp: * orbsvcs/tests/Notify/Basic/AdminProperties.h: * orbsvcs/tests/Notify/Basic/ConnectDisconnect.h: * orbsvcs/tests/Notify/Basic/Events.h: * orbsvcs/tests/Notify/Basic/Filter.h: * orbsvcs/tests/Notify/Basic/IdAssignment.h: * orbsvcs/tests/Notify/Basic/LifeCycle.h: * orbsvcs/tests/Notify/Basic/MultiTypes.h: * orbsvcs/tests/Notify/Basic/Sequence.h: * orbsvcs/tests/Notify/Basic/Simple.h: * orbsvcs/tests/Notify/Basic/Updates.h: * orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h: * orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h: * orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h: * orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h: * orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h: * orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h: * orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h: * orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h: * orbsvcs/tests/Notify/Persistent_Filter/Filter.h: * orbsvcs/tests/Notify/Reconnecting/Consumer.h: * orbsvcs/tests/Notify/Reconnecting/Supplier.h: * orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h: * orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h: * orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h: * orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h: * orbsvcs/tests/Notify/lib/Notify_PushConsumer.h: * orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h: * orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h: * orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h: * orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h: * orbsvcs/tests/Notify/lib/Notify_Test_Client.h: * orbsvcs/tests/Notify/lib/common.h: * orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h: * orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h: * orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h: * orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h: * orbsvcs/tests/Property/client.h: * orbsvcs/tests/Property/client.cpp: * orbsvcs/tests/Property/server.h: * orbsvcs/tests/Property/server.cpp: * orbsvcs/tests/Security/BiDirectional/test_i.h: * orbsvcs/tests/Security/Crash_Test/test_i.h: * orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h: * orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h: * orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h: * orbsvcs/tests/Security/MT_SSLIOP/test_i.h: * orbsvcs/tests/Security/ssliop_corbaloc/client.h: * orbsvcs/tests/Security/ssliop_corbaloc/client.cpp: * orbsvcs/tests/Simple_Naming/client.h: * orbsvcs/tests/Simple_Naming/client.cpp: * orbsvcs/tests/Time/Client_i.h: * orbsvcs/tests/ior_corbaname/client.cpp: * orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h: * orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp: * orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp: * performance-tests/Anyop/anyop.cpp: * performance-tests/Cubit/TAO/DII_Cubit/client.cpp: * performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h: * performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h: * performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h: * performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp: * performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h: * performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h: * performance-tests/Cubit/TAO/MT_Cubit/Globals.h: * performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h: * performance-tests/Cubit/TAO/MT_Cubit/Timer.h: * performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h: * performance-tests/Cubit/TAO/MT_Cubit/client.h: * performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h: * performance-tests/Cubit/TAO/MT_Cubit/server.h: * performance-tests/Cubit/TAO/MT_Cubit/server.cpp: * performance-tests/POA/Demux/client.cpp: * performance-tests/POA/Demux/demux_stats.cpp: * performance-tests/POA/Demux/demux_test_client.h: * performance-tests/POA/Demux/demux_test_client.cpp: * performance-tests/POA/Demux/demux_test_macros.h: * performance-tests/POA/Demux/demux_test_server.h: * performance-tests/POA/Demux/demux_test_server.cpp: * performance-tests/POA/Demux/server.cpp: * performance-tests/POA/Object_Creation_And_Registration/registration.cpp: * performance-tests/Pluggable/PP_Test_Client.h: * performance-tests/Pluggable/PP_Test_Server.h: * performance-tests/Pluggable/PP_Test_i.h: * performance-tests/Pluggable/PP_Test_i.cpp: * performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h: * performance-tests/RTCorba/Oneways/Reliable/test_i.h: * tao/IORManipulation/IORManip_Filter.h: * tao/IORManipulation/IORManip_IIOP_Filter.h: * tests/AMI_Timeouts/timeout_client.h: * tests/AMI_Timeouts/timeout_i.h: * tests/AMI_Timeouts/timeout_i.cpp: * tests/Alt_Mapping/alt_mapping_i.h: * tests/Alt_Mapping/alt_mapping_i.cpp: * tests/Alt_Mapping/client.h: * tests/Alt_Mapping/client.cpp: * tests/Alt_Mapping/driver.h: * tests/Alt_Mapping/driver.cpp: * tests/Alt_Mapping/helper.h: * tests/Alt_Mapping/helper.cpp: * tests/Alt_Mapping/options.h: * tests/Alt_Mapping/options.cpp: * tests/Alt_Mapping/results.h: * tests/Alt_Mapping/results.cpp: * tests/Alt_Mapping/server.cpp: * tests/Alt_Mapping/tests.h: * tests/Alt_Mapping/ub_string.h: * tests/Alt_Mapping/ub_string.cpp: * tests/Alt_Mapping/ub_struct_seq.h: * tests/Alt_Mapping/ub_struct_seq.cpp: * tests/BiDirectional/test_i.h: * tests/BiDirectional_DelayedUpcall/test_i.h: * tests/BiDirectional_MultipleORB/destroy.cpp: * tests/BiDirectional_NestedUpcall/test_i.h: * tests/Bug_2174_Regression/test_i.h: * tests/Bug_2734_Regression/test_i.h: * tests/Bug_2935_Regression/middle_i.h: * tests/Bug_2935_Regression/sink_i.h: * tests/Bug_2935_Regression/source_i.h: * tests/Bug_3068_Regression/test_i.h: * tests/Bug_3683_Regression/Echo_Client_i.h: * tests/Bug_3683_Regression/Echo_i.h: * tests/Bug_3683_Regression/Simple_util.h: * tests/CDR/alignment.cpp: * tests/CDR/allocator.cpp: * tests/CDR/basic_types.cpp: * tests/CDR/growth.cpp: * tests/CDR/octet_sequence.cpp: * tests/CDR/tc.cpp: * tests/CSD_Collocation/Collocation_Tester.h: * tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h: * tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp: * tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp: * tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h: * tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp: * tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp: * tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp: * tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h: * tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp: * tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp: * tests/CodeSets/simple/client.cpp: * tests/CodeSets/simple/server.cpp: * tests/Collocation/Collocation_Tester.h: * tests/DIOP/UDP_Client_i.h: * tests/DIOP/UDP_i.h: * tests/DIOP/client.cpp: * tests/DIOP/server.cpp: * tests/DSI_AMI_Gateway/test_dsi.h: * tests/DSI_AMI_Gateway/test_i.h: * tests/DSI_Gateway/test_dsi.h: * tests/DSI_Gateway/test_i.h: * tests/Explicit_Event_Loop/client.cpp: * tests/Explicit_Event_Loop/server.h: * tests/Explicit_Event_Loop/server.cpp: * tests/Exposed_Policies/Counter_i.h: * tests/Exposed_Policies/Policy_Tester.h: * tests/Exposed_Policies/Policy_Verifier.h: * tests/Exposed_Policies/RT_Properties.h: * tests/FL_Cube/test_i.h: * tests/Faults/ping_i.h: * tests/Faults/test_i.h: * tests/File_IO/File_i.h: * tests/File_IO/File_i.cpp: * tests/File_IO/client.cpp: * tests/ForwardOnceUponException/test_i.h: * tests/ForwardUponObjectNotExist/test_i.h: * tests/Forwarding/test_i.h: * tests/IDL_Test/main.cpp: * tests/InterOp-Naming/INS_i.h: * tests/InterOp-Naming/Server_i.h: * tests/Leader_Followers/client.cpp: * tests/Leader_Followers/test_i.h: * tests/MProfile/test_i.h: * tests/MProfile_Connection_Timeout/test_i.h: * tests/MProfile_Forwarding/Servant_Locator.h: * tests/MProfile_Forwarding/Servant_Locator.cpp: * tests/MProfile_Forwarding/test_i.h: * tests/MT_Client/test_i.h: * tests/MT_Server/test_i.h: * tests/Multiple/Collocation_Tester.h: * tests/Multiple/Multiple_Impl.h: * tests/Multiple_Inheritance/client.cpp: * tests/Muxed_GIOP_Versions/test_i.h: * tests/Native_Exceptions/test_i.h: * tests/NestedUpcall/MT_Client_Test/MT_Object_i.h: * tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp: * tests/NestedUpcall/MT_Client_Test/client.h: * tests/NestedUpcall/MT_Client_Test/client.cpp: * tests/NestedUpcall/MT_Client_Test/local_server.h: * tests/NestedUpcall/MT_Client_Test/local_server.cpp: * tests/NestedUpcall/MT_Client_Test/server.h: * tests/NestedUpcall/MT_Client_Test/server.cpp: * tests/NestedUpcall/Triangle_Test/Initiator_i.h: * tests/NestedUpcall/Triangle_Test/Initiator_i.cpp: * tests/NestedUpcall/Triangle_Test/Object_A_i.h: * tests/NestedUpcall/Triangle_Test/Object_A_i.cpp: * tests/NestedUpcall/Triangle_Test/Object_B_i.h: * tests/NestedUpcall/Triangle_Test/Object_B_i.cpp: * tests/NestedUpcall/Triangle_Test/initiator.h: * tests/NestedUpcall/Triangle_Test/initiator.cpp: * tests/NestedUpcall/Triangle_Test/server_A.h: * tests/NestedUpcall/Triangle_Test/server_A.cpp: * tests/NestedUpcall/Triangle_Test/server_B.h: * tests/NestedUpcall/Triangle_Test/server_B.cpp: * tests/OBV/Any/AnyS_impl.h: * tests/OBV/Collocated/Forward/Test_impl.h: * tests/OBV/Factory/FactoryS_impl.h: * tests/OBV/Forward/Test_impl.h: * tests/OBV/Simple/Client_i.h: * tests/OBV/Simple/Server_i.h: * tests/OBV/Simple/Simple_util.h: * tests/OBV/TC_Alignment/test_i.h: * tests/OBV/Truncatable/TruncatableS_impl.h: * tests/OBV/ValueBox/Test_impl.h: * tests/ORB_destroy/ORB_destroy.cpp: * tests/Object_Loader/Loader.h: * tests/Object_Loader/Test_i.h: * tests/OctetSeq/OctetSeq.cpp: * tests/OctetSeq/test_i.h: * tests/POA/Adapter_Activator/server.cpp: * tests/POA/Bug_2511_Regression/server.cpp: * tests/POA/Current/Current.cpp: * tests/POA/DSI/client.cpp: * tests/POA/DSI/server.cpp: * tests/POA/Default_Servant/Default_Servant.cpp: * tests/POA/Default_Servant2/File_i.h: * tests/POA/Default_Servant2/File_i.cpp: * tests/POA/Default_Servant2/client.cpp: * tests/POA/Default_Servant2/server.cpp: * tests/POA/Etherealization/Etherealization.cpp: * tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp: * tests/POA/Explicit_Activation/server.cpp: * tests/POA/FindPOA/FindPOA.cpp: * tests/POA/Forwarding/Servant_Activator.h: * tests/POA/Forwarding/client.cpp: * tests/POA/Forwarding/server.cpp: * tests/POA/Forwarding/test_i.h: * tests/POA/Generic_Servant/test_i.h: * tests/POA/Identity/Identity.cpp: * tests/POA/Loader/Servant_Activator.h: * tests/POA/Loader/Servant_Activator.cpp: * tests/POA/Loader/Servant_Locator.h: * tests/POA/Loader/Servant_Locator.cpp: * tests/POA/Loader/Server_Manager.h: * tests/POA/Loader/server.cpp: * tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp: * tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp: * tests/POA/NewPOA/NewPOA.cpp: * tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp: * tests/POA/Object_Reactivation/Object_Reactivation.cpp: * tests/POA/On_Demand_Activation/Servant_Activator.h: * tests/POA/On_Demand_Activation/Servant_Activator.cpp: * tests/POA/On_Demand_Activation/Servant_Locator.h: * tests/POA/On_Demand_Activation/Servant_Locator.cpp: * tests/POA/On_Demand_Activation/server.cpp: * tests/POA/On_Demand_Loading/Servant_Activator.h: * tests/POA/On_Demand_Loading/Servant_Activator.cpp: * tests/POA/On_Demand_Loading/Servant_Locator.h: * tests/POA/On_Demand_Loading/Servant_Locator.cpp: * tests/POA/On_Demand_Loading/Servant_Manager.h: * tests/POA/On_Demand_Loading/Servant_Manager.cpp: * tests/POA/On_Demand_Loading/Server_Manager.h: * tests/POA/On_Demand_Loading/server.cpp: * tests/POA/POAManagerFactory/POAManagerFactory.cpp: * tests/POA/POA_BiDir/POA_BiDir.cpp: * tests/POA/POA_Destruction/POA_Destruction.cpp: * tests/POA/Persistent_ID/client.cpp: * tests/POA/Persistent_ID/server.cpp: * tests/POA/Policies/Policies.cpp: * tests/POA/Reference_Counted_Servant/server.cpp: * tests/POA/RootPOA/RootPOA.cpp: * tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp: * tests/POA/TIE/client.cpp: * tests/POA/TIE/server.cpp: * tests/POA/TIE/test_i.h: * tests/POA/TIE/test_i.cpp: * tests/POA/wait_for_completion/wait_for_completion.cpp: * tests/Param_Test/any.h: * tests/Param_Test/any.cpp: * tests/Param_Test/anyop.cpp: * tests/Param_Test/bd_array_seq.h: * tests/Param_Test/bd_array_seq.cpp: * tests/Param_Test/bd_long_seq.h: * tests/Param_Test/bd_long_seq.cpp: * tests/Param_Test/bd_short_seq.h: * tests/Param_Test/bd_short_seq.cpp: * tests/Param_Test/bd_str_seq.h: * tests/Param_Test/bd_str_seq.cpp: * tests/Param_Test/bd_string.h: * tests/Param_Test/bd_string.cpp: * tests/Param_Test/bd_struct_seq.h: * tests/Param_Test/bd_struct_seq.cpp: * tests/Param_Test/bd_wstr_seq.h: * tests/Param_Test/bd_wstr_seq.cpp: * tests/Param_Test/bd_wstring.h: * tests/Param_Test/bd_wstring.cpp: * tests/Param_Test/big_union.h: * tests/Param_Test/big_union.cpp: * tests/Param_Test/client.h: * tests/Param_Test/client.cpp: * tests/Param_Test/complex_any.h: * tests/Param_Test/complex_any.cpp: * tests/Param_Test/driver.h: * tests/Param_Test/driver.cpp: * tests/Param_Test/except.h: * tests/Param_Test/except.cpp: * tests/Param_Test/fixed_array.h: * tests/Param_Test/fixed_array.cpp: * tests/Param_Test/fixed_struct.h: * tests/Param_Test/fixed_struct.cpp: * tests/Param_Test/helper.h: * tests/Param_Test/helper.cpp: * tests/Param_Test/multdim_array.h: * tests/Param_Test/multdim_array.cpp: * tests/Param_Test/nested_struct.h: * tests/Param_Test/nested_struct.cpp: * tests/Param_Test/objref.h: * tests/Param_Test/objref.cpp: * tests/Param_Test/objref_struct.h: * tests/Param_Test/objref_struct.cpp: * tests/Param_Test/options.h: * tests/Param_Test/options.cpp: * tests/Param_Test/param_test_i.h: * tests/Param_Test/param_test_i.cpp: * tests/Param_Test/recursive_struct.h: * tests/Param_Test/recursive_struct.cpp: * tests/Param_Test/recursive_union.h: * tests/Param_Test/recursive_union.cpp: * tests/Param_Test/results.h: * tests/Param_Test/results.cpp: * tests/Param_Test/server.cpp: * tests/Param_Test/short.h: * tests/Param_Test/short.cpp: * tests/Param_Test/small_union.h: * tests/Param_Test/small_union.cpp: * tests/Param_Test/tests.h: * tests/Param_Test/typecode.h: * tests/Param_Test/typecode.cpp: * tests/Param_Test/ub_any_seq.h: * tests/Param_Test/ub_any_seq.cpp: * tests/Param_Test/ub_array_seq.h: * tests/Param_Test/ub_array_seq.cpp: * tests/Param_Test/ub_long_seq.h: * tests/Param_Test/ub_long_seq.cpp: * tests/Param_Test/ub_objref_seq.h: * tests/Param_Test/ub_objref_seq.cpp: * tests/Param_Test/ub_short_seq.h: * tests/Param_Test/ub_short_seq.cpp: * tests/Param_Test/ub_str_seq.h: * tests/Param_Test/ub_str_seq.cpp: * tests/Param_Test/ub_string.h: * tests/Param_Test/ub_string.cpp: * tests/Param_Test/ub_struct_seq.h: * tests/Param_Test/ub_struct_seq.cpp: * tests/Param_Test/ub_wstr_seq.h: * tests/Param_Test/ub_wstr_seq.cpp: * tests/Param_Test/ub_wstring.h: * tests/Param_Test/ub_wstring.cpp: * tests/Param_Test/ulonglong.h: * tests/Param_Test/ulonglong.cpp: * tests/Param_Test/var_array.h: * tests/Param_Test/var_array.cpp: * tests/Param_Test/var_struct.h: * tests/Param_Test/var_struct.cpp: * tests/Portable_Interceptors/Benchmark/test_i.h: * tests/Portable_Interceptors/Collocated/Dynamic/test_i.h: * tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h: * tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h: * tests/QtTests/client.h: * tests/QtTests/test_i.h: * tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h: * tests/RTCORBA/Policies/Policies.cpp: * tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp: * tests/Single_Read/test_i.h: * tests/Smart_Proxies/Benchmark/client.cpp: * tests/Smart_Proxies/Benchmark/server.cpp: * tests/Smart_Proxies/On_Demand/client.cpp: * tests/Smart_Proxies/On_Demand/server.cpp: * tests/Smart_Proxies/Policy/client.cpp: * tests/Smart_Proxies/Policy/server.cpp: * tests/Smart_Proxies/client.cpp: * tests/Smart_Proxies/server.cpp: * tests/Strategies/simple_test_i.h: * tests/Timed_Buffered_Oneways/client.cpp: * tests/Timed_Buffered_Oneways/test_i.h: * tests/Timeout/test_i.h: * tests/Xt_Stopwatch/Client.h: * tests/Xt_Stopwatch/Control.h: * tests/Xt_Stopwatch/Stopwatch_display.h: * tests/Xt_Stopwatch/test_i.h: * tests/Xt_Stopwatch/timer.h: * utils/catior/Catior_i.h: * utils/catior/Catior_i.cpp: * utils/nslist/nsadd.cpp: * utils/nslist/nsdel.cpp:
Diffstat (limited to 'TAO/examples')
-rw-r--r--TAO/examples/AMI/FL_Callback/Peer_i.h66
-rw-r--r--TAO/examples/AMI/FL_Callback/Progress_i.h62
-rw-r--r--TAO/examples/Advanced/ch_12/client.cpp34
-rw-r--r--TAO/examples/Advanced/ch_12/icp.cpp32
-rw-r--r--TAO/examples/Advanced/ch_12/icp.h32
-rw-r--r--TAO/examples/Advanced/ch_12/server.cpp34
-rw-r--r--TAO/examples/Advanced/ch_12/server.h34
-rw-r--r--TAO/examples/Advanced/ch_18/client.cpp31
-rw-r--r--TAO/examples/Advanced/ch_18/icp.cpp31
-rw-r--r--TAO/examples/Advanced/ch_18/icp.h31
-rw-r--r--TAO/examples/Advanced/ch_18/server.cpp34
-rw-r--r--TAO/examples/Advanced/ch_18/server.h31
-rw-r--r--TAO/examples/Advanced/ch_21/client.cpp33
-rw-r--r--TAO/examples/Advanced/ch_21/icp.cpp31
-rw-r--r--TAO/examples/Advanced/ch_21/icp.h31
-rw-r--r--TAO/examples/Advanced/ch_21/server.cpp33
-rw-r--r--TAO/examples/Advanced/ch_21/server.h31
-rw-r--r--TAO/examples/Advanced/ch_3/client.cpp32
-rw-r--r--TAO/examples/Advanced/ch_3/server.cpp32
-rw-r--r--TAO/examples/Advanced/ch_3/server.h31
-rw-r--r--TAO/examples/Advanced/ch_8_and_10/client.cpp31
-rw-r--r--TAO/examples/Advanced/ch_8_and_10/icp.cpp31
-rw-r--r--TAO/examples/Advanced/ch_8_and_10/icp.h31
-rw-r--r--TAO/examples/Advanced/ch_8_and_10/server.cpp33
-rw-r--r--TAO/examples/Advanced/ch_8_and_10/server.h31
-rw-r--r--TAO/examples/Buffered_AMI/client.cpp28
-rw-r--r--TAO/examples/Buffered_AMI/test_i.h37
-rw-r--r--TAO/examples/Buffered_Oneways/client.cpp28
-rw-r--r--TAO/examples/Buffered_Oneways/test_i.h37
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Handler.cpp32
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Handler.h110
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Input_Handler.cpp30
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Input_Handler.h62
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Signal_Handler.cpp30
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_Signal_Handler.h67
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_i.cpp33
-rw-r--r--TAO/examples/Callback_Quoter/Consumer_i.h61
-rw-r--r--TAO/examples/Callback_Quoter/Notifier_Input_Handler.cpp32
-rw-r--r--TAO/examples/Callback_Quoter/Notifier_Input_Handler.h79
-rw-r--r--TAO/examples/Callback_Quoter/Notifier_i.cpp33
-rw-r--r--TAO/examples/Callback_Quoter/Notifier_i.h85
-rw-r--r--TAO/examples/Callback_Quoter/Supplier_Timer_Handler.cpp26
-rw-r--r--TAO/examples/Callback_Quoter/Supplier_Timer_Handler.h66
-rw-r--r--TAO/examples/Callback_Quoter/Supplier_i.cpp30
-rw-r--r--TAO/examples/Callback_Quoter/Supplier_i.h95
-rw-r--r--TAO/examples/Content_Server/AMI_Iterator/Content_Iterator_i.h55
-rw-r--r--TAO/examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h63
-rw-r--r--TAO/examples/Content_Server/AMI_Iterator/Iterator_Handler.h91
-rw-r--r--TAO/examples/Content_Server/AMI_Observer/Callback_Handler.h81
-rw-r--r--TAO/examples/Content_Server/AMI_Observer/Callback_i.h85
-rw-r--r--TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h45
-rw-r--r--TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h63
-rw-r--r--TAO/examples/Content_Server/SMI_Iterator/Content_Iterator_i.h55
-rw-r--r--TAO/examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h65
-rw-r--r--TAO/examples/Event_Comm/Consumer_Handler.h84
-rw-r--r--TAO/examples/Event_Comm/Consumer_Input_Handler.h63
-rw-r--r--TAO/examples/Event_Comm/Event_Comm_i.h85
-rw-r--r--TAO/examples/Event_Comm/Notifier_Handler.h61
-rw-r--r--TAO/examples/Event_Comm/Notifier_Server.h58
-rw-r--r--TAO/examples/Event_Comm/Supplier_Input_Handler.h60
-rw-r--r--TAO/examples/Event_Comm/notifier.h49
-rw-r--r--TAO/examples/Event_Comm/supplier.h61
-rw-r--r--TAO/examples/Kokyu_dsrt_schedulers/fp_example/test_i.h42
-rw-r--r--TAO/examples/Kokyu_dsrt_schedulers/mif_example/test_i.h42
-rw-r--r--TAO/examples/Kokyu_dsrt_schedulers/muf_example/test_i.h42
-rw-r--r--TAO/examples/Load_Balancing/Identity_Client.cpp23
-rw-r--r--TAO/examples/Load_Balancing/Identity_Client.h91
-rw-r--r--TAO/examples/Load_Balancing/Identity_Server.cpp23
-rw-r--r--TAO/examples/Load_Balancing/Identity_Server.h83
-rw-r--r--TAO/examples/Load_Balancing/Identity_i.cpp26
-rw-r--r--TAO/examples/Load_Balancing/Identity_i.h34
-rw-r--r--TAO/examples/Load_Balancing/Load_Balancer_i.cpp20
-rw-r--r--TAO/examples/Load_Balancing/Load_Balancer_i.h266
-rw-r--r--TAO/examples/Load_Balancing/Load_Balancing_Service.cpp23
-rw-r--r--TAO/examples/Load_Balancing/Load_Balancing_Service.h56
-rw-r--r--TAO/examples/Load_Balancing_persistent/Identity_Client.cpp23
-rw-r--r--TAO/examples/Load_Balancing_persistent/Identity_Client.h91
-rw-r--r--TAO/examples/Load_Balancing_persistent/Identity_Server.h83
-rw-r--r--TAO/examples/Load_Balancing_persistent/Identity_i.cpp26
-rw-r--r--TAO/examples/Load_Balancing_persistent/Identity_i.h38
-rw-r--r--TAO/examples/Load_Balancing_persistent/Load_Balancer_i.h252
-rw-r--r--TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.cpp23
-rw-r--r--TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.h56
-rw-r--r--TAO/examples/Logging/Logger_i.h100
-rw-r--r--TAO/examples/Logging/Logging_Service_i.h89
-rw-r--r--TAO/examples/Logging/Logging_Test_i.h90
-rw-r--r--TAO/examples/OBV/Simple_util.h136
-rw-r--r--TAO/examples/OBV/Typed_Events/Client_i.h60
-rw-r--r--TAO/examples/OBV/Typed_Events/Server_i.h43
-rw-r--r--TAO/examples/Persistent_Grid/Grid_Client_i.h67
-rw-r--r--TAO/examples/Persistent_Grid/Grid_i.h98
-rw-r--r--TAO/examples/Persistent_Grid/Persistent_Client.h61
-rw-r--r--TAO/examples/Persistent_Grid/Simple_util.h127
-rw-r--r--TAO/examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h33
-rw-r--r--TAO/examples/PluggableUDP/tests/Performance/UDP_i.h56
-rw-r--r--TAO/examples/PluggableUDP/tests/Performance/client.cpp31
-rw-r--r--TAO/examples/PluggableUDP/tests/Performance/server.cpp31
-rw-r--r--TAO/examples/PluggableUDP/tests/SimplePerformance/client.cpp52
-rw-r--r--TAO/examples/PluggableUDP/tests/SimplePerformance/server.cpp31
-rw-r--r--TAO/examples/PluggableUDP/tests/SimplePerformance/test_i.h40
-rw-r--r--TAO/examples/Quoter/Factory_Finder.cpp30
-rw-r--r--TAO/examples/Quoter/Factory_Finder.h57
-rw-r--r--TAO/examples/Quoter/Factory_Finder_i.cpp30
-rw-r--r--TAO/examples/Quoter/Factory_Finder_i.h47
-rw-r--r--TAO/examples/Quoter/Generic_Factory.cpp28
-rw-r--r--TAO/examples/Quoter/Generic_Factory.h59
-rw-r--r--TAO/examples/Quoter/Generic_Factory_i.cpp29
-rw-r--r--TAO/examples/Quoter/Generic_Factory_i.h53
-rw-r--r--TAO/examples/Quoter/Quoter_i.cpp25
-rw-r--r--TAO/examples/Quoter/Quoter_i.h87
-rw-r--r--TAO/examples/Quoter/client.h89
-rw-r--r--TAO/examples/Quoter/server.cpp27
-rw-r--r--TAO/examples/Quoter/server.h77
-rw-r--r--TAO/examples/Simple/Simple_util.h139
-rw-r--r--TAO/examples/Simple/bank/AccountManager_i.h81
-rw-r--r--TAO/examples/Simple/bank/Account_i.h71
-rw-r--r--TAO/examples/Simple/bank/Bank_Client_i.h66
-rw-r--r--TAO/examples/Simple/chat/Broadcaster_i.cpp33
-rw-r--r--TAO/examples/Simple/chat/Broadcaster_i.h74
-rw-r--r--TAO/examples/Simple/chat/Client_i.cpp32
-rw-r--r--TAO/examples/Simple/chat/Client_i.h76
-rw-r--r--TAO/examples/Simple/chat/Receiver_i.cpp31
-rw-r--r--TAO/examples/Simple/chat/Receiver_i.h61
-rw-r--r--TAO/examples/Simple/chat/Server.h30
-rw-r--r--TAO/examples/Simple/chat/Server_i.cpp32
-rw-r--r--TAO/examples/Simple/chat/Server_i.h59
-rw-r--r--TAO/examples/Simple/chat/client.cpp29
-rw-r--r--TAO/examples/Simple/chat/server.cpp30
-rw-r--r--TAO/examples/Simple/echo/Echo_Client_i.h54
-rw-r--r--TAO/examples/Simple/echo/Echo_i.h65
-rw-r--r--TAO/examples/Simple/grid/Grid_Client_i.h63
-rw-r--r--TAO/examples/Simple/grid/Grid_i.h94
-rw-r--r--TAO/examples/Simple/time-date/Time_Date_Client_i.h55
-rw-r--r--TAO/examples/Simple/time-date/Time_Date_i.h42
-rw-r--r--TAO/examples/Simple/time-date/server.cpp33
-rw-r--r--TAO/examples/Simple/time/Time_Client_i.h53
-rw-r--r--TAO/examples/Simple/time/Time_i.h61
-rw-r--r--TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.cpp30
-rw-r--r--TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.h56
-rw-r--r--TAO/examples/Simulator/Event_Supplier/DualEC_Sup.cpp37
-rw-r--r--TAO/examples/Simulator/Event_Supplier/DualEC_Sup.h88
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Event_Con.cpp42
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Event_Con.h62
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Event_Sup.cpp32
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Event_Sup.h56
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Logging_Sup.cpp37
-rw-r--r--TAO/examples/Simulator/Event_Supplier/Logging_Sup.h61
-rw-r--r--TAO/examples/ior_corbaloc/client.cpp31
-rw-r--r--TAO/examples/ior_corbaloc/ior_corbaloc_client_i.cpp35
-rw-r--r--TAO/examples/ior_corbaloc/ior_corbaloc_client_i.h50
150 files changed, 3958 insertions, 4157 deletions
diff --git a/TAO/examples/AMI/FL_Callback/Peer_i.h b/TAO/examples/AMI/FL_Callback/Peer_i.h
index f778761bb69..df8af1b50db 100644
--- a/TAO/examples/AMI/FL_Callback/Peer_i.h
+++ b/TAO/examples/AMI/FL_Callback/Peer_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/AMI/FL_Callback
-//
-// = FILENAME
-// Peer_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Peer_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef PEER_I_H
#define PEER_I_H
@@ -24,8 +21,8 @@ class Peer_i;
class Peer_Handler_i : public POA_AMI_PeerHandler
{
public:
+ /// The peer
Peer_Handler_i (Peer_i *peer);
- // The peer
virtual void request (CORBA::Long retval);
@@ -36,26 +33,26 @@ public:
virtual void shutdown (void);
private:
+ /// The real implementation
Peer_i *peer_;
- // The real implementation
};
class Peer_i : public POA_Peer
{
public:
+ /// Constructor
Peer_i (void);
- // Constructor
+ /// Destructor
virtual ~Peer_i (void);
- // Destructor
void init (CORBA::ORB_ptr orb,
Progress_ptr progress,
const ACE_Time_Value &delay);
+ /// Used by the Reply_Handler to indicate that a reply has been
+ /// received.
void reply (CORBA::Long result);
- // Used by the Reply_Handler to indicate that a reply has been
- // received.
// = See test.idl for an explanation of these methods.
CORBA::Long request (CORBA::Long id);
@@ -66,26 +63,29 @@ public:
void shutdown (void);
private:
+ /// The reply_handler
Peer_Handler_i reply_handler_;
- // The reply_handler
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
+ /// The interface to report back progress.
Progress_var progress_;
- // The interface to report back progress.
+ /// The delay on each request
ACE_Time_Value delay_;
- // The delay on each request
+ /// The id assigned by the progress interface
CORBA::Long id_;
- // The id assigned by the progress interface
};
+/**
+ * @class Peer_Task
+ *
+ * Run a "start" request on a separate thread.
+ */
class Peer_Task : public ACE_Task_Base
{
- // = DESCRIPTION
- // Run a "start" request on a separate thread.
public:
Peer_Task (const PeerSet& the_peers,
CORBA::Long iterations,
@@ -93,24 +93,24 @@ public:
AMI_PeerHandler_ptr handler,
CORBA::Long id);
+ /// The thread entry point
virtual int svc (void);
- // The thread entry point
private:
+ /// The peers
PeerSet the_peers_;
- // The peers
+ /// The number of iterations
CORBA::Long iterations_;
- // The number of iterations
+ /// To report progress
Progress_var progress_;
- // To report progress
+ /// To issue async requests
AMI_PeerHandler_var handler_;
- // To issue async requests
+ /// Our id
CORBA::Long id_;
- // Our id
};
#endif /* PEER_I_H */
diff --git a/TAO/examples/AMI/FL_Callback/Progress_i.h b/TAO/examples/AMI/FL_Callback/Progress_i.h
index 1b17a0b95d5..7fbe8ef8db4 100644
--- a/TAO/examples/AMI/FL_Callback/Progress_i.h
+++ b/TAO/examples/AMI/FL_Callback/Progress_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/AMI/FL_Callback
-//
-// = FILENAME
-// Progress_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Progress_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef PROGRESS_I_H
#define PROGRESS_I_H
@@ -23,54 +20,55 @@
class Progress_Window : public Fl_Box
{
public:
+ /// Constructor
Progress_Window (int n_peers,
int n_iterations,
int x, int y,
int w, int h,
const char* l = 0);
- // Constructor
+ /// Keep track of the progress on each peer
void sent_request (CORBA::Long id);
void recv_reply (CORBA::Long id);
- // Keep track of the progress on each peer
+ /// One of the peers has bound to the server
CORBA::Long bind (Peer_ptr a_peer);
- // One of the peers has bound to the server
+ /// Start the peers...
void start (void);
- // Start the peers...
private:
+ /// The callback method
static void start_callback (Fl_Widget* widget, void *data);
- // The callback method
private:
+ /// The total number of peers
int n_peers_;
- // The total number of peers
+ /// The peers
PeerSet peers_;
- // The peers
+ /// The number of iterations;
int n_iterations_;
- // The number of iterations;
+ /// The set of sliders where we keep track of each client
Fl_Widget** request_progress_;
Fl_Widget** reply_progress_;
- // The set of sliders where we keep track of each client
};
+/**
+ * @class Progress_i
+ *
+ * @brief Progress server implementation
+ *
+ * Implements the Progress interface in test.idl, forward the
+ * calls to the Progress_Window class
+ */
class Progress_i : public POA_Progress
{
- // = TITLE
- // Progress server implementation
- //
- // = DESCRIPTION
- // Implements the Progress interface in test.idl, forward the
- // calls to the Progress_Window class
- //
public:
+ /// ctor
Progress_i (Progress_Window* window);
- // ctor
// = The Progress methods.
void sent_request (CORBA::Long id);
@@ -78,8 +76,8 @@ public:
CORBA::Long bind (Peer_ptr a_peer);
private:
+ /// Display the graphics...
Progress_Window* window_;
- // Display the graphics...
};
#endif /* PROGRESS_I_H */
diff --git a/TAO/examples/Advanced/ch_12/client.cpp b/TAO/examples/Advanced/ch_12/client.cpp
index d6e85f69ef8..97801bea1a1 100644
--- a/TAO/examples/Advanced/ch_12/client.cpp
+++ b/TAO/examples/Advanced/ch_12/client.cpp
@@ -1,23 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// client.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CCSC.h" // ORB-specific
#include <ace/streams.h>
diff --git a/TAO/examples/Advanced/ch_12/icp.cpp b/TAO/examples/Advanced/ch_12/icp.cpp
index 8b8d4ceaa07..e06a0739beb 100644
--- a/TAO/examples/Advanced/ch_12/icp.cpp
+++ b/TAO/examples/Advanced/ch_12/icp.cpp
@@ -1,23 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// icp.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include <string>
#include <map>
diff --git a/TAO/examples/Advanced/ch_12/icp.h b/TAO/examples/Advanced/ch_12/icp.h
index 30bc0bc75dd..628b09b4969 100644
--- a/TAO/examples/Advanced/ch_12/icp.h
+++ b/TAO/examples/Advanced/ch_12/icp.h
@@ -1,23 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// icp.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _ICP_H
#define _ICP_H
diff --git a/TAO/examples/Advanced/ch_12/server.cpp b/TAO/examples/Advanced/ch_12/server.cpp
index e81977633ce..2fa85c30ee1 100644
--- a/TAO/examples/Advanced/ch_12/server.cpp
+++ b/TAO/examples/Advanced/ch_12/server.cpp
@@ -1,23 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include <ace/streams.h>
#include <strstream>
diff --git a/TAO/examples/Advanced/ch_12/server.h b/TAO/examples/Advanced/ch_12/server.h
index 5a5a3729fd2..45850f8705a 100644
--- a/TAO/examples/Advanced/ch_12/server.h
+++ b/TAO/examples/Advanced/ch_12/server.h
@@ -1,23 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// server.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef server_HH_
#define server_HH_
diff --git a/TAO/examples/Advanced/ch_18/client.cpp b/TAO/examples/Advanced/ch_18/client.cpp
index 2b85967e1bc..42c8d8a5cc5 100644
--- a/TAO/examples/Advanced/ch_18/client.cpp
+++ b/TAO/examples/Advanced/ch_18/client.cpp
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_18
-//
-// = FILENAME
-// client.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CCSC.h" // ORB-specific
#include "assert.h"
diff --git a/TAO/examples/Advanced/ch_18/icp.cpp b/TAO/examples/Advanced/ch_18/icp.cpp
index e8eb768bb3b..0d8f2d10a2b 100644
--- a/TAO/examples/Advanced/ch_18/icp.cpp
+++ b/TAO/examples/Advanced/ch_18/icp.cpp
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_18
-//
-// = FILENAME
-// icp.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Advanced/ch_18/icp.h b/TAO/examples/Advanced/ch_18/icp.h
index 121198509ba..49389e8ce7e 100644
--- a/TAO/examples/Advanced/ch_18/icp.h
+++ b/TAO/examples/Advanced/ch_18/icp.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_18
-//
-// = FILENAME
-// icp.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _ICP_H
#define _ICP_H
diff --git a/TAO/examples/Advanced/ch_18/server.cpp b/TAO/examples/Advanced/ch_18/server.cpp
index d61fa852c25..cdedd259072 100644
--- a/TAO/examples/Advanced/ch_18/server.cpp
+++ b/TAO/examples/Advanced/ch_18/server.cpp
@@ -1,23 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_18
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include <ace/streams.h>
#include <strstream>
diff --git a/TAO/examples/Advanced/ch_18/server.h b/TAO/examples/Advanced/ch_18/server.h
index fc6f1680259..a43c11d44c7 100644
--- a/TAO/examples/Advanced/ch_18/server.h
+++ b/TAO/examples/Advanced/ch_18/server.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_18
-//
-// = FILENAME
-// server.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Advanced/ch_21/client.cpp b/TAO/examples/Advanced/ch_21/client.cpp
index 0a45d6ed64e..cc9db916187 100644
--- a/TAO/examples/Advanced/ch_21/client.cpp
+++ b/TAO/examples/Advanced/ch_21/client.cpp
@@ -1,22 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_12
-//
-// = FILENAME
-// client.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CCSC.h" // ORB-specific
#include <ace/streams.h>
diff --git a/TAO/examples/Advanced/ch_21/icp.cpp b/TAO/examples/Advanced/ch_21/icp.cpp
index 4c3bb1c076a..0fa1f6deadb 100644
--- a/TAO/examples/Advanced/ch_21/icp.cpp
+++ b/TAO/examples/Advanced/ch_21/icp.cpp
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_21
-//
-// = FILENAME
-// icp.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Advanced/ch_21/icp.h b/TAO/examples/Advanced/ch_21/icp.h
index b7198e4ba15..171b55e89a1 100644
--- a/TAO/examples/Advanced/ch_21/icp.h
+++ b/TAO/examples/Advanced/ch_21/icp.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_21
-//
-// = FILENAME
-// icp.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _ICP_H
#define _ICP_H
diff --git a/TAO/examples/Advanced/ch_21/server.cpp b/TAO/examples/Advanced/ch_21/server.cpp
index 4aaf8fd29b6..417cd098b83 100644
--- a/TAO/examples/Advanced/ch_21/server.cpp
+++ b/TAO/examples/Advanced/ch_21/server.cpp
@@ -1,22 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_21
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include <ace/streams.h>
#include <strstream>
diff --git a/TAO/examples/Advanced/ch_21/server.h b/TAO/examples/Advanced/ch_21/server.h
index e60eb6c20e1..ced2bfb7641 100644
--- a/TAO/examples/Advanced/ch_21/server.h
+++ b/TAO/examples/Advanced/ch_21/server.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_21
-//
-// = FILENAME
-// server.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Advanced/ch_3/client.cpp b/TAO/examples/Advanced/ch_3/client.cpp
index 6a2646bb8f9..37f11b0cc30 100644
--- a/TAO/examples/Advanced/ch_3/client.cpp
+++ b/TAO/examples/Advanced/ch_3/client.cpp
@@ -1,23 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_3
-//
-// = FILENAME
-// client.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "timeC.h"
#include <ace/streams.h>
diff --git a/TAO/examples/Advanced/ch_3/server.cpp b/TAO/examples/Advanced/ch_3/server.cpp
index 48cdc56defc..bace6362305 100644
--- a/TAO/examples/Advanced/ch_3/server.cpp
+++ b/TAO/examples/Advanced/ch_3/server.cpp
@@ -1,23 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_3
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the
-// code provided in the book, "Advanced CORBA Programming with C++"
-// by Michi Henning and Steve Vinoski. Copyright
-// 1999. Addison-Wesley, Reading, MA. Used with permission of
-// Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from thecode provided in the book
+ * @author "Advanced CORBA Programming with C++"by Michi Henning and Steve Vinoski. Copyright1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission ofAddison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "server.h"
#include <ace/streams.h>
diff --git a/TAO/examples/Advanced/ch_3/server.h b/TAO/examples/Advanced/ch_3/server.h
index 0df75e405cc..207cc33c69d 100644
--- a/TAO/examples/Advanced/ch_3/server.h
+++ b/TAO/examples/Advanced/ch_3/server.h
@@ -1,22 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_3
-//
-// = FILENAME
-// server.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA. Used with permission of Addison-Wesley.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA. Used with permission of Addison-Wesley.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef server_HH_
#define server_HH_
diff --git a/TAO/examples/Advanced/ch_8_and_10/client.cpp b/TAO/examples/Advanced/ch_8_and_10/client.cpp
index 8d8203cf140..6f236100f90 100644
--- a/TAO/examples/Advanced/ch_8_and_10/client.cpp
+++ b/TAO/examples/Advanced/ch_8_and_10/client.cpp
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_8_and_10
-//
-// = FILENAME
-// client.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CCSC.h" // ORB-specific
#include <iostream>
diff --git a/TAO/examples/Advanced/ch_8_and_10/icp.cpp b/TAO/examples/Advanced/ch_8_and_10/icp.cpp
index 2ccfc38a70e..5d867e1125c 100644
--- a/TAO/examples/Advanced/ch_8_and_10/icp.cpp
+++ b/TAO/examples/Advanced/ch_8_and_10/icp.cpp
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_8_and_10
-//
-// = FILENAME
-// icp.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Advanced/ch_8_and_10/icp.h b/TAO/examples/Advanced/ch_8_and_10/icp.h
index 08a067de46b..49389e8ce7e 100644
--- a/TAO/examples/Advanced/ch_8_and_10/icp.h
+++ b/TAO/examples/Advanced/ch_8_and_10/icp.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_8_and_10
-//
-// = FILENAME
-// icp.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file icp.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _ICP_H
#define _ICP_H
diff --git a/TAO/examples/Advanced/ch_8_and_10/server.cpp b/TAO/examples/Advanced/ch_8_and_10/server.cpp
index 1db6a9afcbc..9e7e83ff769 100644
--- a/TAO/examples/Advanced/ch_8_and_10/server.cpp
+++ b/TAO/examples/Advanced/ch_8_and_10/server.cpp
@@ -1,22 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_8_and_10
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "server.h"
#include <algorithm>
diff --git a/TAO/examples/Advanced/ch_8_and_10/server.h b/TAO/examples/Advanced/ch_8_and_10/server.h
index aa353e97b44..43267c5e8eb 100644
--- a/TAO/examples/Advanced/ch_8_and_10/server.h
+++ b/TAO/examples/Advanced/ch_8_and_10/server.h
@@ -1,21 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Advanced/ch_8_and_10
-//
-// = FILENAME
-// server.h
-//
-// = AUTHORS
-// Source code used in TAO has been modified and adapted from the code
-// provided in the book, "Advanced CORBA Programming with C++" by Michi
-// Henning and Steve Vinoski. Copyright 1999. Addison-Wesley, Reading,
-// MA.
-//
-// Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Source code used in TAO has been modified and adapted from the codeprovided in the book
+ * @author "Advanced CORBA Programming with C++" by MichiHenning and Steve Vinoski. Copyright 1999. Addison-Wesley
+ * @author Reading
+ * @author MA.Modified for TAO by Mike Moran <mm4@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Buffered_AMI/client.cpp b/TAO/examples/Buffered_AMI/client.cpp
index 516a5f78a9a..a020c3d3edc 100644
--- a/TAO/examples/Buffered_AMI/client.cpp
+++ b/TAO/examples/Buffered_AMI/client.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a client that uses buffered AMI calls.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a client that uses buffered AMI calls.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "tao/Messaging/Messaging.h"
diff --git a/TAO/examples/Buffered_AMI/test_i.h b/TAO/examples/Buffered_AMI/test_i.h
index d136bfb0567..db145c802d8 100644
--- a/TAO/examples/Buffered_AMI/test_i.h
+++ b/TAO/examples/Buffered_AMI/test_i.h
@@ -1,31 +1,30 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Buffered_AMI/
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#ifndef TAO_BUFFERED_AMI_TEST_I_H
#define TAO_BUFFERED_AMI_TEST_I_H
#include "testS.h"
+/**
+ * @class test_i
+ *
+ * @brief Simple implementation.
+ */
class test_i : public POA_test
{
- // = TITLE
- // Simple implementation.
- //
public:
+ /// ctor.
test_i (CORBA::ORB_ptr orb);
- // ctor.
// = The test interface methods.
void method (CORBA::ULong request_number,
@@ -34,8 +33,8 @@ public:
void shutdown (void);
private:
+ /// The ORB.
CORBA::ORB_var orb_;
- // The ORB.
};
#endif /* TAO_BUFFERED_AMI_TEST_I_H */
diff --git a/TAO/examples/Buffered_Oneways/client.cpp b/TAO/examples/Buffered_Oneways/client.cpp
index ad2a94c0da7..5b02d2c2ca2 100644
--- a/TAO/examples/Buffered_Oneways/client.cpp
+++ b/TAO/examples/Buffered_Oneways/client.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a client that uses buffered oneways.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a client that uses buffered oneways.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testC.h"
#include "tao/Messaging/Messaging.h"
diff --git a/TAO/examples/Buffered_Oneways/test_i.h b/TAO/examples/Buffered_Oneways/test_i.h
index bed392b0324..0c0818c991b 100644
--- a/TAO/examples/Buffered_Oneways/test_i.h
+++ b/TAO/examples/Buffered_Oneways/test_i.h
@@ -1,31 +1,30 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Buffered_Oneways/
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#ifndef TAO_BUFFERED_ONEWAYS_TEST_I_H
#define TAO_BUFFERED_ONEWAYS_TEST_I_H
#include "testS.h"
+/**
+ * @class test_i
+ *
+ * @brief Simple implementation.
+ */
class test_i : public POA_test
{
- // = TITLE
- // Simple implementation.
- //
public:
+ /// ctor.
test_i (CORBA::ORB_ptr orb);
- // ctor.
// = The test interface methods.
void method (CORBA::ULong request_number);
@@ -33,8 +32,8 @@ public:
void shutdown (void);
private:
+ /// The ORB.
CORBA::ORB_var orb_;
- // The ORB.
};
#endif /* TAO_BUFFERED_ONEWAYS_TEST_I_H */
diff --git a/TAO/examples/Callback_Quoter/Consumer_Handler.cpp b/TAO/examples/Callback_Quoter/Consumer_Handler.cpp
index 433431d1587..0d159e07af4 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Handler.cpp
+++ b/TAO/examples/Callback_Quoter/Consumer_Handler.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.cpp
-//
-// = DESCRIPTION
-// Implementation of the Consumer_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Consumer_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Consumer_Handler.h"
diff --git a/TAO/examples/Callback_Quoter/Consumer_Handler.h b/TAO/examples/Callback_Quoter/Consumer_Handler.h
index bea9924b250..16bef8e8210 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Handler.h
+++ b/TAO/examples/Callback_Quoter/Consumer_Handler.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Handler.h
-//
-// = DESCRIPTION
-// Definition of the Callback_Qouter Consumer Client class, Consumer_Handler.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Handler.h
+ *
+ * $Id$
+ *
+ * Definition of the Callback_Qouter Consumer Client class, Consumer_Handler.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONSUMER_HANDLER_H
#define CONSUMER_HANDLER_H
@@ -39,100 +35,102 @@
class Consumer_Input_Handler;
class Consumer_Signal_Handler;
+/**
+ * @class Consumer_Handler
+ *
+ * @brief Callback Quoter Consumer Client class.
+ *
+ * Connects to the Callback Quoter server and
+ * registers the Consumer object with the it
+ * and receives the stock status from the Notifier.
+ */
class Consumer_Handler
{
- // = TITLE
- // Callback Quoter Consumer Client class.
- //
- // = DESCRIPTION
- // Connects to the Callback Quoter server and
- // registers the Consumer object with the it
- // and receives the stock status from the Notifier.
public:
// = Initialization and termination methods.
+ /// Constructor.
Consumer_Handler (void);
- // Constructor.
+ /// Destructor.
~Consumer_Handler (void);
- // Destructor.
+ /// Initialize the client communication with the server.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication with the server.
+ /// Start the ORB object.
int run (void);
- // Start the ORB object.
+ /// the name of the stock the consumer is interested in.
ACE_CString stock_name_;
- // the name of the stock the consumer is interested in.
+ /// the desired price of the stock.
int threshold_value_;
- // the desired price of the stock.
+ /// Server object ptr.
Notifier_var server_;
- // Server object ptr.
+ /// The consumer object.
Consumer_i *consumer_servant_;
- // The consumer object.
+ /// Pointer to the consumer object registered with the ORB.
Callback_Quoter::Consumer_var consumer_var_;
- // Pointer to the consumer object registered with the ORB.
+ /// This method gives the reactor pointer.
ACE_Reactor* reactor_used (void) const;
- // This method gives the reactor pointer.
+ /// Flag which notes whether the consumer has got registered with the
+ /// Notifier-server.
int registered_;
- // Flag which notes whether the consumer has got registered with the
- // Notifier-server.
+ /// Flag which notes whether the consumer has got unregistered from
+ /// the Notifier-server.
int unregistered_;
- // Flag which notes whether the consumer has got unregistered from
- // the Notifier-server.
private:
+ /// Our orb.
CORBA::ORB_var orb_;
- // Our orb.
+ /// Function to read the server IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the server IOR from a file.
+ /// Parse the command line arguments. Returns 0 on success, -1 on
+ /// error.
int parse_args (void);
- // Parse the command line arguments. Returns 0 on success, -1 on
- // error.
+ /// This method initialises the naming service and registers the
+ /// object with the POA.
int via_naming_service (void);
- // This method initialises the naming service and registers the
- // object with the POA.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// IOR of the obj ref of the server.
ACE_TCHAR *ior_;
- // IOR of the obj ref of the server.
+ /// Flag for server shutdown.
int shutdown_;
- // Flag for server shutdown.
+ /// An instance of the name client used for resolving the factory
+ /// objects.
TAO_Naming_Client naming_services_client_;
- // An instance of the name client used for resolving the factory
- // objects.
+ /// This variable denotes whether the naming service
+ /// is used or not.
int use_naming_service_;
- // This variable denotes whether the naming service
- // is used or not.
+ /// Reference to the input_event_handler.
Consumer_Input_Handler *consumer_input_handler_;
- // Reference to the input_event_handler.
+ /// Reference to the signal_event_handler.
Consumer_Signal_Handler *consumer_signal_handler_;
- // Reference to the signal_event_handler.
+ /// Is the example interactive?
int interactive_;
- // Is the example interactive?
};
#endif /* CONSUMER_HANDLER_H */
diff --git a/TAO/examples/Callback_Quoter/Consumer_Input_Handler.cpp b/TAO/examples/Callback_Quoter/Consumer_Input_Handler.cpp
index 2b8df7edfbc..c5164c84b2b 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Input_Handler.cpp
+++ b/TAO/examples/Callback_Quoter/Consumer_Input_Handler.cpp
@@ -1,20 +1,16 @@
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.cpp
-//
-// = DESCRIPTION
-// Implementation of the Consumer_Input_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Consumer_Input_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Consumer_Input_Handler.h"
#include "ace/Read_Buffer.h"
diff --git a/TAO/examples/Callback_Quoter/Consumer_Input_Handler.h b/TAO/examples/Callback_Quoter/Consumer_Input_Handler.h
index 463a2c80271..0bb703909b7 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Input_Handler.h
+++ b/TAO/examples/Callback_Quoter/Consumer_Input_Handler.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.h
-//
-// = DESCRIPTION
-// Definition of the Callback_Qouter Consumer Client class, Consumer_Input_Handler.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.h
+ *
+ * $Id$
+ *
+ * Definition of the Callback_Qouter Consumer Client class, Consumer_Input_Handler.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONSUMER_INPUT_HANDLER_H
#define CONSUMER_INPUT_HANDLER_H
@@ -35,31 +31,33 @@
class Consumer_Handler;
+/**
+ * @class Consumer_Input_Handler
+ *
+ * @brief Callback Quoter Consumer Client class.
+ *
+ * Connects to the Callback Quoter server and
+ * registers the Consumer object with the it
+ * and receives the stock status from the Notifier.
+ */
class Consumer_Input_Handler : public ACE_Event_Handler
{
- // = TITLE
- // Callback Quoter Consumer Client class.
- //
- // = DESCRIPTION
- // Connects to the Callback Quoter server and
- // registers the Consumer object with the it
- // and receives the stock status from the Notifier.
public:
+ /// Constructor.
Consumer_Input_Handler (Consumer_Handler *consumer_handler);
- // Constructor.
+ /// Handle the user input.
int handle_input (ACE_HANDLE);
- // Handle the user input.
+ /// Registration with the notifier.
int register_consumer (void);
- // Registration with the notifier.
+ /// Cancelling the registration with the notifier.
int unregister_consumer (void);
- // Cancelling the registration with the notifier.
+ /// Ends the consumer process.
int quit_consumer_process (void);
- // Ends the consumer process.
enum
{
@@ -85,12 +83,12 @@ public:
};
protected:
+ /// the destructor.
~Consumer_Input_Handler (void);
- // the destructor.
private:
+ /// The Consumer_Handler object.
Consumer_Handler *consumer_handler_;
- // The Consumer_Handler object.
};
#endif /* CONSUMER_INPUT_HANDLER_H */
diff --git a/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.cpp b/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.cpp
index 82e2d6e3570..183462adda2 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.cpp
+++ b/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.cpp
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.cpp
-//
-// = DESCRIPTION
-// Implementation of the Consumer_Signal_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Consumer_Signal_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Consumer_Signal_Handler.h"
diff --git a/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.h b/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.h
index 8a288c117e2..e0df651f7f3 100644
--- a/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.h
+++ b/TAO/examples/Callback_Quoter/Consumer_Signal_Handler.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.h
-//
-// = DESCRIPTION
-// Definition of the Consumer_Signal_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.h
+ *
+ * $Id$
+ *
+ * Definition of the Consumer_Signal_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONSUMER_SIGNAL_HANDLER_H
#define CONSUMER_SIGNAL_HANDLER_H
@@ -26,43 +23,47 @@
class Consumer_Handler;
+/**
+ * @class Consumer_Signal_Handler
+ *
+ * @brief Creating a class to handle signal events.
+ *
+ * Since only signals need to be handled, only the <handle_signal> method
+ * is overlaoded.
+ */
class Consumer_Signal_Handler : public ACE_Event_Handler
{
- // = TITLE
- // Creating a class to handle signal events.
- //
- // = DESCRIPTION
- // Since only signals need to be handled, only the <handle_signal> method
- // is overlaoded.
public:
+ /// The consumer_handler refernce will be used to access the servant
+ /// methods.
Consumer_Signal_Handler (Consumer_Handler *consumer_handler);
- // The consumer_handler refernce will be used to access the servant
- // methods.
+ /// This method takes action on an signal event.
int handle_signal (int signum,
siginfo_t*,
ucontext_t*);
- // This method takes action on an signal event.
+ /**
+ * For removal of the signal handler from the dispatch tables. When
+ * the handle_signal () returns < 0 this method will be executed
+ * automatically.
+ */
int handle_close (ACE_HANDLE handle,
ACE_Reactor_Mask close_mask);
- // For removal of the signal handler from the dispatch tables. When
- // the handle_signal () returns < 0 this method will be executed
- // automatically.
protected:
+ /// Protected destructor so that the signal handler is always created
+ /// dynamically and hence the heap doesnt get corrupted.
~Consumer_Signal_Handler (void);
- // Protected destructor so that the signal handler is always created
- // dynamically and hence the heap doesnt get corrupted.
private:
+ /// Exit gracefully on a signal.
int quit_on_signal (void);
- // Exit gracefully on a signal.
+ /// Reference to the Consumer_Handler which is used in accessing the
+ /// servant methods.
Consumer_Handler *consumer_handler_;
- // Reference to the Consumer_Handler which is used in accessing the
- // servant methods.
};
#endif /* CONSUMER_SIGNAL_HANDLER_H */
diff --git a/TAO/examples/Callback_Quoter/Consumer_i.cpp b/TAO/examples/Callback_Quoter/Consumer_i.cpp
index 266f9796c60..64ad94f6fe8 100644
--- a/TAO/examples/Callback_Quoter/Consumer_i.cpp
+++ b/TAO/examples/Callback_Quoter/Consumer_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_i.cpp
-//
-// = DESCRIPTION
-// Implements the Consumer_i class, which is used by the
-// callback quoter client.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_i.cpp
+ *
+ * $Id$
+ *
+ * Implements the Consumer_i class, which is used by the
+ * callback quoter client.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Consumer_i.h"
diff --git a/TAO/examples/Callback_Quoter/Consumer_i.h b/TAO/examples/Callback_Quoter/Consumer_i.h
index 0645b3962c9..14cfadfddd0 100644
--- a/TAO/examples/Callback_Quoter/Consumer_i.h
+++ b/TAO/examples/Callback_Quoter/Consumer_i.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_i.h
-//
-// = DESCRIPTION
-// Defines the implementation header for the Consumer interface.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_i.h
+ *
+ * $Id$
+ *
+ * Defines the implementation header for the Consumer interface.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONSUMER_I_H
#define CONSUMER_I_H
@@ -23,41 +20,43 @@
#include "ConsumerC.h"
#include "NotifierS.h"
+/**
+ * @class Consumer_i
+ *
+ * @brief Consumer object implementation.
+ *
+ * This class has methods that are called by the callback quoter
+ * server.
+ */
class Consumer_i : public POA_Callback_Quoter::Consumer
{
- // = TITLE
- // Consumer object implementation.
- //
- // = DESCRIPTION
- // This class has methods that are called by the callback quoter
- // server.
public:
// = Initialization and termination methods.
+ /// Constructor.
Consumer_i (void);
- // Constructor.
+ /// Destructor.
~Consumer_i (void);
- // Destructor.
+ /// Gets the stock information from the Notifier.
void push (const Callback_Quoter::Info & data);
- // Gets the stock information from the Notifier.
+ /// Used to get the consumer to shut down.
virtual void shutdown (void);
- // Used to get the consumer to shut down.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// If 1 denotes that the consumer is dead else alive.
int quit_;
- // If 1 denotes that the consumer is dead else alive.
// @@ Please rename to Notifier.
+ /// Smart pointer to the Notifier object.
Notifier_var server_;
- // Smart pointer to the Notifier object.
};
#endif /* CONSUMER_I_H */
diff --git a/TAO/examples/Callback_Quoter/Notifier_Input_Handler.cpp b/TAO/examples/Callback_Quoter/Notifier_Input_Handler.cpp
index d2ae843ec17..f3b1cb32dec 100644
--- a/TAO/examples/Callback_Quoter/Notifier_Input_Handler.cpp
+++ b/TAO/examples/Callback_Quoter/Notifier_Input_Handler.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Notifier_Input_Handler.cpp
-//
-// = DESCRIPTION
-// Implementation of the callback quoter Notifier_Input_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Notifier_Input_Handler.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the callback quoter Notifier_Input_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Notifier_Input_Handler.h"
#include "tao/debug.h"
diff --git a/TAO/examples/Callback_Quoter/Notifier_Input_Handler.h b/TAO/examples/Callback_Quoter/Notifier_Input_Handler.h
index 16385d1da55..3c3c5f17ad9 100644
--- a/TAO/examples/Callback_Quoter/Notifier_Input_Handler.h
+++ b/TAO/examples/Callback_Quoter/Notifier_Input_Handler.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Notifier_Input_Handler.h
-//
-// = DESCRIPTION
-// Definition of the Callback_Quoter Notifier_Input_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Notifier_Input_Handler.h
+ *
+ * $Id$
+ *
+ * Definition of the Callback_Quoter Notifier_Input_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SUPPLIER_INPUT_HANDLER_H
#define SUPPLIER_INPUT_HANDLER_H
@@ -26,66 +23,68 @@
#include "orbsvcs/CosNamingS.h"
#include "orbsvcs/Naming/Naming_Client.h"
+/**
+ * @class Notifier_Input_Handler
+ *
+ * @brief The class defines the callback quoter Notifier initialization
+ * and run methods.
+ *
+ * This class handles initialization tasks, as well, such as
+ * setting up the Orb manager and registers the Notifier servant
+ * object.
+ */
class Notifier_Input_Handler : public ACE_Event_Handler
{
- // = TITLE
- // The class defines the callback quoter Notifier initialization
- // and run methods.
- //
- // = DESCRIPTION
- // This class handles initialization tasks, as well, such as
- // setting up the Orb manager and registers the Notifier servant
- // object.
public:
// = Initialization and termination methods.
+ /// Constructor.
Notifier_Input_Handler (void);
- // Constructor.
+ /// Destructor.
~Notifier_Input_Handler (void);
- // Destructor.
+ /// Initialize the Notifier who plays the role of the server here.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Notifier who plays the role of the server here.
+ /// Run the ORB.
int run (void);
- // Run the ORB.
+ /// Handle the user input.
virtual int handle_input (ACE_HANDLE);
- // Handle the user input.
private:
+ /// The tao orb manager object.
TAO_ORB_Manager orb_manager_;
- // The tao orb manager object.
+ /// Parses the command line arguments.
int parse_args (void);
- // Parses the command line arguments.
+ /// Initialises the name server and registers the Notifier object
+ /// name with the name server.
int init_naming_service (void);
- // Initialises the name server and registers the Notifier object
- // name with the name server.
+ /// File where the IOR of the Notifier object is stored.
FILE *ior_output_file_;
- // File where the IOR of the Notifier object is stored.
+ /// Number of command line arguments.
int argc_;
- // Number of command line arguments.
+ /// The command line arguments.
ACE_TCHAR **argv_;
- // The command line arguments.
+ /// Naming context for the naming service.
CosNaming::NamingContext_var naming_context_;
- // Naming context for the naming service.
+ /// helper class for getting access to Naming Service.
TAO_Naming_Client naming_server_;
- // helper class for getting access to Naming Service.
+ /// The servant object registered with the orb.
Notifier_i notifier_i_;
- // The servant object registered with the orb.
+ /// This specifies whether the naming service is to be used.
int using_naming_service_;
- // This specifies whether the naming service is to be used.
};
#endif /* NOTIFIER_INPUT_HANDLER_H */
diff --git a/TAO/examples/Callback_Quoter/Notifier_i.cpp b/TAO/examples/Callback_Quoter/Notifier_i.cpp
index 0be7b18cb98..a0c2c20e96b 100644
--- a/TAO/examples/Callback_Quoter/Notifier_i.cpp
+++ b/TAO/examples/Callback_Quoter/Notifier_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Notifier_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the Notifier_i class. This class is the servant
-// object for the callback quoter server.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Notifier_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Notifier_i class. This class is the servant
+ * object for the callback quoter server.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Notifier_i.h"
diff --git a/TAO/examples/Callback_Quoter/Notifier_i.h b/TAO/examples/Callback_Quoter/Notifier_i.h
index 769d2c02ad9..6762eb488f9 100644
--- a/TAO/examples/Callback_Quoter/Notifier_i.h
+++ b/TAO/examples/Callback_Quoter/Notifier_i.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Notifier.h
-//
-// = DESCRIPTION
-// Defines the implementation header for the Supplier interface.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Notifier.h
+ *
+ * $Id$
+ *
+ * Defines the implementation header for the Supplier interface.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFIER_I_H
#define NOTIFIER_I_H
@@ -32,63 +29,67 @@
#include "ace/SString.h"
#include "ace/Null_Mutex.h"
+/**
+ * @class Notifier_i
+ *
+ * @brief Notifier servant class.
+ *
+ * The implementation of the Notifier class, which is the servant
+ * object for the callback quoter server.
+ */
class Notifier_i : public POA_Notifier
{
- // = TITLE
- // Notifier servant class.
- //
- // = DESCRIPTION
- // The implementation of the Notifier class, which is the servant
- // object for the callback quoter server.
- //
public:
// = Initialization and termination methods.
+ /// Constructor.
Notifier_i (void);
- // Constructor.
+ /// Destructor.
~Notifier_i (void);
- // Destructor.
+ /// Register a distributed callback handler that is invoked when the
+ /// given stock reaches the desired threshold value.
virtual void register_callback (const char *stock_name,
CORBA::Long threshold_value,
Callback_Quoter::Consumer_ptr consumer_handler);
- // Register a distributed callback handler that is invoked when the
- // given stock reaches the desired threshold value.
+ /// Remove the consumer object.
virtual void unregister_callback (Callback_Quoter::Consumer_ptr consumer_handler);
- // Remove the consumer object.
+ /// Get the market status.
virtual void market_status (const char *stock_name,
CORBA::Long stock_value);
- // Get the market status.
+ /// Get the orb pointer.
void orb (CORBA::ORB_ptr orb);
- // Get the orb pointer.
+ /// Shutdown the Notifier.
virtual void shutdown (void);
- // Shutdown the Notifier.
// CONSUMER_MAP* get_consumer_map_ptr ();
// Returns the consumer map ptr.
//private:
public:
+ /// The ORB manager.
CORBA::ORB_ptr orb_;
- // The ORB manager.
+ /**
+ * @class Consumer_Data
+ *
+ * @brief Saves the Consumer_var and the threshold stock value.
+ */
class Consumer_Data
{
- // = TITLE
- // Saves the Consumer_var and the threshold stock value.
public:
+ /// Comparison operator.
bool operator== (const Consumer_Data &rhs) const;
- // Comparison operator.
+ /// Stores the consumer object reference.
Callback_Quoter::Consumer_var consumer_;
- // Stores the consumer object reference.
+ /// Stores the stock threshold value.
CORBA::Long desired_value_;
- // Stores the stock threshold value.
};
typedef ACE_Unbounded_Set<Consumer_Data>
@@ -97,13 +98,13 @@ public:
typedef ACE_Hash_Map_Manager<ACE_CString, CONSUMERS *, ACE_Null_Mutex>
CONSUMER_MAP;
+ /// This is the hash map with each hash_entry consisting of the stockname
+ /// and an unbounded set of consumer object pointer and the desired stockvalue.
CONSUMER_MAP consumer_map_;
- // This is the hash map with each hash_entry consisting of the stockname
- // and an unbounded set of consumer object pointer and the desired stockvalue.
+ ///This marks the exit of the notifier. This should be taken care of
+ /// before the consumer tries to unregister after the notifier quits.
int notifier_exited_;
- //This marks the exit of the notifier. This should be taken care of
- // before the consumer tries to unregister after the notifier quits.
};
diff --git a/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.cpp b/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.cpp
index a8a9ec3bc12..a17a58cb439 100644
--- a/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.cpp
+++ b/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.cpp
@@ -1,20 +1,12 @@
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Supplier_Time _Handler.cpp
-//
-// = DESCRIPTION
-// Implementation of the Supplier_Time_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * Implementation of the Supplier_Time_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/ACE.h"
diff --git a/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.h b/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.h
index d4baca0d25a..6e96fedf6ac 100644
--- a/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.h
+++ b/TAO/examples/Callback_Quoter/Supplier_Timer_Handler.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Consumer_Input_Handler.h
-//
-// = DESCRIPTION
-// Definition of the Supplier_Timer_Handler class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.h
+ *
+ * $Id$
+ *
+ * Definition of the Supplier_Timer_Handler class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SUPPLIER_TIMER_HANDLER_H
#define SUPPLIER_TIMER_HANDLER_H
@@ -31,47 +27,49 @@
class Supplier;
+/**
+ * @class Supplier_Timer_Handler
+ *
+ * @brief Feeds stock information to the Callback Quoter notifier
+ * periodically.
+ * = Description
+ * Create a class to handle timer events. Since only timer events
+ * need to be handled, only the handle_timeout method is overlaoded.
+ */
class Supplier_Timer_Handler : public ACE_Event_Handler
{
- // = TITLE
- // Feeds stock information to the Callback Quoter notifier
- // periodically.
- //
- // = Description
- // Create a class to handle timer events. Since only timer events
- // need to be handled, only the handle_timeout method is overlaoded.
public:
+ /// Initilization.
Supplier_Timer_Handler (Supplier *supplier,
ACE_Reactor *reactor,
FILE *file_ptr);
- // Initilization.
+ /// Destructor.
~Supplier_Timer_Handler (void);
- // Destructor.
+ /// Method which will be called by the Reactor when timeout occurs.
virtual int handle_timeout (const ACE_Time_Value &tv,
const void *arg = 0);
- // Method which will be called by the Reactor when timeout occurs.
private:
+ /// The values of the stock and its rate are got from the file.
int get_stock_information (void);
- // The values of the stock and its rate are got from the file.
+ /// The supplier instance.
Supplier *supplier_obj_;
- // The supplier instance.
+ /// Reactor used by the supplier.
ACE_Reactor *reactor_;
- // Reactor used by the supplier.
+ /// The file handle of the file from where the stock input is obtained.
FILE* file_ptr_;
- // The file handle of the file from where the stock input is obtained.
+ /// The name of the stock.
char stockname_[BUFSIZ];
- // The name of the stock.
+ /// The market value of the stock.It will be typecasted to long later.
long value_;
- // The market value of the stock.It will be typecasted to long later.
};
#endif /* SUPPLIER_TIMER_HANDLER_H */
diff --git a/TAO/examples/Callback_Quoter/Supplier_i.cpp b/TAO/examples/Callback_Quoter/Supplier_i.cpp
index bfbe6a7e00a..589e9bad462 100644
--- a/TAO/examples/Callback_Quoter/Supplier_i.cpp
+++ b/TAO/examples/Callback_Quoter/Supplier_i.cpp
@@ -1,20 +1,16 @@
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// Supplier_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the Supplier class.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Supplier_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Supplier class.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Supplier_i.h"
#include "tao/debug.h"
diff --git a/TAO/examples/Callback_Quoter/Supplier_i.h b/TAO/examples/Callback_Quoter/Supplier_i.h
index 181e1771c75..ab968e20506 100644
--- a/TAO/examples/Callback_Quoter/Supplier_i.h
+++ b/TAO/examples/Callback_Quoter/Supplier_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Callback_Quoter
-//
-// = FILENAME
-// MarketFeed.h
-//
-// = DESCRIPTION
-// This class implements a simple CORBA server that keeps
-// on sending stock values to the Notifier.
-//
-// = AUTHORS
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file MarketFeed.h
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA server that keeps
+ * on sending stock values to the Notifier.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SUPPLIER_I_H
#define SUPPLIER_I_H
@@ -30,85 +27,87 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Market feed daemon implementation.
+ *
+ * This class feeds stock information to the Callback Quoter
+ * notifier.
+ */
class Supplier_Timer_Handler;
class Supplier
{
- // = TITLE
- // Market feed daemon implementation.
- //
- // = DESCRIPTION
- // This class feeds stock information to the Callback Quoter
- // notifier.
public:
// = Initialization and termination methods.
+ /// Constructor.
Supplier (void);
- // Constructor.
+ /// Destructor.
~Supplier (void);
- // Destructor.
+ /// Execute the daemon.
int run (void);
- // Execute the daemon.
+ /// Initialize the client communication endpoint with Notifier.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication endpoint with Notifier.
+ /// Sends the stock name and its value.
int send_market_status (const char *stock_name,
long value);
- // Sends the stock name and its value.
+ /// The timer handler used to send the market status to the notifier
+ /// periodically.
Supplier_Timer_Handler *supplier_timer_handler_;
- // The timer handler used to send the market status to the notifier
- // periodically.
private:
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Function to read the Notifier IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the Notifier IOR from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// This method initialises the naming service and registers the
+ /// object with the POA.
int via_naming_service(void);
- // This method initialises the naming service and registers the
- // object with the POA.
+ /// returns the TAO instance of the singleton Reactor.
ACE_Reactor *reactor_used (void) const;
- // returns the TAO instance of the singleton Reactor.
+ /// This method used for getting stock information from a file.
int read_file (ACE_TCHAR *filename);
- // This method used for getting stock information from a file.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// IOR of the obj ref of the Notifier.
ACE_TCHAR *ior_;
- // IOR of the obj ref of the Notifier.
+ /// An instance of the name client used for resolving the factory
+ /// objects.
TAO_Naming_Client naming_services_client_;
- // An instance of the name client used for resolving the factory
- // objects.
+ /// This variable denotes whether the naming service
+ /// is used or not.
int use_naming_service_;
- // This variable denotes whether the naming service
- // is used or not.
+ /// Notifier object reference.
Notifier_var notifier_;
- // Notifier object reference.
+ /// The pointer for accessing the input stream.
FILE *f_ptr_;
- // The pointer for accessing the input stream.
+ /// Iteration count.
int loop_count_;
- // Iteration count.
+ /// Time period between two succesive market feeds to the Notifier.
long period_value_;
- // Time period between two succesive market feeds to the Notifier.
};
#endif /*SUPPLIER_I_H */
diff --git a/TAO/examples/Content_Server/AMI_Iterator/Content_Iterator_i.h b/TAO/examples/Content_Server/AMI_Iterator/Content_Iterator_i.h
index c5f475d069b..cc1c1052be3 100644
--- a/TAO/examples/Content_Server/AMI_Iterator/Content_Iterator_i.h
+++ b/TAO/examples/Content_Server/AMI_Iterator/Content_Iterator_i.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Iterator
-//
-// = FILENAME
-// Content_Iterator_i.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::Content_Iterator implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file Content_Iterator_i.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::Content_Iterator implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef CONTENT_ITERATOR_I_H
#define CONTENT_ITERATOR_I_H
@@ -45,39 +42,39 @@ class Content_Iterator_i :
friend class Iterator_Factory_i;
public:
+ /// Constructor
Content_Iterator_i (const char *filename, CORBA::ULongLong file_size);
- // Constructor
+ /// Destructor
~Content_Iterator_i (void);
- // Destructor
+ /// This operation returns the next <chunk> of the file starting at
+ /// <offset>. If there are no more bindings, false is returned.
virtual CORBA::Boolean next_chunk (CORBA::ULongLong offset,
Web_Server::Chunk_Type_out chunk);
- // This operation returns the next <chunk> of the file starting at
- // <offset>. If there are no more bindings, false is returned.
+ /// Destroy the iterator.
virtual void destroy (void);
- // Destroy the iterator.
private:
+ /// Initialize the Content_Iterator.
int init (void);
- // Initialize the Content_Iterator.
private:
+ /// The Addr representing the requested file.
ACE_FILE_Addr file_;
- // The Addr representing the requested file.
+ /// Object that handles all IO operations on the requested file.
ACE_FILE_IO file_io_;
- // Object that handles all IO operations on the requested file.
+ /// The size of the file being iterated over.
CORBA::ULongLong file_size_;
- // The size of the file being iterated over.
+ /// The number of the current chunk of data being sent. (Used only
+ /// for debugging purposes.)
CORBA::ULongLong chunk_index_;
- // The number of the current chunk of data being sent. (Used only
- // for debugging purposes.)
};
#endif /* CONTENT_ITERATOR_I_H */
diff --git a/TAO/examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h b/TAO/examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h
index dcf30076d82..01ecacc983d 100644
--- a/TAO/examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h
+++ b/TAO/examples/Content_Server/AMI_Iterator/Iterator_Factory_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Iterator
-//
-// = FILENAME
-// Iterator_Factory_i.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::Iterator_Factory implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Iterator_Factory_i.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::Iterator_Factory implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef ITERATOR_FACTORY_I_H
#define ITERATOR_FACTORY_I_H
@@ -31,33 +28,37 @@
// Forward declarations
class Content_Iterator_i;
+/**
+ * @class Iterator_Factory_i
+ *
+ * @brief Factory that creates a Content_Iterator that retrieves fixed
+ * size chunks of data from Content server.
+ *
+ * This class creates a Content_Iterator that is set up to
+ * iteratively download a specific file. This same factory can
+ * be used to create Content_Iterators for other files.
+ */
class Iterator_Factory_i : virtual public POA_Web_Server::Iterator_Factory
{
- // = TITLE
- // Factory that creates a Content_Iterator that retrieves fixed
- // size chunks of data from Content server.
- //
- // = DESCRIPTION
- // This class creates a Content_Iterator that is set up to
- // iteratively download a specific file. This same factory can
- // be used to create Content_Iterators for other files.
public:
+ /**
+ * This factory method returns a <Content_Iterator> that can be used
+ * to read the <contents> associated with <pathname> one ``chunk''
+ * at a time. The <metadata> reports information about the
+ * <contents>.
+ */
virtual void get_iterator (const char *pathname,
Web_Server::Content_Iterator_out contents,
Web_Server::Metadata_Type_out metadata);
- // This factory method returns a <Content_Iterator> that can be used
- // to read the <contents> associated with <pathname> one ``chunk''
- // at a time. The <metadata> reports information about the
- // <contents>.
+ /// Set the file modification date in the metadata structure.
int modification_date (ACE_stat *file_status,
Web_Server::Metadata_Type_out metadata);
- // Set the file modification date in the metadata structure.
+ /// Set the type of file content in the metadata structure.
int content_type (const char *filename,
Web_Server::Metadata_Type_out metadata);
- // Set the type of file content in the metadata structure.
};
#endif /* ITERATOR_FACTORY_I_H */
diff --git a/TAO/examples/Content_Server/AMI_Iterator/Iterator_Handler.h b/TAO/examples/Content_Server/AMI_Iterator/Iterator_Handler.h
index bc63b1361f8..d2d9ae964eb 100644
--- a/TAO/examples/Content_Server/AMI_Iterator/Iterator_Handler.h
+++ b/TAO/examples/Content_Server/AMI_Iterator/Iterator_Handler.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Iterator
-//
-// = FILENAME
-// Iterator_Handler.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::AMI_Content_IteratorHandler
-// implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Iterator_Handler.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::AMI_Content_IteratorHandler
+ * implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef ITERATOR_HANDLER_H
#define ITERATOR_HANDLER_H
@@ -43,14 +40,14 @@ class Iterator_Handler
// received in the proper order, and also takes advantage of
// asyncronous method invocations.
+ /// Dummy friend class declaration to quiet down a warning.
friend class Iterator_Handler_Friend;
- // Dummy friend class declaration to quiet down a warning.
public:
+ /// Constructor that creates a content iterator corresponding to the
+ /// name of the file being retrieved from the web server.
Iterator_Handler (void);
- // Constructor that creates a content iterator corresponding to the
- // name of the file being retrieved from the web server.
virtual void next_chunk (CORBA::Boolean pending_data,
const Web_Server::Chunk_Type & chunk);
@@ -65,61 +62,65 @@ public:
::Messaging::ExceptionHolder *)
{}
+ /**
+ * Activate and run this Reply Handler. The contents (not the
+ * pointer itself) of the <request_count> parameter will be
+ * incremented when file retrieval begins, and decremented when file
+ * retrieval completes.
+ */
void run (int *request_count,
const char *pathname,
Web_Server::Iterator_Factory_ptr factory);
- // Activate and run this Reply Handler. The contents (not the
- // pointer itself) of the <request_count> parameter will be
- // incremented when file retrieval begins, and decremented when file
- // retrieval completes.
private:
+ /// Destructor (private to ensure that Iterator_Handler is allocated
+ /// on the heap).
~Iterator_Handler (void);
- // Destructor (private to ensure that Iterator_Handler is allocated
- // on the heap).
+ /// Initialize the Content Iterator used to retrieve the file.
void initialize_content_iterator (const char *pathname,
Web_Server::Iterator_Factory_ptr factory);
- // Initialize the Content Iterator used to retrieve the file.
+ /// Deactivate this reply handler.
void deactivate (void);
- // Deactivate this reply handler.
+ /// Get the name of the viewer associated with the file being
+ /// retrieved.
int get_viewer (char *viewer, size_t length);
- // Get the name of the viewer associated with the file being
- // retrieved.
+ /// Spawn an external view to display the retrieved file.
int spawn_viewer (void);
- // Spawn an external view to display the retrieved file.
private:
+ /// The Addr corresponding to the retrieved file.
ACE_FILE_Addr file_;
- // The Addr corresponding to the retrieved file.
+ /// The object that provides all file related IO operations
+ /// (e.g. read, write, etc).
ACE_FILE_IO file_io_;
- // The object that provides all file related IO operations
- // (e.g. read, write, etc).
+ /// The iterator used to obtain individual chunks of data from the
+ /// web server.
Web_Server::Content_Iterator_var contents_;
- // The iterator used to obtain individual chunks of data from the
- // web server.
+ /// The metadata associated with the file being retrieved from the
+ /// web server.
Web_Server::Metadata_Type_var metadata_;
- // The metadata associated with the file being retrieved from the
- // web server.
+ /// The offset from the beginning of the file, the next chunk of data
+ /// should be read from.
CORBA::ULong offset_;
- // The offset from the beginning of the file, the next chunk of data
- // should be read from.
+ /// Reference to this Reply Handler's self.
Web_Server::AMI_Content_IteratorHandler_var ami_handler_;
- // Reference to this Reply Handler's self.
+ /**
+ * Pointer to external status monitoring variable. The contents (not
+ * the pointer itself) of the<pending_data> parameter will be
+ * decremented when file retrieval has completed.
+ */
int *request_count_;
- // Pointer to external status monitoring variable. The contents (not
- // the pointer itself) of the<pending_data> parameter will be
- // decremented when file retrieval has completed.
};
#endif /* ITERATOR_HAHNDLER_H */
diff --git a/TAO/examples/Content_Server/AMI_Observer/Callback_Handler.h b/TAO/examples/Content_Server/AMI_Observer/Callback_Handler.h
index 90f05d3e1e6..27621ec6d3d 100644
--- a/TAO/examples/Content_Server/AMI_Observer/Callback_Handler.h
+++ b/TAO/examples/Content_Server/AMI_Observer/Callback_Handler.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Observer
-//
-// = FILENAME
-// Callback_Handler.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::AMI_CallbackHandler
-// implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Callback_Handler.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::AMI_CallbackHandler
+ * implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef CALLBACK_HANDLER_H
#define CALLBACK_HANDLER_H
@@ -68,63 +65,65 @@ class Callback_Handler
// application level, yet concurrency is achieved due to the fact
// that all operations are performed asynchronously.
+ /// Dummy friend class declaration to quiet down a warning.
friend class Callback_Handler_Friend;
- // Dummy friend class declaration to quiet down a warning.
public:
+ /// Constructor that creates a content iterator corresponding to the
+ /// name of the file being retrieved from the web server.
Callback_Handler (const char *pathname,
Web_Server::Callback_ptr callback);
- // Constructor that creates a content iterator corresponding to the
- // name of the file being retrieved from the web server.
+ /// The callback for this reply handler.
virtual void next_chunk (void);
- // The callback for this reply handler.
virtual void next_chunk_excep (::Messaging::ExceptionHolder *);
+ /**
+ * Activate and run this Reply Handler. The contents (not the
+ * pointer itself) of the <request_count> parameter will be
+ * incremented when file retrieval begins, and decremented when file
+ * retrieval completes.
+ */
void run (void);
- // Activate and run this Reply Handler. The contents (not the
- // pointer itself) of the <request_count> parameter will be
- // incremented when file retrieval begins, and decremented when file
- // retrieval completes.
private:
+ /// Destructor (private to ensure that Callback_Handler is allocated
+ /// on the heap).
~Callback_Handler (void);
- // Destructor (private to ensure that Callback_Handler is allocated
- // on the heap).
+ /// Open the file to be uploaded to the client callback.
void open_file (void);
- // Open the file to be uploaded to the client callback.
+ /// Deactivate this reply handler.
void deactivate (void);
- // Deactivate this reply handler.
private:
+ /// The Addr corresponding to the retrieved file.
ACE_FILE_Addr file_;
- // The Addr corresponding to the retrieved file.
+ /// The object that provides all file related IO operations
+ /// (e.g. read, write, etc).
ACE_FILE_IO file_io_;
- // The object that provides all file related IO operations
- // (e.g. read, write, etc).
+ /// The iterator used to obtain individual chunks of data from the
+ /// web server.
Web_Server::Callback_var callback_;
- // The iterator used to obtain individual chunks of data from the
- // web server.
+ /// Reference to this Reply Handler's self.
Web_Server::AMI_CallbackHandler_var ami_handler_;
- // Reference to this Reply Handler's self.
+ /// The chunk of data that is sent to the client callback during each
+ /// callback invocation.
Web_Server::Chunk_Type_var chunk_;
- // The chunk of data that is sent to the client callback during each
- // callback invocation.
+ /// The number of the current chunk of data being sent. (Used only
+ /// for debugging purposes.)
CORBA::ULong chunk_index_;
- // The number of the current chunk of data being sent. (Used only
- // for debugging purposes.)
+ /// Flag that indicates all chunks of data have been sent.
int last_chunk_;
- // Flag that indicates all chunks of data have been sent.
};
#endif /* CALLBACK_HANDLER_H */
diff --git a/TAO/examples/Content_Server/AMI_Observer/Callback_i.h b/TAO/examples/Content_Server/AMI_Observer/Callback_i.h
index 5105bd46689..07de50edf11 100644
--- a/TAO/examples/Content_Server/AMI_Observer/Callback_i.h
+++ b/TAO/examples/Content_Server/AMI_Observer/Callback_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Observer
-//
-// = FILENAME
-// Callback_i.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::Callback implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Callback_i.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::Callback implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef CALLBACK_I_H
#define CALLBACK_I_H
@@ -53,73 +50,75 @@ class Callback_i :
// concurrently running threads attempt to update the state
// contained within a given <Callback> object.
+ /// Dummy friend class declaration to quiet down a warning.
friend class Callback_i_Friend;
- // Dummy friend class declaration to quiet down a warning.
public:
+ /// Constructor
Callback_i (int *request_count);
- // Constructor
+ /// This operation returns the next <chunk> of the file starting at
+ /// <offset>. If there are no more bindings, false is returned.
virtual void next_chunk (const Web_Server::Chunk_Type &chunk,
CORBA::Boolean last_chunk);
- // This operation returns the next <chunk> of the file starting at
- // <offset>. If there are no more bindings, false is returned.
+ /// Set metadata associated with received data.
void metadata (const Web_Server::Metadata_Type &metadata);
- // Set metadata associated with received data.
private:
+ /// Destructor must be private to ensure that this object is
+ /// allocated on the heap.
~Callback_i (void);
- // Destructor must be private to ensure that this object is
- // allocated on the heap.
+ /// Returns one if the metadata was received, and zero otherwise.
int metadata_received (void);
- // Returns one if the metadata was received, and zero otherwise.
+ /// Returns one if the entire content was received, and zero
+ /// otherwise.
int content_received (void);
- // Returns one if the entire content was received, and zero
- // otherwise.
+ /// Get the name of the viewer associated with the file being
+ /// retrieved.
int get_viewer (char *viewer, size_t length);
- // Get the name of the viewer associated with the file being
- // retrieved.
+ /// Spawn an external view to display the retrieved file.
int spawn_viewer (void);
- // Spawn an external view to display the retrieved file.
private:
+ /// Deactivate this Callback servant.
void deactivate (void);
- // Deactivate this Callback servant.
private:
+ /// The Addr corresponding to the retrieved file.
ACE_FILE_Addr file_;
- // The Addr corresponding to the retrieved file.
+ /// The object that provides all file related IO operations
+ /// (e.g. read, write, etc).
ACE_FILE_IO file_io_;
- // The object that provides all file related IO operations
- // (e.g. read, write, etc).
+ /// Reference to this Reply Handler's self.
Web_Server::AMI_CallbackHandler_var ami_handler_;
- // Reference to this Reply Handler's self.
+ /// The metadata associated with the file being retrieved from the
+ /// web server.
Web_Server::Metadata_Type metadata_;
- // The metadata associated with the file being retrieved from the
- // web server.
+ /// Flag that indicates entire data content has been received.
int last_chunk_;
- // Flag that indicates entire data content has been received.
+ /// Lock used to prevent race conditions when checking to see if
+ /// metadata or entire content has been received.
TAO_SYNCH_MUTEX lock_;
- // Lock used to prevent race conditions when checking to see if
- // metadata or entire content has been received.
+ /**
+ * Pointer to external status monitoring variable. The contents (not
+ * the pointer itself) of the <pending_data> parameter will be
+ * decremented when file retrieval has completed.
+ */
int *request_count_;
- // Pointer to external status monitoring variable. The contents (not
- // the pointer itself) of the <pending_data> parameter will be
- // decremented when file retrieval has completed.
};
#endif /* CALLBACK_I_H */
diff --git a/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h b/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h
index 1ccd1880e53..8bf570c08b7 100644
--- a/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h
+++ b/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Factory_i.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Observer
-//
-// = FILENAME
-// Push_Iterator_Factory_i.h
-//
-// = DESCRIPTION
-// Header file for the push Web_Server::Iterator_Factory implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Push_Iterator_Factory_i.h
+ *
+ * $Id$
+ *
+ * Header file for the push Web_Server::Iterator_Factory implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef PUSH_ITERATOR_FACTORY_I_H
#define PUSH_ITERATOR_FACTORY_I_H
@@ -51,25 +48,27 @@ class Push_Iterator_Factory_i :
// to explicitly use threads at the application level.
public:
+ /**
+ * This registration method passes a <Callback> that the Web server
+ * uses to ``push'' data associated with <pathname> one ``chunk'' at
+ * a time. The <metadata> reports information about the <pathname>.
+ */
Web_Server::Metadata_Type *register_callback
(const char *pathname,
Web_Server::Callback_ptr client_callback);
- // This registration method passes a <Callback> that the Web server
- // uses to ``push'' data associated with <pathname> one ``chunk'' at
- // a time. The <metadata> reports information about the <pathname>.
+ /// Set the file modification date in the metadata structure.
int modification_date (ACE_stat *file_status,
Web_Server::Metadata_Type &metadata);
- // Set the file modification date in the metadata structure.
+ /// Set the type of file content in the metadata structure.
int content_type (const char *filename,
Web_Server::Metadata_Type &metadata);
- // Set the type of file content in the metadata structure.
private:
+ /// Reference to the object that is used by the server to push chunks
+ /// of data to the client.
Web_Server::Callback_var client_callback_;
- // Reference to the object that is used by the server to push chunks
- // of data to the client.
};
#include /**/ "ace/post.h"
diff --git a/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h b/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
index 5e973a68824..3d4bbe18053 100644
--- a/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
+++ b/TAO/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Observer
-//
-// = FILENAME
-// Push_Iterator_Handler.h
-//
-// = DESCRIPTION
-// Header file for the AMI_Iterator_FactoryHandler implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Push_Iterator_Handler.h
+ *
+ * $Id$
+ *
+ * Header file for the AMI_Iterator_FactoryHandler implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef PUSH_ITERATOR_HANDLER_H
#define PUSH_ITERATOR_HANDLER_H
@@ -52,49 +49,51 @@ class Push_Iterator_Handler
// use for this <Push_Iterator_Handler> object, and it is
// deactivated.
+ /// Dummy friend class declaration to quiet down a warning.
friend class Push_Iterator_Handler_Friend;
- // Dummy friend class declaration to quiet down a warning.
public:
+ /// Constructor that creates a content iterator corresponding to the
+ /// name of the file being retrieved from the web server.
Push_Iterator_Handler (void);
- // Constructor that creates a content iterator corresponding to the
- // name of the file being retrieved from the web server.
+ /**
+ * Activate and run this Reply Handler. The contents (not the
+ * pointer itself) of the <request_count> parameter will be
+ * incremented when file retrieval begins, and decremented when file
+ * retrieval completes.
+ */
void run (int *request_count,
const char *pathname,
Web_Server::Iterator_Factory_ptr factory);
- // Activate and run this Reply Handler. The contents (not the
- // pointer itself) of the <request_count> parameter will be
- // incremented when file retrieval begins, and decremented when file
- // retrieval completes.
private:
+ /// Destructor (private to ensure that Iterator_Handler is allocated
+ /// on the heap).
~Push_Iterator_Handler (void);
- // Destructor (private to ensure that Iterator_Handler is allocated
- // on the heap).
+ /// AMI callback that is invoked when a response from the
+ /// corresponding server method is received.
virtual void register_callback
(const Web_Server::Metadata_Type &metadata);
- // AMI callback that is invoked when a response from the
- // corresponding server method is received.
virtual void register_callback_excep
(::Messaging::ExceptionHolder *)
{}
+ /// Deactivate this handler.
void deactivate (void);
- // Deactivate this handler.
private:
+ /// The servant that accepts data pushed from the content server.
Callback_i *callback_servant_;
- // The servant that accepts data pushed from the content server.
+ /// Reference to the callback object the server sends data to.
Web_Server::Callback_var callback_;
- // Reference to the callback object the server sends data to.
+ /// Reference to this Reply Handler's self.
Web_Server::AMI_Iterator_FactoryHandler_var ami_handler_;
- // Reference to this Reply Handler's self.
};
#endif /* PUSH_ITERATOR_HANDLER_H */
diff --git a/TAO/examples/Content_Server/SMI_Iterator/Content_Iterator_i.h b/TAO/examples/Content_Server/SMI_Iterator/Content_Iterator_i.h
index 0f8579ff5bd..cc1c1052be3 100644
--- a/TAO/examples/Content_Server/SMI_Iterator/Content_Iterator_i.h
+++ b/TAO/examples/Content_Server/SMI_Iterator/Content_Iterator_i.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// SMI_ITERATOR
-//
-// = FILENAME
-// Content_Iterator_i.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::Content_Iterator implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file Content_Iterator_i.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::Content_Iterator implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef CONTENT_ITERATOR_I_H
#define CONTENT_ITERATOR_I_H
@@ -45,39 +42,39 @@ class Content_Iterator_i :
friend class Iterator_Factory_i;
public:
+ /// Constructor
Content_Iterator_i (const char *filename, CORBA::ULongLong file_size);
- // Constructor
+ /// Destructor
~Content_Iterator_i (void);
- // Destructor
+ /// This operation returns the next <chunk> of the file starting at
+ /// <offset>. If there are no more bindings, false is returned.
virtual CORBA::Boolean next_chunk (CORBA::ULongLong offset,
Web_Server::Chunk_Type_out chunk);
- // This operation returns the next <chunk> of the file starting at
- // <offset>. If there are no more bindings, false is returned.
+ /// Destroy the iterator.
virtual void destroy (void);
- // Destroy the iterator.
private:
+ /// Initialize the Content_Iterator.
int init (void);
- // Initialize the Content_Iterator.
private:
+ /// The Addr representing the requested file.
ACE_FILE_Addr file_;
- // The Addr representing the requested file.
+ /// Object that handles all IO operations on the requested file.
ACE_FILE_IO file_io_;
- // Object that handles all IO operations on the requested file.
+ /// The size of the file being iterated over.
CORBA::ULongLong file_size_;
- // The size of the file being iterated over.
+ /// The number of the current chunk of data being sent. (Used only
+ /// for debugging purposes.)
CORBA::ULongLong chunk_index_;
- // The number of the current chunk of data being sent. (Used only
- // for debugging purposes.)
};
#endif /* CONTENT_ITERATOR_I_H */
diff --git a/TAO/examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h b/TAO/examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h
index 7b7bfb5164f..8e466a5bf4e 100644
--- a/TAO/examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h
+++ b/TAO/examples/Content_Server/SMI_Iterator/Iterator_Factory_i.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// SMI_ITERATOR
-//
-// = FILENAME
-// Iterator_Factory_i.h
-//
-// = DESCRIPTION
-// Header file for the Web_Server::Iterator_Factory implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file Iterator_Factory_i.h
+ *
+ * $Id$
+ *
+ * Header file for the Web_Server::Iterator_Factory implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef ITERATOR_FACTORY_I_H
#define ITERATOR_FACTORY_I_H
@@ -32,34 +29,38 @@
// Forward declarations
class Content_Iterator_i;
+/**
+ * @class Iterator_Factory_i
+ *
+ * @brief Factory that creates a Content_Iterator that retrieves fixed
+ * size chunks of data from Content server.
+ *
+ * This class creates a Content_Iterator that is set up to
+ * iteratively download a specific file. This same factory can
+ * be used to create Content_Iterators for other files.
+ */
class Iterator_Factory_i : virtual public POA_Web_Server::Iterator_Factory
{
- // = TITLE
- // Factory that creates a Content_Iterator that retrieves fixed
- // size chunks of data from Content server.
- //
- // = DESCRIPTION
- // This class creates a Content_Iterator that is set up to
- // iteratively download a specific file. This same factory can
- // be used to create Content_Iterators for other files.
public:
+ /**
+ * This factory method returns a <Content_Iterator> that can be used
+ * to read the <contents> associated with <pathname> one ``chunk''
+ * at a time. The <metadata> reports information about the
+ * <contents>.
+ */
virtual void get_iterator (const char *pathname,
Web_Server::Content_Iterator_out contents,
Web_Server::Metadata_Type_out metadata);
- // This factory method returns a <Content_Iterator> that can be used
- // to read the <contents> associated with <pathname> one ``chunk''
- // at a time. The <metadata> reports information about the
- // <contents>.
+ /// Set the file modification date in the metadata structure.
int modification_date (ACE_stat *file_status,
Web_Server::Metadata_Type_out metadata);
- // Set the file modification date in the metadata structure.
+ /// Set the type of file content in the metadata structure.
int content_type (const char *filename,
Web_Server::Metadata_Type_out metadata);
- // Set the type of file content in the metadata structure.
};
diff --git a/TAO/examples/Event_Comm/Consumer_Handler.h b/TAO/examples/Event_Comm/Consumer_Handler.h
index 765e73ab4b8..4cc83ad5f6c 100644
--- a/TAO/examples/Event_Comm/Consumer_Handler.h
+++ b/TAO/examples/Event_Comm/Consumer_Handler.h
@@ -1,23 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Consumer_Handler.h
-//
-// = DESCRIPTION
-// Subclass of Corba_Handler that sets up the Consumer handler
-// for use with the ACE ACE_Reactor.
-//
-// = AUTHOR
-// Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore
-// (pradeep@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Handler.h
+ *
+ * $Id$
+ *
+ * Subclass of Corba_Handler that sets up the Consumer handler
+ * for use with the ACE ACE_Reactor.
+ *
+ *
+ * @author Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore (pradeep@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef _CONSUMER_HANDLER_H
#define _CONSUMER_HANDLER_H
@@ -26,66 +22,68 @@
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/CosNamingC.h"
+/**
+ * @class Consumer_Handler
+ *
+ * @brief The Consumer_Handler class.
+ *
+ * Starts up the ORB, registers the <Event_Comm::Consumer>
+ * servant with the orb and gets a reference to a <Notifier>
+ * from the Naming Service.
+ */
class Consumer_Handler
{
- // = TITLE
- // The Consumer_Handler class.
- //
- // = DESCRIPTION
- // Starts up the ORB, registers the <Event_Comm::Consumer>
- // servant with the orb and gets a reference to a <Notifier>
- // from the Naming Service.
public:
// = Initialization and termination methods.
+ /// Constructor.
Consumer_Handler (void);
- // Constructor.
+ /// Destructor.
virtual ~Consumer_Handler (void);
- // Destructor.
+ /// Initializes the ORB, gets the Notifier reference from the Naming
+ /// Service, and starts the servant for the Consumer object.
int init (int argc, ACE_TCHAR *argv[], ShutdownCallback *_shutdowncallback);
- // Initializes the ORB, gets the Notifier reference from the Naming
- // Service, and starts the servant for the Consumer object.
+ /// runs the ORB.
int run (void);
- // runs the ORB.
+ /// shutdown the orb.
void close (void);
- // shutdown the orb.
+ /// called to shutdown the consumer application.
void shutdown (void);
- // called to shutdown the consumer application.
// = Accessors
Event_Comm::Consumer *receiver (void);
Event_Comm::Notifier *notifier (void);
+ /// returns the ORB's reactor.
ACE_Reactor *reactor (void);
- // returns the ORB's reactor.
private:
+ /// gets the notifier reference from the naming service.
+ /// returns 0 on success, -1 on error.
int get_notifier (void);
- // gets the notifier reference from the naming service.
- // returns 0 on success, -1 on error.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// The <Consumer> implementation.
Consumer_i receiver_i_;
- // The <Consumer> implementation.
+ /// Pointer to an IDL <Consumer> proxy object.
Event_Comm::Consumer_var receiver_;
- // Pointer to an IDL <Consumer> proxy object.
+ /// Pointer to an IDL <Notifier> proxy object.
Event_Comm::Notifier_var notifier_;
- // Pointer to an IDL <Notifier> proxy object.
+ /// An instance of the name client used for resolving the factory
+ /// objects.
TAO_Naming_Client naming_services_client_;
- // An instance of the name client used for resolving the factory
- // objects.
+ /// The Shutdown callback used to shutdown the consumer application.
ShutdownCallback* shutdowncallback;
- // The Shutdown callback used to shutdown the consumer application.
};
#define NOTIFIER_BIND_NAME "Notifier"
diff --git a/TAO/examples/Event_Comm/Consumer_Input_Handler.h b/TAO/examples/Event_Comm/Consumer_Input_Handler.h
index 0a98278ffae..8fd169a7c32 100644
--- a/TAO/examples/Event_Comm/Consumer_Input_Handler.h
+++ b/TAO/examples/Event_Comm/Consumer_Input_Handler.h
@@ -1,18 +1,15 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Consumer_Input_Handler.h
-//
-// = AUTHOR
-// Douglas C. Schmidt (schmidt@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Consumer_Input_Handler.h
+ *
+ * $Id$
+ *
+ * @author Douglas C. Schmidt (schmidt@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_INPUT_HANDLER_H
#define CONSUMER_INPUT_HANDLER_
@@ -28,46 +25,48 @@
// Forward declaration.
class Consumer_Handler;
+/**
+ * @class Consumer_Input_Handler
+ *
+ * @brief Handles input events generated from a keyboard.
+ *
+ * This class holds a <Consumer_Handler> object. It accepts input
+ * from the user and passes events to the <Notifier>. It also
+ * initiates shutdown.
+ */
class Consumer_Input_Handler : public ACE_Event_Handler
{
- // = TITLE
- // Handles input events generated from a keyboard.
- //
- // = DESCRIPTION
- // This class holds a <Consumer_Handler> object. It accepts input
- // from the user and passes events to the <Notifier>. It also
- // initiates shutdown.
public:
// Initialization and termination methods.
+ /// Constructor.
Consumer_Input_Handler(void);
- // Constructor.
+ /// Destructor.
~Consumer_Input_Handler (void);
- // Destructor.
+ /// registers the input event handler.
+ /// returns 0 on success, -1 on error.
int initialize (Consumer_Handler *);
- // registers the input event handler.
- // returns 0 on success, -1 on error.
+ /// Dispatch the callback when events occur.
virtual int handle_input (ACE_HANDLE);
- // Dispatch the callback when events occur.
+ /// Close down the handler.
int close (void);
- // Close down the handler.
+ /// Report whether the Consumer initiated the shutdown.
int consumer_initiated_shutdown (void);
- // Report whether the Consumer initiated the shutdown.
+ /// Indicate that the Consumer initiated the shutdown.
void consumer_initiated_shutdown (int);
- // Indicate that the Consumer initiated the shutdown.
private:
+ /// Pointer to the <Consumer_Handler> that receives notifications
+ /// from the <Event_Comm::Notifier>.
Consumer_Handler *receiver_handler_;
- // Pointer to the <Consumer_Handler> that receives notifications
- // from the <Event_Comm::Notifier>.
+ /// Keep track of whether the Consumer initiated the shutdown.
int consumer_initiated_shutdown_;
- // Keep track of whether the Consumer initiated the shutdown.
};
#endif /* CONSUMER_INPUT_HANDLER_H */
diff --git a/TAO/examples/Event_Comm/Event_Comm_i.h b/TAO/examples/Event_Comm/Event_Comm_i.h
index 1df87e6751e..8c13c8435a9 100644
--- a/TAO/examples/Event_Comm/Event_Comm_i.h
+++ b/TAO/examples/Event_Comm/Event_Comm_i.h
@@ -1,23 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Event_Comm_i.h
-//
-// = DESCRIPTION
-// Class interface for the implementation of the distributed
-// event notification mechanism.
-//
-// = AUTHOR
-// Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore
-// <pradeep@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Event_Comm_i.h
+ *
+ * $Id$
+ *
+ * Class interface for the implementation of the distributed
+ * event notification mechanism.
+ *
+ *
+ * @author Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _EVENT_COMM_I_H
#define _EVENT_COMM_I_H
@@ -34,56 +30,65 @@
#include "ace/Reactor.h"
#include "ace/Null_Mutex.h"
+/**
+ * @class ShutdownCallback
+ *
+ * @brief Helper callback class to shutdown the application.
+ */
class ShutdownCallback
{
- // = TITLE
- // Helper callback class to shutdown the application.
public:
/// Destructor.
virtual ~ShutdownCallback (void);
+ /// This method is to be called to shutdown the application.
virtual void close (void) = 0;
- // This method is to be called to shutdown the application.
};
+/**
+ * @class Consumer_i
+ *
+ * @brief Defines the implementation class for event <Consumers>.
+ */
class Consumer_i : public POA_Event_Comm::Consumer
{
- // = TITLE
- // Defines the implementation class for event <Consumers>.
public:
// = Initialization and termination methods.
+ /// Constructor.
Consumer_i (void);
- // Constructor.
+ /// Destructor.
~Consumer_i (void);
- // Destructor.
+ /// set the <ACE_Reactor> to use when quitting.
void set_reactor (ACE_Reactor *reactor);
- // set the <ACE_Reactor> to use when quitting.
+ /// Pass the <event> to the <Consumer>.
virtual void push (const Event_Comm::Event & event);
- // Pass the <event> to the <Consumer>.
virtual void disconnect (const char * reason);
// Disconnect the <Consumer> from the <Notifier>, giving it the
// <reason>.
+ /// Set the Shutdown callback.
void set (ShutdownCallback *_shutdown);
- // Set the Shutdown callback.
private:
+ /// The callback to shutdown the consumer application.
ShutdownCallback *shutdown;
- // The callback to shutdown the consumer application.
};
// Forward reference.
class Consumer_Entry;
+/**
+ * @class Notifier_i
+ *
+ * @brief Defines the implementation class for event <Notifiers>.
+ */
class Notifier_i : public POA_Event_Comm::Notifier
{
- // = TITLE
- // Defines the implementation class for event <Notifiers>.
public:
enum
{
@@ -91,24 +96,24 @@ public:
// Default max number of Event_Comm::Consumers.
};
+ /// Initialize a Notifier_i object with the specified size hint.
Notifier_i (size_t size_hint = Notifier_i::DEFAULT_SIZE);
- // Initialize a Notifier_i object with the specified size hint.
+ /// Disconnect all the receivers, giving them the <reason>.
virtual void disconnect (const char *reason);
- // Disconnect all the receivers, giving them the <reason>.
+ /// Send the <event> to all the consumers who have subscribed and who
+ /// match the filtering criteria.
virtual void push (const Event_Comm::Event &event);
- // Send the <event> to all the consumers who have subscribed and who
- // match the filtering criteria.
+ /// Subscribe the <Consumer> to receive events that match
+ /// <filtering_criteria> applied by the <Notifier>.
virtual void subscribe (Event_Comm::Consumer_ptr Consumer,
const char * filtering_criteria);
- // Subscribe the <Consumer> to receive events that match
- // <filtering_criteria> applied by the <Notifier>.
+ /// Unsubscribe the <Consumer>.
void unsubscribe (Event_Comm::Consumer *consumer,
const char *filtering_criteria);
- // Unsubscribe the <Consumer>.
private:
typedef ACE_Map_Manager <Event_Comm::Consumer_ptr, Consumer_Entry *, ACE_Null_Mutex>
@@ -118,8 +123,8 @@ private:
typedef ACE_Map_Entry <Event_Comm::Consumer_ptr, Consumer_Entry *>
MAP_ENTRY;
+ /// Table that maps a <Event_Comm::Consumer *> to a <Consumer_Entry *>.
MAP_MANAGER map_;
- // Table that maps a <Event_Comm::Consumer *> to a <Consumer_Entry *>.
};
#endif /* _EVENT_COMM_I_H */
diff --git a/TAO/examples/Event_Comm/Notifier_Handler.h b/TAO/examples/Event_Comm/Notifier_Handler.h
index f7aaababeb3..e8be0e6d357 100644
--- a/TAO/examples/Event_Comm/Notifier_Handler.h
+++ b/TAO/examples/Event_Comm/Notifier_Handler.h
@@ -1,19 +1,15 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Notifier_Handler.h
-//
-// = AUTHOR
-// Douglas C. Schmidt (schmidt@cs.wustl.edu) and
-// Pradeep Gore (pradeep@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Notifier_Handler.h
+ *
+ * $Id$
+ *
+ * @author Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore (pradeep@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef _NOTIFIER_HANDLER_H
#define _NOTIFIER_HANDLER_H
@@ -27,52 +23,55 @@
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/CosNamingC.h"
+/**
+ * @class Notifier_Handler
+ *
+ * @brief Holds the <Event_Comm::Notifier> object which is obtained from
+ * the naming service.
+ */
class Notifier_Handler
{
- // = TITLE
- // Holds the <Event_Comm::Notifier> object which is obtained from
- // the naming service.
public:
// = Initialization and termination methods.
+ /// This constructor gets the notifier object from the Naming
+ /// Service.
Notifier_Handler (void);
- // This constructor gets the notifier object from the Naming
- // Service.
+ /// Destructor.
virtual ~Notifier_Handler (void);
- // Destructor.
+ /// Initialize the client communication endpoint with server.
int init (int argc, ACE_TCHAR *argv[], ShutdownCallback* _shutdowncallback);
- // Initialize the client communication endpoint with server.
// = Accessors.
Event_Comm::Notifier *notifier (void);
void notifier (Event_Comm::Notifier *);
+ /// runs the ORB.
int run (void);
- // runs the ORB.
+ /// Close down the handler.
int close (void);
- // Close down the handler.
+ /// called to request application shutdown.
void shutdown (void);
- // called to request application shutdown.
+ /// returns the ORB's reactor.
ACE_Reactor *reactor (void);
- // returns the ORB's reactor.
private:
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Pointer to an <Event_Comm::Notifier> object.
Event_Comm::Notifier *notifier_;
- // Pointer to an <Event_Comm::Notifier> object.
+ /// An instance of the name client used for resolving the factory
+ /// objects.
TAO_Naming_Client naming_client_;
- // An instance of the name client used for resolving the factory
- // objects.
+ /// The handler to shutdown the app.
ShutdownCallback *shutdowncallback;
- // The handler to shutdown the app.
};
#define NOTIFIER_BIND_NAME "Notifier"
diff --git a/TAO/examples/Event_Comm/Notifier_Server.h b/TAO/examples/Event_Comm/Notifier_Server.h
index 853f32b7be6..d95d5172273 100644
--- a/TAO/examples/Event_Comm/Notifier_Server.h
+++ b/TAO/examples/Event_Comm/Notifier_Server.h
@@ -1,18 +1,15 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Notifier_Server.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Notifier_Server.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _NOTIFIER_SERVER_H
#define _NOTIFIER_SERVER_H
@@ -22,47 +19,50 @@
#include "orbsvcs/CosNamingS.h"
#include "orbsvcs/Naming/Naming_Client.h"
+/**
+ * @class Notifier_Server
+ *
+ * @brief The Notifier Server that handles CORBA operations from
+ * Consumers and Suppliers.
+ */
class Notifier_Server
{
- // = TITLE
- // The Notifier Server that handles CORBA operations from
- // Consumers and Suppliers.
public:
// = Initialization and termination methods.
+ /// Constructor.
Notifier_Server (void);
- // Constructor.
+ /// Destructor.
~Notifier_Server (void);
- // Destructor.
+ /// Initialize the Server state.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the Server state.
+ /// Run the orb.
int run (void);
- // Run the orb.
+ /// Close the naming service.
int close (void);
- // Close the naming service.
+ /// Reactor accessor.
ACE_Reactor *reactor(void);
- // Reactor accessor.
private:
+ /// Initialises the name server and registers the Notifier server
+ /// object name with the name server.
int init_naming_service (void);
- // Initialises the name server and registers the Notifier server
- // object name with the name server.
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// Servant for the Notifier interface.
Notifier_i servant_;
- // Servant for the Notifier interface.
+ /// Naming context for the naming service.
CosNaming::NamingContext_var naming_context_;
- // Naming context for the naming service.
+ /// helper class for getting access to Naming Service.
TAO_Naming_Client naming_server_;
- // helper class for getting access to Naming Service.
};
#define NOTIFIER_BIND_NAME "Notifier"
diff --git a/TAO/examples/Event_Comm/Supplier_Input_Handler.h b/TAO/examples/Event_Comm/Supplier_Input_Handler.h
index 706e4bc77b7..d7365cd5826 100644
--- a/TAO/examples/Event_Comm/Supplier_Input_Handler.h
+++ b/TAO/examples/Event_Comm/Supplier_Input_Handler.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// EventComm
-//
-// = FILENAME
-// Supplier_Input_Handler.h
-//
-// = DESCRIPTION
-// Handle input from the keyboard.
-//
-// = AUTHOR
-// Douglas C. Schmidt (schmidt@cs.wustl.edu) and
-// Pradeep Gore (pradeep@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier_Input_Handler.h
+ *
+ * $Id$
+ *
+ * Handle input from the keyboard.
+ *
+ *
+ * @author Douglas C. Schmidt (schmidt@cs.wustl.edu) and Pradeep Gore (pradeep@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_INPUT_HANDLER_H
#define SUPPLIER_INPUT_HANDLER_H
@@ -30,36 +26,38 @@
// Forward declaration.
class Notifier_Handler;
+/**
+ * @class Supplier_Input_Handler
+ *
+ * @brief Handles input events generated from a keyboard.
+ *
+ * The events are currently framed and forwarded to all Consumers.
+ * In the future, we will need to be more selective and only send
+ * to those Consumers whose filtering criteria matches!
+ */
class Supplier_Input_Handler : public ACE_Event_Handler
{
- // = TITLE
- // Handles input events generated from a keyboard.
- //
- // = DESCRIPTION
- // The events are currently framed and forwarded to all Consumers.
- // In the future, we will need to be more selective and only send
- // to those Consumers whose filtering criteria matches!
public:
// = Initialization and termination methods.
+ /// Constructor.
Supplier_Input_Handler (void);
- // Constructor.
+ /// Destructor.
~Supplier_Input_Handler (void);
- // Destructor.
+ /// Initialization.
int initialize (Notifier_Handler *);
- // Initialization.
+ /// Frame input events and notify <Consumers>.
virtual int handle_input (ACE_HANDLE);
- // Frame input events and notify <Consumers>.
+ /// Close down the handler.
int close (void);
- // Close down the handler.
protected:
+ /// Pointer to a <Notifier_Handler> that's used to inform Consumers
+ /// that events of interest have occurred.
Notifier_Handler *notifier_;
- // Pointer to a <Notifier_Handler> that's used to inform Consumers
- // that events of interest have occurred.
};
#endif /* SUPPLIER_INPUT_HANDLER_H */
diff --git a/TAO/examples/Event_Comm/notifier.h b/TAO/examples/Event_Comm/notifier.h
index ba1142977a7..eb4f1a2e5f7 100644
--- a/TAO/examples/Event_Comm/notifier.h
+++ b/TAO/examples/Event_Comm/notifier.h
@@ -1,46 +1,45 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/example/Event_Comm
-//
-// = FILENAME
-// notifier.h
-//
-// = DESCRIPTION
-// This class implements notifier driver for the Publish/Subscribe example
-//
-// = AUTHOR
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file notifier.h
+ *
+ * $Id$
+ *
+ * This class implements notifier driver for the Publish/Subscribe example
+ *
+ *
+ */
+//=============================================================================
+
+ /**
+ * @class Notifier
+ *
+ * @brief Notifier driver for the TAO Publish/Subscribe example.
+ *
+ * The driver class for the <Event_Comm::Notifier> object.
+ */
class Notifier : public ACE_Event_Handler
{
- // = TITLE
- // Notifier driver for the TAO Publish/Subscribe example.
- //
- // = DESCRIPTION
- // The driver class for the <Event_Comm::Notifier> object.
public:
// = Initialization and termination methods.
+ /// Constructor.
Notifier (int argc, ACE_TCHAR *argv[]);
- // Constructor.
+ /// Destructor.
~Notifier (void);
- // Destructor.
+ /// Execute the notifier.
void run (void);
- // Execute the notifier.
private:
+ /// Handle signals that shut us down.
virtual int handle_signal (int signum,
siginfo_t *,
ucontext_t *);
- // Handle signals that shut us down.
+ /// The notifier server.
Notifier_Server ns_;
- // The notifier server.
};
diff --git a/TAO/examples/Event_Comm/supplier.h b/TAO/examples/Event_Comm/supplier.h
index 06a45dfc44a..17bef85d580 100644
--- a/TAO/examples/Event_Comm/supplier.h
+++ b/TAO/examples/Event_Comm/supplier.h
@@ -1,56 +1,55 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/example/Event_Comm
-//
-// = FILENAME
-// supplier.h
-//
-// = DESCRIPTION
-// This class implements driver for the Publish/Subscribe example
-//
-// = AUTHOR
-//
-// ============================================================================
-
+//=============================================================================
+/**
+ * @file supplier.h
+ *
+ * $Id$
+ *
+ * This class implements driver for the Publish/Subscribe example
+ *
+ *
+ */
+//=============================================================================
+
+
+
+/**
+ * @class Supplier
+ *
+ * @brief Supplier driver for the TAO Publish/Subscribe example.
+ *
+ * This class starts up the <Supplier_Input_Handler> and
+ * <Notifier_Handler> objects.
+ */
class Supplier : public ACE_Event_Handler, public ShutdownCallback
{
- // = TITLE
- // Supplier driver for the TAO Publish/Subscribe example.
- //
- // = DESCRIPTION
- // This class starts up the <Supplier_Input_Handler> and
- // <Notifier_Handler> objects.
public:
// Initialization and Termination methods.
+ /// Constructor.
Supplier (void);
- // Constructor.
+ /// Destructor.
~Supplier (void);
- // Destructor.
+ /// Initialization method. returns 0 on success, -1 on error.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialization method. returns 0 on success, -1 on error.
+ /// Execute the supplier.
void run (void);
- // Execute the supplier.
+ /// Shutdown the application.
virtual void close (void);
- // Shutdown the application.
private:
+ /// Handle shutdown signals.
virtual int handle_signal (int signum,
siginfo_t *,
ucontext_t *);
- // Handle shutdown signals.
+ /// Handler for keyboard input.
Supplier_Input_Handler ih_;
- // Handler for keyboard input.
+ /// The notifier handler.
Notifier_Handler nh_;
- // The notifier handler.
};
diff --git a/TAO/examples/Kokyu_dsrt_schedulers/fp_example/test_i.h b/TAO/examples/Kokyu_dsrt_schedulers/fp_example/test_i.h
index c1fdefe2374..fa0ac967621 100644
--- a/TAO/examples/Kokyu_dsrt_schedulers/fp_example/test_i.h
+++ b/TAO/examples/Kokyu_dsrt_schedulers/fp_example/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/MT_Server
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_MT_SERVER_TEST_I_H
#define TAO_MT_SERVER_TEST_I_H
@@ -20,20 +17,21 @@
#include "tao/RTScheduling/RTScheduler_Manager.h"
#include "Task_Stats.h"
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public POA_Simple_Server
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb,
RTScheduling::Current_ptr current,
Task_Stats&,
int);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Long x);
@@ -41,11 +39,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
RTScheduling::Current_var current_;
Task_Stats& task_stats_;
int enable_yield_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/examples/Kokyu_dsrt_schedulers/mif_example/test_i.h b/TAO/examples/Kokyu_dsrt_schedulers/mif_example/test_i.h
index c1fdefe2374..fa0ac967621 100644
--- a/TAO/examples/Kokyu_dsrt_schedulers/mif_example/test_i.h
+++ b/TAO/examples/Kokyu_dsrt_schedulers/mif_example/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/MT_Server
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_MT_SERVER_TEST_I_H
#define TAO_MT_SERVER_TEST_I_H
@@ -20,20 +17,21 @@
#include "tao/RTScheduling/RTScheduler_Manager.h"
#include "Task_Stats.h"
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public POA_Simple_Server
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb,
RTScheduling::Current_ptr current,
Task_Stats&,
int);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Long x);
@@ -41,11 +39,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
RTScheduling::Current_var current_;
Task_Stats& task_stats_;
int enable_yield_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/examples/Kokyu_dsrt_schedulers/muf_example/test_i.h b/TAO/examples/Kokyu_dsrt_schedulers/muf_example/test_i.h
index c1fdefe2374..fa0ac967621 100644
--- a/TAO/examples/Kokyu_dsrt_schedulers/muf_example/test_i.h
+++ b/TAO/examples/Kokyu_dsrt_schedulers/muf_example/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/MT_Server
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_MT_SERVER_TEST_I_H
#define TAO_MT_SERVER_TEST_I_H
@@ -20,20 +17,21 @@
#include "tao/RTScheduling/RTScheduler_Manager.h"
#include "Task_Stats.h"
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public POA_Simple_Server
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb,
RTScheduling::Current_ptr current,
Task_Stats&,
int);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Long x);
@@ -41,11 +39,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
RTScheduling::Current_var current_;
Task_Stats& task_stats_;
int enable_yield_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/examples/Load_Balancing/Identity_Client.cpp b/TAO/examples/Load_Balancing/Identity_Client.cpp
index 3d663347fce..a5f07e70478 100644
--- a/TAO/examples/Load_Balancing/Identity_Client.cpp
+++ b/TAO/examples/Load_Balancing/Identity_Client.cpp
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Identity_Client.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_Client.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Identity_Client.h"
#include "IdentityC.h"
diff --git a/TAO/examples/Load_Balancing/Identity_Client.h b/TAO/examples/Load_Balancing/Identity_Client.h
index aa8123ad750..88c8d65e758 100644
--- a/TAO/examples/Load_Balancing/Identity_Client.h
+++ b/TAO/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_ */
diff --git a/TAO/examples/Load_Balancing/Identity_Server.cpp b/TAO/examples/Load_Balancing/Identity_Server.cpp
index 536436b2a58..483283e26d4 100644
--- a/TAO/examples/Load_Balancing/Identity_Server.cpp
+++ b/TAO/examples/Load_Balancing/Identity_Server.cpp
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Identity_Server.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_Server.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Identity_Server.h"
#include "Identity_i.h"
diff --git a/TAO/examples/Load_Balancing/Identity_Server.h b/TAO/examples/Load_Balancing/Identity_Server.h
index 59c064664ee..bf4f3396a15 100644
--- a/TAO/examples/Load_Balancing/Identity_Server.h
+++ b/TAO/examples/Load_Balancing/Identity_Server.h
@@ -1,22 +1,19 @@
-// $Id$
// -*- C++ -*-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Identity_Server.h
-//
-// = DESCRIPTION
-// Driver for identity server, which is used to test/demonstrate
-// the functionality of the Load Balancing service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_Server.h
+ *
+ * $Id$
+ *
+ * Driver for identity server, which is used to test/demonstrate
+ * the functionality of the Load Balancing service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IDENTITY_SERVER_H_
#define IDENTITY_SERVER_H_
@@ -28,55 +25,59 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Identity_Server
+ *
+ * Contacts the <Object_Group_Factory> in the Load Balancing Server
+ * to create two <Object_Group>s, one round robin and one random.
+ * Then, creates a number of <Identity> objects and registers them with
+ * the created <Object_Group>s in a manner specified by the
+ * commandline arguments.
+ */
class Identity_Server
{
- // =TITLE
- // Contacts the <Object_Group_Factory> in the Load Balancing Server
- // to create two <Object_Group>s, one round robin and one random.
- // Then, creates a number of <Identity> objects and registers them with
- // the created <Object_Group>s in a manner specified by the
- // commandline arguments.
- //
public:
+ /// Default constructor.
Identity_Server (void);
- // Default constructor.
+ /// Destructor.
~Identity_Server (void);
- // Destructor.
+ /// Performs all the initializations necessary before going into the
+ /// ORB event loop.
int init (int argc, ACE_TCHAR *argv[]);
- // Performs all the initializations necessary before going into the
- // ORB event loop.
+ /// Run the server.
int run (void);
- // Run the server.
private:
+ /// Parses the commandline arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the commandline arguments.
+ /**
+ * Creates the specified number of identity objects, and registers
+ * each one with the provided <Object_Group>. Identity servants are
+ * given names
+ *"Identity object 1" .... "Identity object <number_of_objects>".
+ */
void create_objects (size_t number_of_objects,
Load_Balancer::Object_Group_ptr group);
- // Creates the specified number of identity objects, and registers
- // each one with the provided <Object_Group>. Identity servants are
- // given names
- //"Identity object 1" .... "Identity object <number_of_objects>".
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// The ior of the <Object_Group_Factory> object we shall use to
+ /// create <Object_Group>s to load balance our <Identity> objects.
const ACE_TCHAR *group_factory_ior_;
- // The ior of the <Object_Group_Factory> object we shall use to
- // create <Object_Group>s to load balance our <Identity> objects.
+ /// Number of <Identity> objects to create for registering with
+ /// the random <Object_Group>. The default value is 5.
size_t random_objects_;
- // Number of <Identity> objects to create for registering with
- // the random <Object_Group>. The default value is 5.
+ /// Number of <Identity> objects to create for registering with the
+ /// round robin <Object_Group>. The default value is 5.
size_t rr_objects_;
- // Number of <Identity> objects to create for registering with the
- // round robin <Object_Group>. The default value is 5.
};
#endif /* IDENTITY_SERVER_H_ */
diff --git a/TAO/examples/Load_Balancing/Identity_i.cpp b/TAO/examples/Load_Balancing/Identity_i.cpp
index 72ed692d4b4..780b3f1ebe0 100644
--- a/TAO/examples/Load_Balancing/Identity_i.cpp
+++ b/TAO/examples/Load_Balancing/Identity_i.cpp
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Identity_i.cpp
-//
-// = DESCRIPTION
-// Implements the interface in Identity.idl.
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_i.cpp
+ *
+ * $Id$
+ *
+ * Implements the interface in Identity.idl.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Identity_i.h"
Identity_i::Identity_i (const char *name)
diff --git a/TAO/examples/Load_Balancing/Identity_i.h b/TAO/examples/Load_Balancing/Identity_i.h
index d6810cb9a7f..860828c7fed 100644
--- a/TAO/examples/Load_Balancing/Identity_i.h
+++ b/TAO/examples/Load_Balancing/Identity_i.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Identity_i.h
-//
-// = DESCRIPTION
-// Implements the interface in Identity.idl.
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_i.h
+ *
+ * $Id$
+ *
+ * Implements the interface in Identity.idl.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IDENTITY_I_H_
#define IDENTITY_I_H_
@@ -24,19 +24,19 @@ class Identity_i :
// This class implements Identity.idl interface.
public:
+ /// Constructor - initializes the name of this object.
Identity_i (const char *name);
- // Constructor - initializes the name of this object.
+ /// Destructor.
~Identity_i (void);
- // Destructor.
+ /// Returns the name of this object.
virtual void get_name (CORBA::String_out name);
- // Returns the name of this object.
private:
+ /// Stores the name of this object.
CORBA::String_var name_;
- // Stores the name of this object.
};
#endif /* IDENTITY_I_H_ */
diff --git a/TAO/examples/Load_Balancing/Load_Balancer_i.cpp b/TAO/examples/Load_Balancing/Load_Balancer_i.cpp
index 27e2648e5fc..55b7042bca5 100644
--- a/TAO/examples/Load_Balancing/Load_Balancer_i.cpp
+++ b/TAO/examples/Load_Balancing/Load_Balancer_i.cpp
@@ -1,13 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Load_Balancer_i.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancer_i.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Load_Balancer_i.h"
#include "ace/Auto_Ptr.h"
diff --git a/TAO/examples/Load_Balancing/Load_Balancer_i.h b/TAO/examples/Load_Balancing/Load_Balancer_i.h
index 79b9c8d73a9..6bbe455a259 100644
--- a/TAO/examples/Load_Balancing/Load_Balancer_i.h
+++ b/TAO/examples/Load_Balancing/Load_Balancer_i.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Load_Balancer_i.h
-//
-// = DESCRIPTION
-// Defines classes that implement interfaces in Load_Balancer.idl
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancer_i.h
+ *
+ * $Id$
+ *
+ * Defines classes that implement interfaces in Load_Balancer.idl
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef LOAD_BALANCER_I_H_
#define LOAD_BALANCER_I_H_
@@ -45,81 +45,97 @@ public:
// = Initialization and termination methods.
+ /// Constructor.
Object_Group_Factory_i (void);
- // Constructor.
+ /// Destructor.
~Object_Group_Factory_i (void);
- // Destructor.
// = Load_Balancer::Object_Group_Factory idl methods.
+ /**
+ * Creates an <Object_Group> that resolves requests for arbitrary
+ * members in round robin order. If an <Object_Group>, of any
+ * type, with Group_ID <id> has already been created by this
+ * factory, and hasn't been destroyed, a <duplicate_group>
+ * exception is thrown.
+ */
Load_Balancer::Object_Group_ptr make_round_robin (const char * id);
- // Creates an <Object_Group> that resolves requests for arbitrary
- // members in round robin order. If an <Object_Group>, of any
- // type, with Group_ID <id> has already been created by this
- // factory, and hasn't been destroyed, a <duplicate_group>
- // exception is thrown.
+ /**
+ * Creates an <Object_Group> that resolves requests for arbitrary
+ * members in random order. If an <Object_Group>, of any
+ * type, with Group_ID <id> has already been created by this
+ * factory, and hasn't been destroyed, a <duplicate_group>
+ * exception is thrown.
+ */
Load_Balancer::Object_Group_ptr make_random (const char * id);
- // Creates an <Object_Group> that resolves requests for arbitrary
- // members in random order. If an <Object_Group>, of any
- // type, with Group_ID <id> has already been created by this
- // factory, and hasn't been destroyed, a <duplicate_group>
- // exception is thrown.
+ /**
+ * Locates and returns an <Object_Group> by its <Group_ID>. If
+ * no <Object_Group> has <Group_ID> of <id>, throw a
+ * <no_such_group> exception.
+ */
Load_Balancer::Object_Group_ptr resolve (const char * id);
- // Locates and returns an <Object_Group> by its <Group_ID>. If
- // no <Object_Group> has <Group_ID> of <id>, throw a
- // <no_such_group> exception.
+ /**
+ * Lists all the round robin <Object_Group>s which were created
+ * by this factory, and haven't been destroyed yet, i.e., return
+ * a sequence of <Group_ID>s of all existing round robin
+ * <Object_Group>s created by this factory.
+ */
Load_Balancer::Group_List * round_robin_groups (void);
- // Lists all the round robin <Object_Group>s which were created
- // by this factory, and haven't been destroyed yet, i.e., return
- // a sequence of <Group_ID>s of all existing round robin
- // <Object_Group>s created by this factory.
+ /**
+ * Lists all the random <Object_Group>s which were created
+ * by this factory, and haven't been destroyed yet, i.e., return
+ * a sequence of <Group_ID>s of all existing random
+ * <Object_Group>s created by this factory.
+ */
Load_Balancer::Group_List * random_groups (void);
- // Lists all the random <Object_Group>s which were created
- // by this factory, and haven't been destroyed yet, i.e., return
- // a sequence of <Group_ID>s of all existing random
- // <Object_Group>s created by this factory.
// = Implementation detail methods.
+ /**
+ * This method is invoked by an <Object_Group> with group id <id> when it
+ * is being destroyed. The method removes entry corresponding to
+ * group <id> from <random_groups_> if <random> is 1 or from
+ * <rr_groups_> if <random> is 0. This recycles <id>, allowing it
+ * to be used for new <Object_Group>, and prevents the destroyed
+ * group from being included in lists returned from <random_groups>
+ * and <round_robin_groups> methods.
+ */
void remove_group (const ACE_CString &id, int random);
- // This method is invoked by an <Object_Group> with group id <id> when it
- // is being destroyed. The method removes entry corresponding to
- // group <id> from <random_groups_> if <random> is 1 or from
- // <rr_groups_> if <random> is 0. This recycles <id>, allowing it
- // to be used for new <Object_Group>, and prevents the destroyed
- // group from being included in lists returned from <random_groups>
- // and <round_robin_groups> methods.
private:
// = Helper methods.
+ /**
+ * This function factors out common code in <make_round_robin> and
+ * <make_random>. Creates a random <Object_Group> if <random> parameter is
+ * set to 1 and round robin <Object_Group> if it is 0.
+ */
Load_Balancer::Object_Group_ptr make_group (int random,
const char * id);
- // This function factors out common code in <make_round_robin> and
- // <make_random>. Creates a random <Object_Group> if <random> parameter is
- // set to 1 and round robin <Object_Group> if it is 0.
+ /**
+ * This function factors out common code in <random_groups> and
+ * <round_robin_groups>. Returns a sequence of its random
+ * groups if <random> parameter is set to 1 and a sequence of its
+ * round robin groups if it is 0.
+ */
Load_Balancer::Group_List * list_groups (int random);
- // This function factors out common code in <random_groups> and
- // <round_robin_groups>. Returns a sequence of its random
- // groups if <random> parameter is set to 1 and a sequence of its
- // round robin groups if it is 0.
+ /// Typedef for ease of use: hash map associating group ids to
+ /// <Object_Group> references.
typedef ACE_Hash_Map_Manager<ACE_CString,
Load_Balancer::Object_Group_var, ACE_Null_Mutex> HASH_MAP;
- // Typedef for ease of use: hash map associating group ids to
- // <Object_Group> references.
+ /// Map containing all random <Object_Group>s created by this factory.
HASH_MAP random_groups_;
- // Map containing all random <Object_Group>s created by this factory.
+ /// Map containing all round robin <Object_Group>s created by this factory.
HASH_MAP rr_groups_;
- // Map containing all round robin <Object_Group>s created by this factory.
};
class Object_Group_i : public virtual POA_Load_Balancer::Object_Group
@@ -140,63 +156,73 @@ public:
// = Initialization and termination methods.
+ /// Constructor.
Object_Group_i (const char * id,
Object_Group_Factory_i * my_factory);
- // Constructor.
+ /// Destructor.
~Object_Group_i (void);
- // Destructor.
// = Load_Balancer::Object_Group idl methods.
+ /// Get group's id.
char * id (void);
- // Get group's id.
+ /**
+ * Adds a new <member> to the <Object_Group>. Note that each
+ * <Member_ID> in an <Object_Group> must be unique. If the
+ * group already contains a member with the same <Member_ID>, a
+ * <duplicate_member> exceptions is thrown.
+ */
void bind (const Load_Balancer::Member & member);
- // Adds a new <member> to the <Object_Group>. Note that each
- // <Member_ID> in an <Object_Group> must be unique. If the
- // group already contains a member with the same <Member_ID>, a
- // <duplicate_member> exceptions is thrown.
+ /**
+ * Removes a member with the specified <Member_ID> from the
+ * <Object_Group>. If none of the group's members have a
+ * Member_ID of <id>, <no_such_member> exception is thrown.
+ */
void unbind (const char * id);
- // Removes a member with the specified <Member_ID> from the
- // <Object_Group>. If none of the group's members have a
- // Member_ID of <id>, <no_such_member> exception is thrown.
+ /**
+ * Returns a member object from this <Object_Group> in accordance with
+ * load balancing policy it implements, i.e., ``random'' or
+ * ``round robin.'' If the group contains no members, <no_such_member>
+ * exception is thrown.
+ */
CORBA::Object_ptr resolve (void)
= 0;
- // Returns a member object from this <Object_Group> in accordance with
- // load balancing policy it implements, i.e., ``random'' or
- // ``round robin.'' If the group contains no members, <no_such_member>
- // exception is thrown.
+ /**
+ * Returns an object with the specified <Member_ID>. If this
+ * <Object_Group> contains no members with the specified
+ * <Member_ID>, <no_such_member> exception is thrown.
+ */
CORBA::Object_ptr resolve_with_id (const char * id);
- // Returns an object with the specified <Member_ID>. If this
- // <Object_Group> contains no members with the specified
- // <Member_ID>, <no_such_member> exception is thrown.
+ /// Return a sequence of <Member_ID>s of all of its members.
Load_Balancer::Member_ID_List * members (void);
- // Return a sequence of <Member_ID>s of all of its members.
+ /**
+ * Cleanup the resources associated with this <Object_Group>.
+ * Subsequent calls to this <Object_Group> should fail, and its
+ * <id> should become available. <Object_Group_Factory>
+ * should no longer list this <Object_Group>.
+ */
void destroy (void);
- // Cleanup the resources associated with this <Object_Group>.
- // Subsequent calls to this <Object_Group> should fail, and its
- // <id> should become available. <Object_Group_Factory>
- // should no longer list this <Object_Group>.
protected:
+ /// Typedefs for ease of use.
typedef ACE_DLList<ACE_CString> LIST;
typedef ACE_DLList_Iterator<ACE_CString> ITERATOR;
typedef ACE_Hash_Map_Manager<ACE_CString, CORBA::Object_var,
ACE_Null_Mutex> HASH_MAP;
- // Typedefs for ease of use.
+ /// List of ids of all the members of this group.
LIST member_id_list_;
- // List of ids of all the members of this group.
+ /// Mapping of member_id to obj for all the members of this group.
HASH_MAP members_;
- // Mapping of member_id to obj for all the members of this group.
// Note, we store information redundantly in this implementation,
// i.e., both <member_id_list_> and <members_> store member ids.
@@ -205,78 +231,90 @@ protected:
// variations of <resolve> method to implement different policies.
// <members_> is useful for doing id-based look-up.
+ /// This group's id.
ACE_CString id_;
- // This group's id.
+ /**
+ * Pointer to the <Object_Group_Factory> servant, which created this
+ * <Object_Group> servant. We need this pointer to be able to
+ * notify the factory when this <Object_Group> is destroyed. Upon
+ * notification, the factory can update its records and release
+ * resources as necessary.
+ */
Object_Group_Factory_i *my_factory_;
- // Pointer to the <Object_Group_Factory> servant, which created this
- // <Object_Group> servant. We need this pointer to be able to
- // notify the factory when this <Object_Group> is destroyed. Upon
- // notification, the factory can update its records and release
- // resources as necessary.
};
+/**
+ * @class Random_Object_Group
+ *
+ * @brief This class implements <Object_Group> idl interface with the
+ * random policy for <resolve>.
+ */
class Random_Object_Group : public Object_Group_i
{
- // = TITLE
- // This class implements <Object_Group> idl interface with the
- // random policy for <resolve>.
- //
public:
+ /// Constructor.
Random_Object_Group (const char *id,
Object_Group_Factory_i *my_factory);
- // Constructor.
+ /// Destructor.
~Random_Object_Group (void);
- // Destructor.
+ /// Returns a member object from this <Object_Group> in accordance with
+ /// the "random" load balancing policy.
CORBA::Object_ptr resolve (void);
- // Returns a member object from this <Object_Group> in accordance with
- // the "random" load balancing policy.
+ /**
+ * Cleanup the resources associated with this <Object_Group>.
+ * Subsequent calls to this <Object_Group> should fail, and its
+ * <id> should become available. <Object_Group_Factory>
+ * should no longer list this <Object_Group>.
+ */
void destroy (void);
- // Cleanup the resources associated with this <Object_Group>.
- // Subsequent calls to this <Object_Group> should fail, and its
- // <id> should become available. <Object_Group_Factory>
- // should no longer list this <Object_Group>.
};
+/**
+ * @class RR_Object_Group:
+ *
+ * @brief This class implements <Object_Group> idl interface with the
+ * round robin policy for <resolve>.
+ */
class RR_Object_Group: public Object_Group_i
{
- // = TITLE
- // This class implements <Object_Group> idl interface with the
- // round robin policy for <resolve>.
- //
public:
+ /// Constructor.
RR_Object_Group (const char *id,
Object_Group_Factory_i *my_factory);
- // Constructor.
+ /// Destructor.
~RR_Object_Group (void);
- // Destructor.
+ /**
+ * We need to override the implementation of <unbind> from
+ * Object_Group_i to make sure <resolve>
+ * works correctly.
+ */
void unbind (const char * id);
- // We need to override the implementation of <unbind> from
- // Object_Group_i to make sure <resolve>
- // works correctly.
+ /// Returns a member object from this <Object_Group> in accordance with
+ /// the "round robin" load balancing policy.
CORBA::Object_ptr resolve (void);
- // Returns a member object from this <Object_Group> in accordance with
- // the "round robin" load balancing policy.
+ /**
+ * Cleanup the resources associated with this <Object_Group>.
+ * Subsequent calls to this <Object_Group> should fail, and its
+ * <id> should become available. <Object_Group_Factory>
+ * should no longer list this <Object_Group>.
+ */
void destroy (void);
- // Cleanup the resources associated with this <Object_Group>.
- // Subsequent calls to this <Object_Group> should fail, and its
- // <id> should become available. <Object_Group_Factory>
- // should no longer list this <Object_Group>.
private:
+ /// Index into the Object_Group_i::member_id_list_: keeps track of
+ /// the member_id to return on the next invocation of <resolve>.
size_t next_;
- // Index into the Object_Group_i::member_id_list_: keeps track of
- // the member_id to return on the next invocation of <resolve>.
};
#endif /* LOAD_BALANCER_I_H_ */
diff --git a/TAO/examples/Load_Balancing/Load_Balancing_Service.cpp b/TAO/examples/Load_Balancing/Load_Balancing_Service.cpp
index ad4264ba54e..cfc79e888bf 100644
--- a/TAO/examples/Load_Balancing/Load_Balancing_Service.cpp
+++ b/TAO/examples/Load_Balancing/Load_Balancing_Service.cpp
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Load_Balancing_Service.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancing_Service.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Load_Balancing_Service.h"
#include "Load_Balancer_i.h"
diff --git a/TAO/examples/Load_Balancing/Load_Balancing_Service.h b/TAO/examples/Load_Balancing/Load_Balancing_Service.h
index db4c2373723..eb529215889 100644
--- a/TAO/examples/Load_Balancing/Load_Balancing_Service.h
+++ b/TAO/examples/Load_Balancing/Load_Balancing_Service.h
@@ -1,21 +1,18 @@
-// $Id$
// -*- C++ -*-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Load_Balancing_Service.h
-//
-// = DESCRIPTION
-// Driver for Load Balancing service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancing_Service.h
+ *
+ * $Id$
+ *
+ * Driver for Load Balancing service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef LOAD_BALANCING_SERVICE_H_
#define LOAD_BALANCING_SERVICE_H_
@@ -26,36 +23,39 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Load_Balancing_Service
+ *
+ * Server, which creates and initializes a
+ * <Load_Balancer::Object_Group_Factory>
+ * object, and runs the orb loop.
+ */
class Load_Balancing_Service
{
- // =TITLE
- // Server, which creates and initializes a
- // <Load_Balancer::Object_Group_Factory>
- // object, and runs the orb loop.
public:
+ /// Default constructor.
Load_Balancing_Service (void);
- // Default constructor.
+ /// Destructor.
~Load_Balancing_Service (void);
- // Destructor.
+ /// Initialize the <Load_Balancing_Service>: initializes the ORB, parses
+ /// arguments, creates a servant ...
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the <Load_Balancing_Service>: initializes the ORB, parses
- // arguments, creates a servant ...
+ /// Run the server.
int run (void);
- // Run the server.
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.
+ /// File to output the <Object_Group_Factory> IOR.
FILE *ior_output_file_;
- // File to output the <Object_Group_Factory> IOR.
};
#endif /* LOAD_BALANCING_SERVICE_H_ */
diff --git a/TAO/examples/Load_Balancing_persistent/Identity_Client.cpp b/TAO/examples/Load_Balancing_persistent/Identity_Client.cpp
index a0b47c5629a..c043de769f1 100644
--- a/TAO/examples/Load_Balancing_persistent/Identity_Client.cpp
+++ b/TAO/examples/Load_Balancing_persistent/Identity_Client.cpp
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Identity_Client.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_Client.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Identity_Client.h"
#include "IdentityC.h"
diff --git a/TAO/examples/Load_Balancing_persistent/Identity_Client.h b/TAO/examples/Load_Balancing_persistent/Identity_Client.h
index 98d07d4a9f6..45bacd56696 100644
--- a/TAO/examples/Load_Balancing_persistent/Identity_Client.h
+++ b/TAO/examples/Load_Balancing_persistent/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>
-// with modifications by Bala Natarajan <bala@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> with modifications by Bala Natarajan <bala@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
+ =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.
+ */
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.
int iterations_;
};
diff --git a/TAO/examples/Load_Balancing_persistent/Identity_Server.h b/TAO/examples/Load_Balancing_persistent/Identity_Server.h
index 711bbd17e89..36f902015cf 100644
--- a/TAO/examples/Load_Balancing_persistent/Identity_Server.h
+++ b/TAO/examples/Load_Balancing_persistent/Identity_Server.h
@@ -1,22 +1,19 @@
-// $Id$
// -*- C++ -*-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Identity_Server.h
-//
-// = DESCRIPTION
-// Driver for identity server, which is used to test/demonstrate
-// the functionality of the Load Balancing service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-// with modifications by Bala Natarajan <bala@cs.wustl.edu>
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_Server.h
+ *
+ * $Id$
+ *
+ * Driver for identity server, which is used to test/demonstrate
+ * the functionality of the Load Balancing service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu> with modifications by Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IDENTITY_SERVER_H_
#define IDENTITY_SERVER_H_
@@ -28,61 +25,65 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Identity_Server
+ =TITLE
+ * Contacts the <Object_Group_Factory> in the Load Balancing Server
+ * to create two <Object_Group>s, one round robin and one random.
+ * Then, creates a number of <Identity> objects and registers them with
+ * the created <Object_Group>s in a manner specified by the
+ * commandline arguments.
+ */
class Identity_Server
{
- // =TITLE
- // Contacts the <Object_Group_Factory> in the Load Balancing Server
- // to create two <Object_Group>s, one round robin and one random.
- // Then, creates a number of <Identity> objects and registers them with
- // the created <Object_Group>s in a manner specified by the
- // commandline arguments.
- //
public:
+ /// Default constructor.
Identity_Server (void);
- // Default constructor.
+ /// Destructor.
~Identity_Server (void);
- // Destructor.
+ /// Parses the commandline arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the commandline arguments.
+ /// Performs all the initializations necessary before going into the
+ /// ORB event loop.
int init (int argc, ACE_TCHAR *argv[]);
- // Performs all the initializations necessary before going into the
- // ORB event loop.
int register_groups (void);
+ /// Run the server.
int run (void);
- // Run the server.
private:
+ /**
+ * Creates the specified number of identity objects, and registers
+ * each one with the provided <Object_Group>. Identity servants are
+ * given names
+ *"Identity object 1" .... "Identity object <number_of_objects>".
+ */
void create_objects (size_t number_of_objects,
Load_Balancer::Object_Group_ptr group);
- // Creates the specified number of identity objects, and registers
- // each one with the provided <Object_Group>. Identity servants are
- // given names
- //"Identity object 1" .... "Identity object <number_of_objects>".
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// The ior of the <Object_Group_Factory> object we shall use to
+ /// create <Object_Group>s to load balance our <Identity> objects.
const ACE_TCHAR *group_factory_ior_;
- // The ior of the <Object_Group_Factory> object we shall use to
- // create <Object_Group>s to load balance our <Identity> objects.
+ /// Number of <Identity> objects to create for registering with
+ /// the random <Object_Group>. The default value is 5.
size_t random_objects_;
- // Number of <Identity> objects to create for registering with
- // the random <Object_Group>. The default value is 5.
+ /// Number of <Identity> objects to create for registering with the
+ /// round robin <Object_Group>. The default value is 5.
size_t rr_objects_;
- // Number of <Identity> objects to create for registering with the
- // round robin <Object_Group>. The default value is 5.
PortableServer::POA_var persistent_POA_;
};
diff --git a/TAO/examples/Load_Balancing_persistent/Identity_i.cpp b/TAO/examples/Load_Balancing_persistent/Identity_i.cpp
index c71e4c8f293..f1a5a021aad 100644
--- a/TAO/examples/Load_Balancing_persistent/Identity_i.cpp
+++ b/TAO/examples/Load_Balancing_persistent/Identity_i.cpp
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Identity_i.cpp
-//
-// = DESCRIPTION
-// Implements the interface in Identity.idl.
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_i.cpp
+ *
+ * $Id$
+ *
+ * Implements the interface in Identity.idl.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Identity_i.h"
Identity_i::Identity_i (const char *name,
diff --git a/TAO/examples/Load_Balancing_persistent/Identity_i.h b/TAO/examples/Load_Balancing_persistent/Identity_i.h
index 100750ee4e8..3c8c2a5992f 100644
--- a/TAO/examples/Load_Balancing_persistent/Identity_i.h
+++ b/TAO/examples/Load_Balancing_persistent/Identity_i.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Identity_i.h
-//
-// = DESCRIPTION
-// Implements the interface in Identity.idl.
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-// with modifications by Bala Natarajan <bala@cs.wustl.edu>
-// ============================================================================
+//=============================================================================
+/**
+ * @file Identity_i.h
+ *
+ * $Id$
+ *
+ * Implements the interface in Identity.idl.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu> with modifications by Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IDENTITY_I_H_
#define IDENTITY_I_H_
@@ -24,24 +24,24 @@ class Identity_i :
// This class implements Identity.idl interface.
public:
+ /// Constructor - initializes the name of this object.
Identity_i (const char *name,
PortableServer::POA_ptr poa);
- // Constructor - initializes the name of this object.
+ /// Destructor.
~Identity_i (void);
- // Destructor.
+ /// Returns the name of this object.
virtual void get_name (CORBA::String_out name);
- // Returns the name of this object.
+ /// Method for the POA that will return the persistent POA_ptr stored
+ /// in here..
PortableServer::POA_ptr _default_POA (void);
- // Method for the POA that will return the persistent POA_ptr stored
- // in here..
private:
+ /// Stores the name of this object.
CORBA::String_var name_;
- // Stores the name of this object.
PortableServer::POA_var poa_;
};
diff --git a/TAO/examples/Load_Balancing_persistent/Load_Balancer_i.h b/TAO/examples/Load_Balancing_persistent/Load_Balancer_i.h
index 261f5e2f323..a27519e9259 100644
--- a/TAO/examples/Load_Balancing_persistent/Load_Balancer_i.h
+++ b/TAO/examples/Load_Balancing_persistent/Load_Balancer_i.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Load_Balancer_i.h
-//
-// = DESCRIPTION
-// Defines classes that implement interfaces in Load_Balancer.idl
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-// with modifications by Bala Natarajan <bala@cs.wustl.edu>
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancer_i.h
+ *
+ * $Id$
+ *
+ * Defines classes that implement interfaces in Load_Balancer.idl
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu> with modifications by Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef LOAD_BALANCER_I_H_
#define LOAD_BALANCER_I_H_
@@ -54,103 +54,119 @@ public:
// = Initialization and termination methods.
+ /// Constructor.
Object_Group_Factory_i (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor.
+ /// Destructor.
~Object_Group_Factory_i (void);
- // Destructor.
+ /// Method for the POA that will return the persistent POA_ptr stored
+ /// in here..
PortableServer::POA_ptr _default_POA (void);
- // Method for the POA that will return the persistent POA_ptr stored
- // in here..
// = Load_Balancer::Object_Group_Factory idl methods.
+ /**
+ * Creates an <Object_Group> that resolves requests for arbitrary
+ * members in round robin order. If an <Object_Group>, of any
+ * type, with Group_ID <id> has already been created by this
+ * factory, and hasn't been destroyed, a <duplicate_group>
+ * exception is thrown.
+ */
Load_Balancer::Object_Group_ptr make_round_robin (const char * id);
- // Creates an <Object_Group> that resolves requests for arbitrary
- // members in round robin order. If an <Object_Group>, of any
- // type, with Group_ID <id> has already been created by this
- // factory, and hasn't been destroyed, a <duplicate_group>
- // exception is thrown.
void unbind_round_robin (const char *id);
+ /**
+ * Creates an <Object_Group> that resolves requests for arbitrary
+ * members in random order. If an <Object_Group>, of any
+ * type, with Group_ID <id> has already been created by this
+ * factory, and hasn't been destroyed, a <duplicate_group>
+ * exception is thrown.
+ */
Load_Balancer::Object_Group_ptr make_random (const char * id);
- // Creates an <Object_Group> that resolves requests for arbitrary
- // members in random order. If an <Object_Group>, of any
- // type, with Group_ID <id> has already been created by this
- // factory, and hasn't been destroyed, a <duplicate_group>
- // exception is thrown.
void unbind_random (const char *id);
+ /**
+ * Locates and returns an <Object_Group IOR> by its <Group_ID>. If
+ * no <Object_Group> has <Group_ID> of <id>, throw a
+ * <no_such_group> exception.
+ */
Load_Balancer::Object_Group_ptr resolve (const char * id);
- // Locates and returns an <Object_Group IOR> by its <Group_ID>. If
- // no <Object_Group> has <Group_ID> of <id>, throw a
- // <no_such_group> exception.
+ /**
+ * Lists all the round robin <Object_Group>s which were created
+ * by this factory, and haven't been destroyed yet, i.e., return
+ * a sequence of <Group_ID>s of all existing round robin
+ * <Object_Group>s created by this factory.
+ */
Load_Balancer::Group_List * round_robin_groups (void);
- // Lists all the round robin <Object_Group>s which were created
- // by this factory, and haven't been destroyed yet, i.e., return
- // a sequence of <Group_ID>s of all existing round robin
- // <Object_Group>s created by this factory.
+ /**
+ * Lists all the random <Object_Group>s which were created
+ * by this factory, and haven't been destroyed yet, i.e., return
+ * a sequence of <Group_ID>s of all existing random
+ * <Object_Group>s created by this factory.
+ */
Load_Balancer::Group_List * random_groups (void);
- // Lists all the random <Object_Group>s which were created
- // by this factory, and haven't been destroyed yet, i.e., return
- // a sequence of <Group_ID>s of all existing random
- // <Object_Group>s created by this factory.
private:
+ /// Our ORB
CORBA::ORB_var orb_;
- // Our ORB
+ /// Our POA
PortableServer::POA_var poa_;
- // Our POA
// = Helper methods.
+ /**
+ * This function factors out common code in <make_round_robin> and
+ * <make_random>. Creates a random <Object_Group> if <random> parameter is
+ * set to 1 and round robin <Object_Group> if it is 0.
+ */
Load_Balancer::Object_Group_ptr make_group (int random,
const char * id);
- // This function factors out common code in <make_round_robin> and
- // <make_random>. Creates a random <Object_Group> if <random> parameter is
- // set to 1 and round robin <Object_Group> if it is 0.
+ /**
+ * This function factors out common code in <random_groups> and
+ * <round_robin_groups>. Returns a sequence of its random
+ * groups if <random> parameter is set to 1 and a sequence of its
+ * round robin groups if it is 0.
+ */
Load_Balancer::Group_List * list_groups (int random);
- // This function factors out common code in <random_groups> and
- // <round_robin_groups>. Returns a sequence of its random
- // groups if <random> parameter is set to 1 and a sequence of its
- // round robin groups if it is 0.
+ /// The helper that updates the vlaue of the variable flags_
void update_flags (int random);
- // The helper that updates the vlaue of the variable flags_
+ /// This rolls back the status of the objects in the POA if the
+ /// service had failed..
void update_objects (void);
- // This rolls back the status of the objects in the POA if the
- // service had failed..
+ /// Map containing all random <Object_Group>s created by this factory.
HASH_MAP *random_groups_;
- // Map containing all random <Object_Group>s created by this factory.
+ /// Map containing all round robin <Object_Group>s created by this factory.
HASH_MAP *rr_groups_;
- // Map containing all round robin <Object_Group>s created by this factory.
+ /// Memory pool that will have the data
ALLOCATOR *mem_pool_;
- // Memory pool that will have the data
+ /**
+ * This would be kind of a hack.. As I am not able to think of
+ * anything at present let us live with this.. OK.. Here is how it
+ * works.. This value will be stored in the MMAP file. If the value
+ * is 1 then the Round Robin group object is registered with the
+ * Services POA. If the value is 2 then the Random group object is
+ * registered with the POA. If the value is 3 both of them are
+ * registered with the POA.. The initial value would be 0 when this
+ * object initialises and binded as "FLAGS"..
+ */
CORBA::Short *flags_;
- // This would be kind of a hack.. As I am not able to think of
- // anything at present let us live with this.. OK.. Here is how it
- // works.. This value will be stored in the MMAP file. If the value
- // is 1 then the Round Robin group object is registered with the
- // Services POA. If the value is 2 then the Random group object is
- // registered with the POA. If the value is 3 both of them are
- // registered with the POA.. The initial value would be 0 when this
- // object initialises and binded as "FLAGS"..
ACE_Throughput_Stats throughput_;
@@ -175,12 +191,12 @@ public:
// = Initialization and termination methods.
+ /// Constructor.
Object_Group_i (const char * id,
PortableServer::POA_ptr poa);
- // Constructor.
+ /// Destructor.
~Object_Group_i (void);
- // Destructor.
// Persistent POA
// Method for the POA
@@ -188,59 +204,69 @@ public:
// = Load_Balancer::Object_Group idl methods.
+ /// Get group's id.
char * id (void);
- // Get group's id.
+ /**
+ * Adds a new <member> to the <Object_Group>. Note that each
+ * <Member_ID> in an <Object_Group> must be unique. If the
+ * group already contains a member with the same <Member_ID>, a
+ * <duplicate_member> exceptions is thrown.
+ */
void bind (const Load_Balancer::Member & member);
- // Adds a new <member> to the <Object_Group>. Note that each
- // <Member_ID> in an <Object_Group> must be unique. If the
- // group already contains a member with the same <Member_ID>, a
- // <duplicate_member> exceptions is thrown.
+ /**
+ * Removes a member with the specified <Member_ID> from the
+ * <Object_Group>. If none of the group's members have a
+ * Member_ID of <id>, <no_such_member> exception is thrown.
+ */
void unbind (const char * id);
- // Removes a member with the specified <Member_ID> from the
- // <Object_Group>. If none of the group's members have a
- // Member_ID of <id>, <no_such_member> exception is thrown.
+ /**
+ * Returns a member object from this <Object_Group> in accordance with
+ * load balancing policy it implements, i.e., ``random'' or
+ * ``round robin.'' If the group contains no members, <no_such_member>
+ * exception is thrown.
+ */
char * resolve (void)
= 0;
- // Returns a member object from this <Object_Group> in accordance with
- // load balancing policy it implements, i.e., ``random'' or
- // ``round robin.'' If the group contains no members, <no_such_member>
- // exception is thrown.
+ /**
+ * Returns an object with the specified <Member_ID>. If this
+ * <Object_Group> contains no members with the specified
+ * <Member_ID>, <no_such_member> exception is thrown.
+ */
char * resolve_with_id (const char * id);
- // Returns an object with the specified <Member_ID>. If this
- // <Object_Group> contains no members with the specified
- // <Member_ID>, <no_such_member> exception is thrown.
+ /// Return a sequence of <Member_ID>s of all of its members.
Load_Balancer::Member_ID_List * members (void);
- // Return a sequence of <Member_ID>s of all of its members.
+ /**
+ * Cleanup the resources associated with this <Object_Group>.
+ * Subsequent calls to this <Object_Group> should fail, and its
+ * <id> should become available. <Object_Group_Factory>
+ * should no longer list this <Object_Group>.
+ */
void destroy (void);
- // Cleanup the resources associated with this <Object_Group>.
- // Subsequent calls to this <Object_Group> should fail, and its
- // <id> should become available. <Object_Group_Factory>
- // should no longer list this <Object_Group>.
protected:
+ /// This will replenish all the pointers that could have been lost
+ /// because of failure
void read_from_memory (void);
- // This will replenish all the pointers that could have been lost
- // because of failure
+ /// Our POA
PortableServer::POA_var poa_;
- // Our POA
+ /// Typedefs for ease of use.
typedef ACE_DLList<char *> LIST;
typedef ACE_DLList_Iterator<char *> ITERATOR;
- // Typedefs for ease of use.
+ /// List of ids of all the members of this group.
LIST *member_id_list_;
- // List of ids of all the members of this group.
+ /// Mapping of member_id to obj for all the members of this group.
HASH_MAP *members_;
- // Mapping of member_id to obj for all the members of this group.
// Note, we store information redundantly in this implementation,
// i.e., both <member_id_list_> and <members_> store member ids.
@@ -249,57 +275,63 @@ protected:
// variations of <resolve> method to implement different policies.
// <members_> is useful for doing id-based look-up.
+ /// This group's id.
ACE_CString id_;
- // This group's id.
+ /// Pointer to the location where I can allocate memory...
ALLOCATOR *allocator_;
- // Pointer to the location where I can allocate memory...
};
+/**
+ * @class Random_Object_Group
+ *
+ * @brief This class implements <Object_Group> idl interface with the
+ * random policy for <resolve>.
+ */
class Random_Object_Group : public Object_Group_i
{
- // = TITLE
- // This class implements <Object_Group> idl interface with the
- // random policy for <resolve>.
- //
public:
+ /// Constructor.
Random_Object_Group (const char *id,
PortableServer::POA_ptr poa);
- // Constructor.
+ /// Returns a member object from this <Object_Group> in accordance with
+ /// the "random" load balancing policy.
char * resolve (void);
- // Returns a member object from this <Object_Group> in accordance with
- // the "random" load balancing policy.
};
+/**
+ * @class RR_Object_Group:
+ *
+ * @brief This class implements <Object_Group> idl interface with the
+ * round robin policy for <resolve>.
+ */
class RR_Object_Group: public Object_Group_i
{
- // = TITLE
- // This class implements <Object_Group> idl interface with the
- // round robin policy for <resolve>.
- //
public:
+ /// Constructor.
RR_Object_Group (const char *id,
PortableServer::POA_ptr poa);
- // Constructor.
+ /**
+ * We need to override the implementation of <unbind> from
+ * Object_Group_i to make sure <resolve>
+ * works correctly.
+ */
void unbind (const char * id);
- // We need to override the implementation of <unbind> from
- // Object_Group_i to make sure <resolve>
- // works correctly.
+ /// Returns a member object from this <Object_Group> in accordance with
+ /// the "round robin" load balancing policy.
char * resolve (void);
- // Returns a member object from this <Object_Group> in accordance with
- // the "round robin" load balancing policy.
private:
+ /// Index into the Object_Group_i::member_id_list_: keeps track of
+ /// the member_id to return on the next invocation of <resolve>.
size_t next_;
- // Index into the Object_Group_i::member_id_list_: keeps track of
- // the member_id to return on the next invocation of <resolve>.
};
#endif /* LOAD_BALANCER_I_H_ */
diff --git a/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.cpp b/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.cpp
index 72d0fd3a71b..365823b3eda 100644
--- a/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.cpp
+++ b/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.cpp
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Load_Balancing_Service.cpp
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancing_Service.cpp
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Load_Balancing_Service.h"
#include "Load_Balancer_i.h"
diff --git a/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.h b/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.h
index f855506d106..bfec42f33f2 100644
--- a/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.h
+++ b/TAO/examples/Load_Balancing_persistent/Load_Balancing_Service.h
@@ -1,21 +1,18 @@
-// $Id$
// -*- C++ -*-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Load_Balancing
-//
-// = FILENAME
-// Load_Balancing_Service.h
-//
-// = DESCRIPTION
-// Driver for Load Balancing service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-// with modifications by Bala Natarajan <bala@cs.wustl.edu>
-// ============================================================================
+//=============================================================================
+/**
+ * @file Load_Balancing_Service.h
+ *
+ * $Id$
+ *
+ * Driver for Load Balancing service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu> with modifications by Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef LOAD_BALANCING_SERVICE_H_
#define LOAD_BALANCING_SERVICE_H_
@@ -26,36 +23,39 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Load_Balancing_Service
+ *
+ * Server, which creates and initializes a
+ * <Load_Balancer::Object_Group_Factory>
+ * object, and runs the orb loop.
+ */
class Load_Balancing_Service
{
- // =TITLE
- // Server, which creates and initializes a
- // <Load_Balancer::Object_Group_Factory>
- // object, and runs the orb loop.
public:
+ /// Default constructor.
Load_Balancing_Service (void);
- // Default constructor.
+ /// Destructor.
~Load_Balancing_Service (void);
- // Destructor.
+ /// Initialize the <Load_Balancing_Service>: initializes the ORB, parses
+ /// arguments, creates a servant ...
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the <Load_Balancing_Service>: initializes the ORB, parses
- // arguments, creates a servant ...
+ /// Run the server.
int run (void);
- // Run the server.
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.
+ /// File to output the <Object_Group_Factory> IOR.
FILE *ior_output_file_;
- // File to output the <Object_Group_Factory> IOR.
};
#endif /* LOAD_BALANCING_SERVICE_H_ */
diff --git a/TAO/examples/Logging/Logger_i.h b/TAO/examples/Logging/Logger_i.h
index d5a5a36cc5e..24850228c14 100644
--- a/TAO/examples/Logging/Logger_i.h
+++ b/TAO/examples/Logging/Logger_i.h
@@ -1,21 +1,17 @@
// -*- C++ -*-
-// ============================================================================
-//
-// $Id$
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// Logger_i.h
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>,
-// Sergio Flores-Gaitan <sergio@cs.wustl.edu>, and
-// Matthew Braun <mjb2@cec.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Logger_i.h
+ *
+ * $Id$
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ * @author Sergio Flores-Gaitan <sergio@cs.wustl.edu>
+ * @author and Matthew Braun <mjb2@cec.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_ORBSVCS_LOGGER_I_H
#define TAO_ORBSVCS_LOGGER_I_H
@@ -25,76 +21,88 @@
#include "ace/SString.h"
#include "ace/Null_Mutex.h"
+/**
+ * @class Logger_i
+ *
+ * @brief Used to log messages to a logging server.
+ */
class Logger_i : public virtual POA_Logger
{
- // = TITLE
- // Used to log messages to a logging server.
public:
+ /// constructor
Logger_i (const char* name);
- // constructor
+ /// destructor
virtual ~Logger_i (void);
- // destructor
+ /// Writes the <log_rec> to the standard output.
virtual void log (const Logger::Log_Record &log_rec);
- // Writes the <log_rec> to the standard output.
+ /// Writes the <log_rec> to the standard output with the given
+ /// verbosity level
virtual void logv (const Logger::Log_Record &log_rec,
Logger::Verbosity_Level verbosity);
- // Writes the <log_rec> to the standard output with the given
- // verbosity level
+ /// Writes the <log_rec> to the standard output.
virtual void log_twoway (const Logger::Log_Record &log_rec);
- // Writes the <log_rec> to the standard output.
+ /// Writes the <log_rec> to the standard output with the given
+ /// verbosity level
virtual void logv_twoway (const Logger::Log_Record &log_rec,
Logger::Verbosity_Level verbosity);
- // Writes the <log_rec> to the standard output with the given
- // verbosity level
+ /// Sets the verbosity level. Valid values are {VERBOSE, VERBOSE_LITE
+ /// and SILENT}. Defaults to VERBOSE
void verbosity (Logger::Verbosity_Level level);
- // Sets the verbosity level. Valid values are {VERBOSE, VERBOSE_LITE
- // and SILENT}. Defaults to VERBOSE
private:
+ /// Converts the IDL defined <Log_Priority> enum type to the
+ /// <ACE_Log_Priority> enum type.
ACE_Log_Priority priority_conversion (Logger::Log_Priority priority);
- // Converts the IDL defined <Log_Priority> enum type to the
- // <ACE_Log_Priority> enum type.
+ /**
+ * Converts the IDL defined <Verbosity_Level> enum type to a u_long,
+ * which is used by the <ACE_Log_Record> to distinguish the
+ * level of verbosity.
+ */
u_long verbosity_conversion (Logger::Verbosity_Level verbosity_level);
- // Converts the IDL defined <Verbosity_Level> enum type to a u_long,
- // which is used by the <ACE_Log_Record> to distinguish the
- // level of verbosity.
+ /// Logger identification.
char *name_;
- // Logger identification.
+ /// Keeps track of what our current verbosity level is. This can be
+ /// reset by the client to a new value at any point.
Logger::Verbosity_Level verbosity_level_;
- // Keeps track of what our current verbosity level is. This can be
- // reset by the client to a new value at any point.
};
+/**
+ * @class Logger_Factory_i
+ *
+ * @brief Create a <Logger> of type <name>.
+ */
class Logger_Factory_i : public virtual POA_Logger_Factory
{
- // = TITLE
- // Create a <Logger> of type <name>.
public:
+ /// Constructor.
Logger_Factory_i (void);
- // Constructor.
+ /// Destructor.
~Logger_Factory_i (void);
- // Destructor.
+ /**
+ * This function returns a logger with name <name>. If <name> is
+ * unique, a new logger is created; else, a previously created
+ * logger of name <name> is returned
+ */
virtual Logger_ptr make_logger (const char *name);
- // This function returns a logger with name <name>. If <name> is
- // unique, a new logger is created; else, a previously created
- // logger of name <name> is returned
private:
+ /**
+ * Calls to <make_logger> will create a new instance of <Logger> and
+ * bind into the hash map manager if <name> is unique, else it will
+ * return a previously bound entry.
+ */
ACE_Hash_Map_Manager<ACE_CString, Logger_i *, ACE_Null_Mutex> hash_map_;
- // Calls to <make_logger> will create a new instance of <Logger> and
- // bind into the hash map manager if <name> is unique, else it will
- // return a previously bound entry.
};
#endif /* TAO_ORBSVCS_LOGGER_I_H */
diff --git a/TAO/examples/Logging/Logging_Service_i.h b/TAO/examples/Logging/Logging_Service_i.h
index 2f4c1839d90..13e479b9568 100644
--- a/TAO/examples/Logging/Logging_Service_i.h
+++ b/TAO/examples/Logging/Logging_Service_i.h
@@ -1,24 +1,19 @@
-// -*- c++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Logging_Service/
-//
-// = FILENAME
-// Logging_Service_i.h
-//
-// = DESCRIPTION
-// This class implements a simple "logger" CORBA server for the Logging
-// service using skeletons generated by the TAO ORB IDL compiler.
-//
-// = AUTHORS
-// Nagarajan Surendran <naga@cs.wustl.edu>
-// Matthew Braun <mjb2@cec.wustl.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file Logging_Service_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple "logger" CORBA server for the Logging
+ * service using skeletons generated by the TAO ORB IDL compiler.
+ *
+ *
+ * @author Nagarajan Surendran <naga@cs.wustl.edu> Matthew Braun <mjb2@cec.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _LOG_SERVER_H
#define _LOG_SERVER_H
@@ -37,64 +32,66 @@
#include "LoggerS.h"
#include "LoggerC.h"
+/**
+ * @class Logger_Server
+ *
+ * @brief Defines a Logger_Server class that implements the functionality
+ * of a server process as an object.
+ *
+ * The interface is quite simple. A server program has to call
+ * init to initialize the logger_server's state and then call run
+ * to run the orb.
+ */
class Logger_Server
{
- // = TITLE
- // Defines a Logger_Server class that implements the functionality
- // of a server process as an object.
- //
- // = DESCRIPTION
- // The interface is quite simple. A server program has to call
- // init to initialize the logger_server's state and then call run
- // to run the orb.
public:
// = Initialization and termination methods.
+ /// Constructor.
Logger_Server (void);
- // Constructor.
+ /// Destructor.
~Logger_Server (void);
- // Destructor.
+ /// Initialize the Logger_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the Logger_Server state - parsing arguments and ...
+ /// Run the ORB.
int run (void);
- // Run the ORB.
+ /// This function creates and returns a logger with the given <name>.
+ /// Currently, <name> is unused.
Logger_ptr make_logger (const char *name);
- // This function creates and returns a logger with the given <name>.
- // Currently, <name> is unused.
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// Initialises the name server and registers logger_factory with the
+ /// name server.
int init_naming_service (void);
- // Initialises the name server and registers logger_factory with the
- // name server.
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// helper class for getting access to Naming Service.
TAO_Naming_Client my_name_server_;
- // helper class for getting access to Naming Service.
+ /// Implementation object of the Logger_Factory.
Logger_Factory_i factory_impl_;
- // Implementation object of the Logger_Factory.
+ /// Factory_var to register with NamingService.
Logger_Factory_var factory_;
- // Factory_var to register with NamingService.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// The id to give the Logger_Factory instance (defaults to
+ /// "LoggingService")
const ACE_TCHAR* service_name_;
- // The id to give the Logger_Factory instance (defaults to
- // "LoggingService")
};
#endif /* _LOG_SERVER_H */
diff --git a/TAO/examples/Logging/Logging_Test_i.h b/TAO/examples/Logging/Logging_Test_i.h
index ced9e36d3ff..463802ed560 100644
--- a/TAO/examples/Logging/Logging_Test_i.h
+++ b/TAO/examples/Logging/Logging_Test_i.h
@@ -1,23 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Logger
-//
-// = FILENAME
-// client_i.h
-//
-// = DESCRIPTION
-// This class implements a simple logger CORBA client for the Logger
-// example using stubs generated by the TAO ORB IDL compiler
-//
-// = AUTHORS
-// Sergio Flores-Gaitan <sergio@cs.wustl.edu>
-// Matt Braun <mjb2@cec.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple logger CORBA client for the Logger
+ * example using stubs generated by the TAO ORB IDL compiler
+ *
+ *
+ * @author Sergio Flores-Gaitan <sergio@cs.wustl.edu> Matt Braun <mjb2@cec.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _LOG_CLIENT_H
#define _LOG_CLIENT_H
@@ -32,72 +28,74 @@
#include "LoggerC.h"
#include "orbsvcs/Naming/Naming_Client.h"
+/**
+ * @class Logger_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of the Logger
+ * client example. Provides a better understanding of the logic
+ * in an object oriented way.
+ *
+ * This class declares an interface to run the example client for
+ * Logger CORBA server. All the complexity for initializing the
+ * server is hidden in the class. Just the <run> interface is
+ * needed.
+ */
class Logger_Client
{
- // = TITLE
- // Defines a class that encapsulates behaviour of the Logger
- // client example. Provides a better understanding of the logic
- // in an object oriented way.
- //
- // = DESCRIPTION
- // This class declares an interface to run the example client for
- // Logger CORBA server. All the complexity for initializing the
- // server is hidden in the class. Just the <run> interface is
- // needed.
public:
// = Initialization and termination methods.
+ /// Constructor.
Logger_Client (void);
- // Constructor.
+ /// Destructor.
~Logger_Client (void);
- // Destructor.
+ /// Initialize the client communication endpoint with server.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the client communication endpoint with server.
+ /// Execute client example code.
int run (void);
- // Execute client example code.
private:
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Prepares the <Log_Record> for logging.
void init_record (Logger::Log_Record &newrec,
Logger::Log_Priority lp,
const char *msg);
- // Prepares the <Log_Record> for logging.
+ /// Initialises the name server and resolves the logger_factory
int init_naming_service (void);
- // Initialises the name server and resolves the logger_factory
+ /// Instantiates the 2 logger member variables
int init_loggers (void);
- // Instantiates the 2 logger member variables
+ /// Shows contents of the record (for debugging purposes).
void show_record (Logger::Log_Record &newrec);
- // Shows contents of the record (for debugging purposes).
+ /// Keep a pointer to the ORB for easy access
CORBA::ORB_var orb_;
- // Keep a pointer to the ORB for easy access
+ /// An instance of the name client used for resolving the factory
+ /// objects.
TAO_Naming_Client my_name_client_;
- // An instance of the name client used for resolving the factory
- // objects.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// A pointer to the Logger_Factory; used in init_loggers
Logger_Factory_var factory_;
- // A pointer to the Logger_Factory; used in init_loggers
+ /// Logger obj ref.
Logger_var logger_1_;
- // Logger obj ref.
+ /// Logger obj ref.
Logger_var logger_2_;
- // Logger obj ref.
};
#endif /* _LOG_CLIENT_H */
diff --git a/TAO/examples/OBV/Simple_util.h b/TAO/examples/OBV/Simple_util.h
index c21104a5118..93d4e58b071 100644
--- a/TAO/examples/OBV/Simple_util.h
+++ b/TAO/examples/OBV/Simple_util.h
@@ -1,24 +1,18 @@
-//$Id$
-
-// This version of Simple_Util doesn't need to link against orbsvcs
-// On the other hand it has no naming service.
-
-// ============================================================================
-//
-// = LIBRARY
-//
-// taken from TAO/tests/Simple
-//
-// = FILENAME
-// Simple_Util.h
-//
-// = DESCRIPTION
-// The classe define the templates for the client and server.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file Simple_Util.h
+ *
+ * $Id$
+ *
+ * The classe define the templates for the client and server.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_UTIL_H
#define TAO_UTIL_H
@@ -28,134 +22,138 @@
#include "ace/Get_Opt.h"
#include "ace/Read_Buffer.h"
+/**
+ * @class Server
+ *
+ * @brief A set of useful class Templates for using the TAO CORBA
+ * implementation.
+ *
+ * A template server definition. This template can be used by
+ * single server/client projects for defintion of their
+ * server/clients. See the directories time, bank, echo for
+ * further details of implemenatation.
+ */
template <class Servant>
class Server
{
- // = TITLE
- // A set of useful class Templates for using the TAO CORBA
- // implementation.
- //
- // = DESCRIPTION
- // A template server definition. This template can be used by
- // single server/client projects for defintion of their
- // server/clients. See the directories time, bank, echo for
- // further details of implemenatation.
public:
// = Initialization and termination methods.
+ /// Constructor.
Server (void);
- // Constructor.
+ /// Destructor.
~Server (void);
- // Destructor.
+ /// Initialize the Server state - parsing arguments and waiting.
+ /// interface_name is the name used to register the Servant.
int init (const char *servant_name,
int argc,
ACE_TCHAR *argv[]);
- // Initialize the Server state - parsing arguments and waiting.
- // interface_name is the name used to register the Servant.
+ /// After calling <init>, this method will register the server with
+ /// the TAO Naming Service using the servant_name passed to <init>.
int register_name (void);
- // After calling <init>, this method will register the server with
- // the TAO Naming Service using the servant_name passed to <init>.
+ /// Run the orb.
int run (void);
- // Run the orb.
protected:
+ /// Servant class
Servant servant_;
- // Servant class
+ /// name of the servant to be used for TAO Naming Service
const char *name;
- // name of the servant to be used for TAO Naming Service
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// The ORB manager - a helper class for accessing the POA and
+ /// registering objects.
TAO_ORB_Manager orb_manager_;
- // The ORB manager - a helper class for accessing the POA and
- // registering objects.
// TAO_Naming_Server namingServer;
// helper class for getting access to Naming Service.
+ /// File where the IOR of the server object is stored.
FILE *ior_output_file_;
- // File where the IOR of the server object is stored.
+ /// Number of command line arguments.
int argc_;
- // Number of command line arguments.
+ /// The command line arguments.
ACE_TCHAR **argv_;
- // The command line arguments.
};
+/**
+ * @class Client
+ *
+ * @brief Template Client class
+ *
+ * A template client implementation for a single server/client
+ * model. The example usage of these usage can be found in the
+ * sub-directories below
+ */
template <class InterfaceObj, class Var>
class Client
{
- // = TITLE
- // Template Client class
- //
- // = DESCRIPTION
- // A template client implementation for a single server/client
- // model. The example usage of these usage can be found in the
- // sub-directories below
public:
// = Initialization and termination methods.
+ /// Constructor.
Client (void);
- // Constructor.
+ /// Destructor.
~Client (void);
- // Destructor.
+ /// Initialize the client communication endpoint with server.
int init (const char *name,int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication endpoint with server.
+ /// Return the interface object pointer.
InterfaceObj *operator-> () { return server_.in ();};
- // Return the interface object pointer.
+ /// Returns the shutdown flag.
int shutdown (void );
- // Returns the shutdown flag.
+ /// Fills in the shutdwon flag.
void shutdown (int);
- // Fills in the shutdwon flag.
+ /// Initialize naming service
int obtain_initial_references (void);
- // Initialize naming service
protected:
+ /// Function to read the server IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the server IOR from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
// TAO_Naming_Client namingClient;
// helper class for getting access to Naming Service.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// IOR of the obj ref of the server.
char *ior_;
- // IOR of the obj ref of the server.
+ /// Name to be usred for the naming service
char *name_;
- // Name to be usred for the naming service
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Server object
Var server_;
- // Server object
+ /// Flag to use the naming service
int naming_;
- // Flag to use the naming service
+ /// Flag for shutting down the server
int shutdown_;
- // Flag for shutting down the server
};
diff --git a/TAO/examples/OBV/Typed_Events/Client_i.h b/TAO/examples/OBV/Typed_Events/Client_i.h
index 72894ea1a58..e1ea4b9fbbc 100644
--- a/TAO/examples/OBV/Typed_Events/Client_i.h
+++ b/TAO/examples/OBV/Typed_Events/Client_i.h
@@ -1,26 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/OBV/Typed_Events
-//
-// = FILENAME
-// Client_i.h
-//
-// = DESCRIPTION
-// This class is a template for a CORBA client.
-// run () sends some valuetypes to a server and
-// gets back a list of valuetypes.
-//
-// = AUTHOR
-//
-// Torsten Kuepper
-// based on the echo example
-// from code from Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Client_i.h
+ *
+ * $Id$
+ *
+ * This class is a template for a CORBA client.
+ * run () sends some valuetypes to a server and
+ * gets back a list of valuetypes.
+ *
+ *
+ * @author Torsten Kuepperbased on the echo examplefrom code from Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ECHO_CLIENT_I_H
#define ECHO_CLIENT_I_H
@@ -30,28 +24,30 @@
CORBA::Float random_number (double min, double max);
+/**
+ * @class Checkpoint_Client_i
+ *
+ * @brief Checkpoint_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Checkpoint_Client_i
{
- // = TITLE
- // Checkpoint_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Checkpoint_Client_i (void);
- // Constructor
+ /// Destructor
virtual ~Checkpoint_Client_i (void);
- // Destructor
+ /// Execute the methods
virtual int run (const char *,int, ACE_TCHAR** );
- // Execute the methods
private:
+ /// Instantiate the checkpoint object.
Client<Checkpoint, Checkpoint_var> checkpoint;
- // Instantiate the checkpoint object.
};
diff --git a/TAO/examples/OBV/Typed_Events/Server_i.h b/TAO/examples/OBV/Typed_Events/Server_i.h
index 8341c26165e..8e6c0002ce3 100644
--- a/TAO/examples/OBV/Typed_Events/Server_i.h
+++ b/TAO/examples/OBV/Typed_Events/Server_i.h
@@ -1,23 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Typed_Events
-//
-// = FILENAME
-// Server_i.h
-//
-// = DESCRIPTION
-// This class implements the Event_Types IDL interface.
-//
-// = AUTHOR
-// Torsten Kuepper
-// derived from the Echo example TAO/example/Simple/echo
-// of Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Server_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Event_Types IDL interface.
+ *
+ *
+ * @author Torsten Kuepper derived from the Echo example TAO/example/Simple/echo of Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ECHO_I_H
#define ECHO_I_H
@@ -29,11 +24,11 @@ class Checkpoint_i : public POA_Checkpoint
{
public:
// = Initialization and termination methods.
+ /// Constructor.
Checkpoint_i (void);
- // Constructor.
+ /// Destructor.
~Checkpoint_i (void);
- // Destructor.
virtual void put_event (
Event * e
@@ -42,15 +37,15 @@ public:
virtual Event_List * get_critical_events (
);
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
};
#endif /* ECHO_I_H */
diff --git a/TAO/examples/Persistent_Grid/Grid_Client_i.h b/TAO/examples/Persistent_Grid/Grid_Client_i.h
index 082c0d87bbb..1183592b637 100644
--- a/TAO/examples/Persistent_Grid/Grid_Client_i.h
+++ b/TAO/examples/Persistent_Grid/Grid_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/grid
-//
-// = FILENAME
-// Grid_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Grid_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef GRID_CLIENT_I_H
#define GRID_CLIENT_I_H
@@ -23,49 +20,51 @@
#include "Simple_util.h"
#include "GridC.h"
+/**
+ * @class Grid_Client_i
+ *
+ * @brief Grid_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Grid_Client_i
{
- // = TITLE
- // Grid_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Grid_Client_i (void);
- // Constructor
+ /// Destructor
virtual ~Grid_Client_i (void);
- // Destructor
+ /// Execute the methods.
virtual int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
+ /// Parses the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
private:
+ /// Instantiate the client object.
Client<Grid_Factory, Grid_Factory_var> client;
- // Instantiate the client object.
+ /// Height of the grid.
CORBA::Short height_;
- // Height of the grid.
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short setx_;
- // Cell identifier in which a value meeds to be stored.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short sety_;
- // Cell identifier in which a value meeds to be stored.
+ /// The value that needs to be stored in the cell.
CORBA::Long value_;
- // The value that needs to be stored in the cell.
+ /// A flag for testing persistence
CORBA::Short repeat_;
- // A flag for testing persistence
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Persistent_Grid/Grid_i.h b/TAO/examples/Persistent_Grid/Grid_i.h
index a8cd5c9847e..31c3a766303 100644
--- a/TAO/examples/Persistent_Grid/Grid_i.h
+++ b/TAO/examples/Persistent_Grid/Grid_i.h
@@ -1,20 +1,17 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/grid
-//
-// = FILENAME
-// Grid_i.h
-//
-// = DESCRIPTION
-// This class implements the Grid IDL interface.
-//
-// = AUTHOR
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Grid_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Grid IDL interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef GRID_I_H
#define GRID_I_H
@@ -28,61 +25,66 @@ typedef ACE_Malloc<ACE_MMAP_MEMORY_POOL, ACE_Null_Mutex> pool_t;
// Memory pool for the persistent stuff
//class Grid_Factory_i;
+/**
+ * @class Grid_Factory_i
+ *
+ * Create a <Grid>.
+ */
class Grid_Factory_i : public POA_Grid_Factory
{
- // =TITLE
- // Create a <Grid>.
public:
// = Initialization and termination methods.
+ /// Constructor.
Grid_Factory_i (void);
- // Constructor.
+ /// Destructor.
~Grid_Factory_i (void);
- // Destructor.
+ /// This function creates and returns a <Grid>.
virtual Grid_ptr make_grid (CORBA::Short,
CORBA::Short);
- // This function creates and returns a <Grid>.
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Do a clean up of the memory map
virtual void cleanup ( );
- // Do a clean up of the memory map
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
+ /// Set the pool pointer
void pool_name (const ACE_TCHAR *name);
- // Set the pool pointer
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// Name of the pool
ACE_TCHAR *pool_name_;
- // Name of the pool
+ /// Hold the pool of name pool_name_
pool_t *pool_t_;
- // Hold the pool of name pool_name_
+ /// Keeping g++2.7.2
ACE_UNIMPLEMENTED_FUNC (void operator= (const Grid_Factory_i &))
- // Keeping g++2.7.2
};
+/**
+ * @class Grid_i:
+ *
+ * @brief Grid object implementation.
+ *
+ * Grid object implementation
+ */
class Grid_i: public POA_Grid
{
- // = TITLE
- // Grid object implementation.
- //
- // = DESCRIPTION
- // Grid object implementation
public:
// = Initialization and termination methods.
+ /// Constructor
Grid_i (void);
- // Constructor
Grid_i (CORBA::Short,
CORBA::Short,
@@ -90,48 +92,48 @@ public:
// Constructor.
+ /// Destructor
~Grid_i (void);
- // Destructor
+ /// Returns the width of the grid
virtual CORBA::Short width (void);
- // Returns the width of the grid
+ /// Returns the height of the grid
virtual CORBA::Short height (void);
- // Returns the height of the grid
+ /// Sets the width of the grid.
virtual void width (CORBA::Short);
- // Sets the width of the grid.
+ /// Sets the height of the grid.
virtual void height (CORBA::Short);
- // Sets the height of the grid.
+ /// Sets the grid value.
virtual void set (CORBA::Short,
CORBA::Short,
CORBA::Long);
- // Sets the grid value.
+ /// Gets the grid value.
virtual CORBA::Long get (CORBA::Short,
CORBA::Short);
- // Gets the grid value.
+ /// Destroy the grid.
virtual void destroy (void);
- // Destroy the grid.
+ /// Set a pointer to the pool
void set_pool (pool_t *);
- // Set a pointer to the pool
private:
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Height of the grid.
CORBA::Short height_;
- // Height of the grid.
+ /// Pointer to the matrix. This is organized as an "array of arrays."
CORBA::Long **array_;
- // Pointer to the matrix. This is organized as an "array of arrays."
+ ///Pointer to the memory pool..
pool_t *pool_t_;
- //Pointer to the memory pool..
};
diff --git a/TAO/examples/Persistent_Grid/Persistent_Client.h b/TAO/examples/Persistent_Grid/Persistent_Client.h
index 93ad2fd9e99..b326b94cbcb 100644
--- a/TAO/examples/Persistent_Grid/Persistent_Client.h
+++ b/TAO/examples/Persistent_Grid/Persistent_Client.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Persistent_Client
-//
-// = FILENAME
-// Persistent_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Persistent_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PERSISTENT_CLIENT_I_H
#define PERSISTENT_CLIENT_I_H
@@ -23,40 +20,42 @@
#include "Simple_util.h"
#include "GridC.h"
+/**
+ * @class Persistent_Client_i
+ *
+ * @brief Grid_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Persistent_Client_i
{
- // = TITLE
- // Grid_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Persistent_Client_i (void);
- // Constructor
+ /// Destructor
virtual ~Persistent_Client_i (void);
- // Destructor
+ /// Execute the methods.
virtual int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
+ /// Parses the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
private:
+ /// Instantiate the client object.
Client<Grid_Factory, Grid_Factory_var> client;
- // Instantiate the client object.
+ /// Height of the grid
CORBA::Short height_;
- // Height of the grid
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Flag for the deletion of memory
CORBA::Short remove_;
- // Flag for the deletion of memory
};
#endif /* PERSISTENT_CLIENT_I_H */
diff --git a/TAO/examples/Persistent_Grid/Simple_util.h b/TAO/examples/Persistent_Grid/Simple_util.h
index b63f79c4eaa..84f5f61f76d 100644
--- a/TAO/examples/Persistent_Grid/Simple_util.h
+++ b/TAO/examples/Persistent_Grid/Simple_util.h
@@ -1,20 +1,17 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple
-//
-// = FILENAME
-// Simple_Util.h
-//
-// = DESCRIPTION
-// The classe define the templates for the client and server.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Simple_Util.h
+ *
+ * $Id$
+ *
+ * The classe define the templates for the client and server.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_UTIL_H
#define TAO_UTIL_H
@@ -23,132 +20,136 @@
#include "ace/Get_Opt.h"
#include "ace/Read_Buffer.h"
+/**
+ * @class Server
+ *
+ * @brief A set of useful class Templates for using the TAO CORBA
+ * implementation.
+ *
+ * A template server definition. This template can be used by
+ * single server/client projects for defintion of their
+ * server/clients. See the directories time, bank, echo for
+ * further details of implemenatation.
+ */
template <class Servant>
class Server
{
- // = TITLE
- // A set of useful class Templates for using the TAO CORBA
- // implementation.
- //
- // = DESCRIPTION
- // A template server definition. This template can be used by
- // single server/client projects for defintion of their
- // server/clients. See the directories time, bank, echo for
- // further details of implemenatation.
public:
// = Initialization and termination methods.
+ /// Constructor.
Server (void);
- // Constructor.
+ /// Destructor.
~Server (void);
- // Destructor.
+ /// Initialize the Server state - parsing arguments and waiting.
+ /// interface_name is the name used to register the Servant.
int init (const char *servant_name,
int argc,
ACE_TCHAR *argv[]);
- // Initialize the Server state - parsing arguments and waiting.
- // interface_name is the name used to register the Servant.
// int register_name (void);
// After calling <init>, this method will register the server with
// the TAO Naming Service using the servant_name passed to <init>.
+ /// Run the orb.
int run (void);
- // Run the orb.
protected:
+ /// Servant class
Servant servant_;
- // Servant class
+ /// name of the servant to be used for TAO Naming Service
const char *name;
- // name of the servant to be used for TAO Naming Service
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// The ORB manager - a helper class for accessing the POA and
+ /// registering objects.
TAO_ORB_Manager orb_manager_;
- // The ORB manager - a helper class for accessing the POA and
- // registering objects.
+ /// File where the IOR of the server object is stored.
FILE *ior_output_file_;
- // File where the IOR of the server object is stored.
+ /// Memory pool name that stores the state
ACE_TCHAR* mem_pool_name_;
- // Memory pool name that stores the state
+ /// Number of command line arguments.
int argc_;
- // Number of command line arguments.
+ /// The command line arguments.
ACE_TCHAR **argv_;
- // The command line arguments.
};
// Client Class starts here
+/**
+ * @class Client
+ *
+ * @brief Template Client class
+ *
+ * A template client implementation for a single server/client
+ * model. The example usage of these usage can be found in the
+ * sub-directories below
+ */
template <class InterfaceObj, class Var>
class Client
{
- // = TITLE
- // Template Client class
- //
- // = DESCRIPTION
- // A template client implementation for a single server/client
- // model. The example usage of these usage can be found in the
- // sub-directories below
public:
// = Initialization and termination methods.
+ /// Constructor.
Client (void);
- // Constructor.
+ /// Destructor.
~Client (void);
- // Destructor.
+ /// Initialize the client communication endpoint with server.
int init (const char *name,int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication endpoint with server.
+ /// Return the interface object pointer.
InterfaceObj *operator-> () { return server_.in ();};
- // Return the interface object pointer.
+ /// Returns the shutdown flag.
int shutdown (void );
- // Returns the shutdown flag.
+ /// Fills in the shutdwon flag.
void shutdown (int);
- // Fills in the shutdwon flag.
+ /// Initialize naming service
int obtain_initial_references (void);
- // Initialize naming service
protected:
+ /// Function to read the server IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the server IOR from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// IOR of the obj ref of the server.
char *ior_;
- // IOR of the obj ref of the server.
+ /// Flag to use the naming service
int naming_;
- // Flag to use the naming service
+ /// Flag for shutting down the server
int shutdown_;
- // Flag for shutting down the server
+ /// Server object
Var server_;
- // Server object
};
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
diff --git a/TAO/examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h b/TAO/examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h
index 28c854c9d70..83ab28e0163 100644
--- a/TAO/examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h
+++ b/TAO/examples/PluggableUDP/tests/Performance/UDP_PerformanceClient.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Performance
-//
-// = FILENAME
-// UDP_PerformanceClient.h
-//
-// = DESCRIPTION
-// This class implements the client functionality of the UDP test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file UDP_PerformanceClient.h
+ *
+ * $Id$
+ *
+ * This class implements the client functionality of the UDP test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef UDP_PERFORMANCECLIENT_H
#define UDP_PERFORMANCECLIENT_H
@@ -37,14 +34,14 @@ class UDP_PerformanceClient
//
public:
// = Initialization and termination methods.
+ /// Constructor
UDP_PerformanceClient (CORBA::ORB_ptr orb,
UDP_ptr udp,
UDP_i *udpHandler,
ACE_UINT32 burst_messages);
- // Constructor
+ /// Destructor
virtual ~UDP_PerformanceClient (void);
- // Destructor
private:
// Runs in a separate thread.
diff --git a/TAO/examples/PluggableUDP/tests/Performance/UDP_i.h b/TAO/examples/PluggableUDP/tests/Performance/UDP_i.h
index 11100ea5f15..42f4cba3c1d 100644
--- a/TAO/examples/PluggableUDP/tests/Performance/UDP_i.h
+++ b/TAO/examples/PluggableUDP/tests/Performance/UDP_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Performance
-//
-// = FILENAME
-// UDP_i.h
-//
-// = DESCRIPTION
-// This class implements the server functionality of the UDP test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file UDP_i.h
+ *
+ * $Id$
+ *
+ * This class implements the server functionality of the UDP test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef UDP_I_H
#define UDP_I_H
@@ -24,20 +21,21 @@
#include "ace/Hash_Map_Manager_T.h"
#include "ace/Null_Mutex.h"
+/**
+ * @class UDP_i:
+ *
+ * @brief UDP Object Implementation
+ *
+ */
class UDP_i: public POA_UDP
{
- // = TITLE
- // UDP Object Implementation
- //
- // = DESCRIPTION
- //
public:
// = Initialization and termination methods.
+ /// Constructor
UDP_i (void);
- // Constructor
+ /// Destructor
~UDP_i (void);
- // Destructor
virtual void setResponseHandler (UDP_ptr udpHandler);
@@ -46,21 +44,21 @@ public:
virtual void reset (const char * client_name);
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
+ /// Return the number of lost messages
ACE_UINT32 getMessagesCount ();
- // Return the number of lost messages
+ /// Return the number of lost messages
ACE_UINT32 getWrongMessagesCount ();
- // Return the number of lost messages
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
ACE_Hash_Map_Manager_Ex < CORBA::String_var,
CORBA::Long,
diff --git a/TAO/examples/PluggableUDP/tests/Performance/client.cpp b/TAO/examples/PluggableUDP/tests/Performance/client.cpp
index 603d9ee205d..6b5f5297c46 100644
--- a/TAO/examples/PluggableUDP/tests/Performance/client.cpp
+++ b/TAO/examples/PluggableUDP/tests/Performance/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Basic
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client for the UDP performance test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client for the UDP performance test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
diff --git a/TAO/examples/PluggableUDP/tests/Performance/server.cpp b/TAO/examples/PluggableUDP/tests/Performance/server.cpp
index e3bb9526ad3..d7f3cd09ebd 100644
--- a/TAO/examples/PluggableUDP/tests/Performance/server.cpp
+++ b/TAO/examples/PluggableUDP/tests/Performance/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Performance
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Implementation of the server running the UDP object.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the server running the UDP object.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Thread_Manager.h"
diff --git a/TAO/examples/PluggableUDP/tests/SimplePerformance/client.cpp b/TAO/examples/PluggableUDP/tests/SimplePerformance/client.cpp
index 8189a67528a..ce33fee52f6 100644
--- a/TAO/examples/PluggableUDP/tests/SimplePerformance/client.cpp
+++ b/TAO/examples/PluggableUDP/tests/SimplePerformance/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/SimplePerformance
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client for the UDP simple performance test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client for the UDP simple performance test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Task.h"
@@ -61,29 +58,30 @@ parse_args (int argc, ACE_TCHAR *argv[])
ACE_UINT32 niter = 10;
ACE_UINT32 SIZE_BLOCK= 256;
+/**
+ * @class Client
+ *
+ * @brief Run the client thread
+ *
+ * Use the ACE_Task_Base class to run the client threads.
+ */
class Client
{
- // = TITLE
- // Run the client thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run the client threads.
- //
public:
+ /// ctor
Client (Simple_Server_ptr server, ACE_UINT32 niterations);
- // ctor
virtual ~Client (void) {};
+ /// The thread entry point.
virtual int svc (void);
- // The thread entry point.
private:
+ /// The server.
Simple_Server_var server_;
- // The server.
+ /// The number of iterations on each client thread.
ACE_UINT32 niterations_;
- // The number of iterations on each client thread.
};
diff --git a/TAO/examples/PluggableUDP/tests/SimplePerformance/server.cpp b/TAO/examples/PluggableUDP/tests/SimplePerformance/server.cpp
index 832c627b6a9..1e11d5ecefb 100644
--- a/TAO/examples/PluggableUDP/tests/SimplePerformance/server.cpp
+++ b/TAO/examples/PluggableUDP/tests/SimplePerformance/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/SimplePerformance
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Implementation of the server running the UDP object.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the server running the UDP object.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
diff --git a/TAO/examples/PluggableUDP/tests/SimplePerformance/test_i.h b/TAO/examples/PluggableUDP/tests/SimplePerformance/test_i.h
index bfd469f86e4..c303c965370 100644
--- a/TAO/examples/PluggableUDP/tests/SimplePerformance/test_i.h
+++ b/TAO/examples/PluggableUDP/tests/SimplePerformance/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/MT_Client
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_MT_CLIENT_TEST_I_H
#define TAO_MT_CLIENT_TEST_I_H
#include "testS.h"
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public POA_Simple_Server
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb);
- // ctor
// = The Simple_Server methods.
void sendCharSeq (const Char_Seq & charSeq);
diff --git a/TAO/examples/Quoter/Factory_Finder.cpp b/TAO/examples/Quoter/Factory_Finder.cpp
index 6e7ff3ce929..815b4d30757 100644
--- a/TAO/examples/Quoter/Factory_Finder.cpp
+++ b/TAO/examples/Quoter/Factory_Finder.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// FactoryFinder.cpp
-//
-// = DESCRIPTION
-// A Factory Finder for the Quoter example. This example conforms
-// to the CosLifeCycle Factory Finder notion.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryFinder.cpp
+ *
+ * $Id$
+ *
+ * A Factory Finder for the Quoter example. This example conforms
+ * to the CosLifeCycle Factory Finder notion.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Factory_Finder.h"
diff --git a/TAO/examples/Quoter/Factory_Finder.h b/TAO/examples/Quoter/Factory_Finder.h
index 5da251a6d3a..c0cf1c4db57 100644
--- a/TAO/examples/Quoter/Factory_Finder.h
+++ b/TAO/examples/Quoter/Factory_Finder.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// FactoryFinder.h
-//
-// = DESCRIPTION
-// Server for the Quoter Factory Finder
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryFinder.h
+ *
+ * $Id$
+ *
+ * Server for the Quoter Factory Finder
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
@@ -25,45 +25,48 @@
#ifndef QUOTER_FACTORY_FINDER_H
#define QUOTER_FACTORY_FINDER_H
+/**
+ * @class Quoter_Factory_Finder_Server
+ = TILE
+ * Server object for the Quoter Factory Finder
+ */
class Quoter_Factory_Finder_Server
{
- // = TILE
- // Server object for the Quoter Factory Finder
public:
+ /// Default constructor
Quoter_Factory_Finder_Server (void);
- // Default constructor
+ /// Destructor
~Quoter_Factory_Finder_Server (void);
- // Destructor
+ /// Initialize the Quoter_Server state - parsing arguments and ...
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the Quoter_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
+ /// parse the passed parameters
u_int parse_args (void);
- // parse the passed parameters
private:
+ /// instance of the ORB Manager
TAO_ORB_Manager orb_manager_;
- // instance of the ORB Manager
+ /// instance of the Quoter Factory Finder
Quoter_Factory_Finder_i *quoter_Factory_Finder_i_ptr_;
- // instance of the Quoter Factory Finder
+ /// reference to the Quoter naming context
CosNaming::NamingContext_var quoterNamingContext_var_;
- // reference to the Quoter naming context
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* QUOTER_FACTORY_FINDER_H */
diff --git a/TAO/examples/Quoter/Factory_Finder_i.cpp b/TAO/examples/Quoter/Factory_Finder_i.cpp
index e497852a42d..05e79d9e1a7 100644
--- a/TAO/examples/Quoter/Factory_Finder_i.cpp
+++ b/TAO/examples/Quoter/Factory_Finder_i.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// FactoryFinder_i.cpp
-//
-// = DESCRIPTION
-// A Factory Finder for the Quoter example. This example conforms
-// to the CosLifeCycle Factory Finder notion.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryFinder_i.cpp
+ *
+ * $Id$
+ *
+ * A Factory Finder for the Quoter example. This example conforms
+ * to the CosLifeCycle Factory Finder notion.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Factory_Finder_i.h"
#include "QuoterC.h"
diff --git a/TAO/examples/Quoter/Factory_Finder_i.h b/TAO/examples/Quoter/Factory_Finder_i.h
index bcd6f4c4996..46baa527879 100644
--- a/TAO/examples/Quoter/Factory_Finder_i.h
+++ b/TAO/examples/Quoter/Factory_Finder_i.h
@@ -1,41 +1,46 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// FactoryFinder_i.h
-//
-// = DESCRIPTION
-// Factory Finder Implementation for the Quoter example
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryFinder_i.h
+ *
+ * $Id$
+ *
+ * Factory Finder Implementation for the Quoter example
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "QuoterS.h"
#ifndef QUOTER_FACTORY_FINDER_IMPL_H
#define QUOTER_FACTORY_FINDER_IMPL_H
+/**
+ * @class Quoter_Factory_Finder_i
+ = TILE
+ * A CosLifeCycle conforming Factory Finder for the Quoter
+ * example. It uses the Naming Service to find a fitting factory.
+ */
class Quoter_Factory_Finder_i : public POA_Stock::Quoter_Factory_Finder
{
- // = TILE
- // A CosLifeCycle conforming Factory Finder for the Quoter
- // example. It uses the Naming Service to find a fitting factory.
public:
Quoter_Factory_Finder_i (int debug_level = 1);
~Quoter_Factory_Finder_i (void);
+ /**
+ * Returns a sequence of Factories if factories matching the
+ * factory_key were found. If no factory was found, then the
+ * NoFactory exception, defined in CosLifeCycle, is raised.
+ */
virtual CosLifeCycle::Factories * find_factories (const CosLifeCycle::Key &factory_key);
- // Returns a sequence of Factories if factories matching the
- // factory_key were found. If no factory was found, then the
- // NoFactory exception, defined in CosLifeCycle, is raised.
private:
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* QUOTER_FACTORY_FINDER_IMPL_H */
diff --git a/TAO/examples/Quoter/Generic_Factory.cpp b/TAO/examples/Quoter/Generic_Factory.cpp
index dcf8bf4be19..9609e745600 100644
--- a/TAO/examples/Quoter/Generic_Factory.cpp
+++ b/TAO/examples/Quoter/Generic_Factory.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Generic_Factory.cpp
-//
-// = DESCRIPTION
-// The server for the GenericFactory for the quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Generic_Factory.cpp
+ *
+ * $Id$
+ *
+ * The server for the GenericFactory for the quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Generic_Factory.h"
diff --git a/TAO/examples/Quoter/Generic_Factory.h b/TAO/examples/Quoter/Generic_Factory.h
index 67095691205..97ed3dc3025 100644
--- a/TAO/examples/Quoter/Generic_Factory.h
+++ b/TAO/examples/Quoter/Generic_Factory.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Generic_Factory.h
-//
-// = DESCRIPTION
-// A generic factory, customized for the use with the Quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Generic_Factory.h
+ *
+ * $Id$
+ *
+ * A generic factory, customized for the use with the Quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
@@ -25,49 +25,52 @@
#ifndef GENERIC_FACTORY_H
#define GENERIC_FACTORY_H
+/**
+ * @class Quoter_Generic_Factory_Server
+ = TILE
+ * Server object for the Quoter Generic Factory
+ */
class Quoter_Generic_Factory_Server
{
- // = TILE
- // Server object for the Quoter Generic Factory
public:
+ /// Default constructor
Quoter_Generic_Factory_Server (void);
- // Default constructor
+ /// Destructor
~Quoter_Generic_Factory_Server (void);
- // Destructor
+ /// Initialize the Quoter_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Quoter_Server state - parsing arguments and ...
+ /// Run the orb.
int run (void);
- // Run the orb.
+ /// Parse the passed parameters.
u_int parse_args (void);
- // Parse the passed parameters.
private:
+ /// instance of the ORB Manager
TAO_ORB_Manager orb_manager_;
- // instance of the ORB Manager
+ /// Instance of the Quoter Generic Factory.
Quoter_Generic_Factory_i *quoter_Generic_Factory_i_ptr_;
- // Instance of the Quoter Generic Factory.
+ /// Reference to the Quoter naming context.
CosNaming::NamingContext_var quoterNamingContext_var_;
- // Reference to the Quoter naming context.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// flag for whether or not to use the lifecycle service
unsigned char use_LifeCycle_Service_;
- // flag for whether or not to use the lifecycle service
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* GENERIC_FACTORY_H */
diff --git a/TAO/examples/Quoter/Generic_Factory_i.cpp b/TAO/examples/Quoter/Generic_Factory_i.cpp
index 9b0c684ccc0..a6b56ed07d8 100644
--- a/TAO/examples/Quoter/Generic_Factory_i.cpp
+++ b/TAO/examples/Quoter/Generic_Factory_i.cpp
@@ -1,17 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Generic_Factory_i.cpp
-//
-// = DESCRIPTION
-// The implementation of a LifeCycle Service GenericFactory for the
-// Quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Generic_Factory_i.cpp
+ *
+ * $Id$
+ *
+ * The implementation of a LifeCycle Service GenericFactory for the
+ * Quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Generic_Factory_i.h"
#include "QuoterC.h"
diff --git a/TAO/examples/Quoter/Generic_Factory_i.h b/TAO/examples/Quoter/Generic_Factory_i.h
index d5f46a21778..9d46877d917 100644
--- a/TAO/examples/Quoter/Generic_Factory_i.h
+++ b/TAO/examples/Quoter/Generic_Factory_i.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Generic_Factory_i.h
-//
-// = DESCRIPTION
-// A LifeCycle Service Generic Factory for the Quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Generic_Factory_i.h
+ *
+ * $Id$
+ *
+ * A LifeCycle Service Generic Factory for the Quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "QuoterS.h"
@@ -19,32 +19,37 @@
#ifndef QUOTER_GENERIC_FACTORY_IMPL_H
#define QUOTER_GENERIC_FACTORY_IMPL_H
+/**
+ * @class Quoter_Generic_Factory_i
+ = TILE
+ * A CosLifeCycle conforming Generic Factory for the Quoter
+ * example. It uses the Naming Service to find a fitting factory.
+ */
class Quoter_Generic_Factory_i : public POA_Stock::Quoter_Generic_Factory
{
- // = TILE
- // A CosLifeCycle conforming Generic Factory for the Quoter
- // example. It uses the Naming Service to find a fitting factory.
public:
Quoter_Generic_Factory_i (int debug_level = 1);
~Quoter_Generic_Factory_i (void);
+ /// Returns true if the Generic Factory is able to forward a request
+ /// for creating an object described by the <factory_key>.
CORBA::Boolean supports (const CosLifeCycle::Key &factory_key);
- // Returns true if the Generic Factory is able to forward a request
- // for creating an object described by the <factory_key>.
+ /**
+ * Returns an object reference to a newly created object, though the
+ * Generic Factory itself cannot create objects, it will forward the
+ * request to a more concrete Factory.
+ */
CORBA::Object_ptr create_object (const CosLifeCycle::Key &factory_key,
const CosLifeCycle::Criteria &the_criteria);
- // Returns an object reference to a newly created object, though the
- // Generic Factory itself cannot create objects, it will forward the
- // request to a more concrete Factory.
private:
+ /// a helper to get the proper naming context.
CosNaming::NamingContext_ptr get_naming_context (const CosLifeCycle::Key &factory_key);
- // a helper to get the proper naming context.
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* QUOTER_GENERIC_FACTORY_IMPL_H */
diff --git a/TAO/examples/Quoter/Quoter_i.cpp b/TAO/examples/Quoter/Quoter_i.cpp
index a911997fd24..60f0b808739 100644
--- a/TAO/examples/Quoter/Quoter_i.cpp
+++ b/TAO/examples/Quoter/Quoter_i.cpp
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Quoter
-//
-// = FILENAME
-// Quoter_i.cpp
-//
-// = AUTHOR
-// Darrell Brunsch <brunsch@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Quoter_i.cpp
+ *
+ * $Id$
+ *
+ * @author Darrell Brunsch <brunsch@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Quoter_i.h"
diff --git a/TAO/examples/Quoter/Quoter_i.h b/TAO/examples/Quoter/Quoter_i.h
index 06d24a017c0..776459631e8 100644
--- a/TAO/examples/Quoter/Quoter_i.h
+++ b/TAO/examples/Quoter/Quoter_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Quoter
-//
-// = FILENAME
-// Quoter_i.h
-//
-// = AUTHOR
-// Darrell Brunsch <brunsch@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Quoter_i.h
+ *
+ * $Id$
+ *
+ * @author Darrell Brunsch <brunsch@uci.edu>
+ */
+//=============================================================================
+
#ifndef QUOTER_IMPL_H
#define QUOTER_IMPL_H
@@ -25,47 +22,49 @@ class Quoter_i;
typedef Quoter_i *Quoter_i_ptr;
typedef Quoter_i_ptr Quoter_i_ref;
+/**
+ * @class Quoter_i:
+ *
+ * @brief Quoter_i
+ *
+ * Actual Quoter Implementation class. Returns a quoter for a given stock
+ * and provides an example for the lifecycle functionality.
+ */
class Quoter_i: public POA_Stock::Quoter
{
- // = TITLE
- // Quoter_i
- //
- // = DESCRIPTION
- // Actual Quoter Implementation class. Returns a quoter for a given stock
- // and provides an example for the lifecycle functionality.
public:
+ /// Constructor (use_LifeCycle_Service is 1 if the LifeCycle_Service should be used
+ /// instead of the Quoter Generic_Factory
Quoter_i (const char *obj_name = "",
const unsigned char use_LifeCycle_Service = 0,
PortableServer::POA_ptr poa_ptr = 0);
- // Constructor (use_LifeCycle_Service is 1 if the LifeCycle_Service should be used
- // instead of the Quoter Generic_Factory
+ /// Destructor
~Quoter_i (void);
- // Destructor
+ /// Returns the current quote for the stock <stock_name>
virtual CORBA::Long get_quote (const char *stock_name);
- // Returns the current quote for the stock <stock_name>
// = Lifecycle methods
+ /// Make a copy of this object
virtual CosLifeCycle::LifeCycleObject_ptr copy (CosLifeCycle::FactoryFinder_ptr there,
const CosLifeCycle::Criteria &the_criteria);
- // Make a copy of this object
+ /// Move this object using <there>
virtual void move (CosLifeCycle::FactoryFinder_ptr there,
const CosLifeCycle::Criteria &the_criteria);
- // Move this object using <there>
+ /// Removes the object.
virtual void remove (void);
- // Removes the object.
private:
+ /// This flag defines if a Generic Factory is used (0 by default) or
+ /// the more sophisticated LifeCycle Service (1)
unsigned char use_LifeCycle_Service_;
- // This flag defines if a Generic Factory is used (0 by default) or
- // the more sophisticated LifeCycle Service (1)
+ /// Keep a reference to the POA for use by the move operation
PortableServer::POA_var poa_var_;
- // Keep a reference to the POA for use by the move operation
};
// Forward declaration.
@@ -73,38 +72,40 @@ class Quoter_Factory_i;
typedef Quoter_Factory_i *Quoter_Factory_i_ptr;
+/**
+ * @class Quoter_Factory_i:
+ *
+ * @brief Quoter_Factory_i
+ *
+ * Factory object returning the quoter_impl objrefs.
+ */
class Quoter_Factory_i: public POA_Stock::Quoter_Factory
{
- // = TITLE
- // Quoter_Factory_i
- //
- // = DESCRIPTION
- // Factory object returning the quoter_impl objrefs.
public:
+ /// Constructor that takes in the number of quoters in the pool.
Quoter_Factory_i (size_t num, PortableServer::POA_ptr poa_ptr);
- // Constructor that takes in the number of quoters in the pool.
+ /// Destructor.
~Quoter_Factory_i (void);
- // Destructor.
+ /// Initialize everything in the factory
int init (void);
- // Initialize everything in the factory
+ /// Return the quoter by the id <name>.
virtual Stock::Quoter_ptr create_quoter (const char *name);
- // Return the quoter by the id <name>.
private:
+ /// Pointer to the poa.
PortableServer::POA_ptr poa_ptr_;
- // Pointer to the poa.
+ /// Array of quoters.
Quoter_i **my_quoters_;
- // Array of quoters.
+ /// Number of quoters.
size_t quoter_num_;
- // Number of quoters.
+ /// Which quoter to return next.
size_t next_quoter_;
- // Which quoter to return next.
};
#endif /* QUOTER_IMPL_H */
diff --git a/TAO/examples/Quoter/client.h b/TAO/examples/Quoter/client.h
index d740c0860a8..b0b13d19e99 100644
--- a/TAO/examples/Quoter/client.h
+++ b/TAO/examples/Quoter/client.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Quoter
-//
-// = FILENAME
-// quoter_client.h
-//
-// = DESCRIPTION
-// Contains classes that do the work of the client side of the Quoter Test
-//
-// = AUTHORS
-// Darrell Brunsch
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file quoter_client.h
+ *
+ * $Id$
+ *
+ * Contains classes that do the work of the client side of the Quoter Test
+ *
+ *
+ * @author Darrell Brunsch
+ */
+//=============================================================================
+
#ifndef QUOTER_CLIENT_H
#define QUOTER_CLIENT_H
@@ -33,76 +30,80 @@
#include "ace/Task.h"
#include "ace/Thread_Manager.h"
+/**
+ * @class Quoter_Client
+ *
+ * @brief Quoter_Client
+ *
+ * Does all the work of making the calls on the Quoter server
+ */
class Quoter_Client
{
- // = TITLE
- // Quoter_Client
- //
- // = DESCRIPTION
- // Does all the work of making the calls on the Quoter server
public:
// = Constructor and destructor.
Quoter_Client (void);
~Quoter_Client (void);
+ /// Execute client example code.
int run (void);
- // Execute client example code.
+ /// Initialize the client communication endpoint with server.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the client communication endpoint with server.
private:
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Function to initialize the naming service.
int init_naming_service (void);
- // Function to initialize the naming service.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// Key of factory obj ref.
char *quoter_factory_key_;
- // Key of factory obj ref.
+ /// Key of the obj ref to be retrieved via the factory.
char *quoter_key_;
- // Key of the obj ref to be retrieved via the factory.
+ /// Flag to tell server to shutdown.
int shutdown_;
- // Flag to tell server to shutdown.
+ /// Pointer to a factory finder
Stock::Quoter_Factory_Finder_var factory_Finder_var_;
- // Pointer to a factory finder
+ /// Pointer to a factory
Stock::Quoter_Factory_var factory_var_;
- // Pointer to a factory
+ /// Pointer to a generic factory
CosLifeCycle::GenericFactory_var generic_Factory_var_;
- // Pointer to a generic factory
+ /// Quoter obj ref.
Stock::Quoter_var quoter_var_;
- // Quoter obj ref.
+ /// Flag to tell if the a Generic Factory is going to be used
+ /// or the LifeCycle Service (0 means Generic Factory, 1 means LCS)
int useLifeCycleService_;
- // Flag to tell if the a Generic Factory is going to be used
- // or the LifeCycle Service (0 means Generic Factory, 1 means LCS)
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
+/**
+ * @class Quoter_Task
+ *
+ * @brief Quoter_Task
+ *
+ * Task that creates a Quoter_Client and uses it
+ */
class Quoter_Task : public ACE_Task<ACE_SYNCH>
{
- // = TITLE
- // Quoter_Task
- //
- // = DESCRIPTION
- // Task that creates a Quoter_Client and uses it
public:
Quoter_Task (int argc, ACE_TCHAR **argv);
diff --git a/TAO/examples/Quoter/server.cpp b/TAO/examples/Quoter/server.cpp
index c285d845358..b3bc7ea341f 100644
--- a/TAO/examples/Quoter/server.cpp
+++ b/TAO/examples/Quoter/server.cpp
@@ -1,17 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Quoter_Server.cpp
-//
-// = DESCRIPTION
-// The Server for the Quoter Factory
-//
-// = AUTHOR
-// Darrell Brunsch (brunsch@cs.wustl.edu)
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Quoter_Server.cpp
+ *
+ * $Id$
+ *
+ * The Server for the Quoter Factory
+ *
+ *
+ * @author Darrell Brunsch (brunsch@cs.wustl.edu) Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "server.h"
#include "tao/ORB_Core.h"
diff --git a/TAO/examples/Quoter/server.h b/TAO/examples/Quoter/server.h
index 354c20e3286..801f0300b58 100644
--- a/TAO/examples/Quoter/server.h
+++ b/TAO/examples/Quoter/server.h
@@ -1,22 +1,19 @@
-// $Id$
// -*- C++ -*-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Quoter
-//
-// = FILENAME
-// quoter_server.h
-//
-// = DESCRIPTION
-// Implements the Quoter_Server class which handles the initialization of
-// the quoter implementations.
-//
-// = AUTHORS
-// Darrell Brunsch (brunsch@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file quoter_server.h
+ *
+ * $Id$
+ *
+ * Implements the Quoter_Server class which handles the initialization of
+ * the quoter implementations.
+ *
+ *
+ * @author Darrell Brunsch (brunsch@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef QUOTER_SERVER_H
#define QUOTER_SERVER_H
@@ -34,58 +31,60 @@
#include "Quoter_i.h"
#include "QuoterC.h"
+/**
+ * @class Quoter_Server
+ *
+ * Defines a Quoter Server class that implements the functionality
+ * of a server process as an object.
+ * =DESCRIPTION
+ * The interface is quite simple. A server program has to call
+ * init to initialize the quoter_server's state and then call run
+ * to run the orb.
+ */
class Quoter_Server
{
- // =TITLE
- // Defines a Quoter Server class that implements the functionality
- // of a server process as an object.
- //
- // =DESCRIPTION
- // The interface is quite simple. A server program has to call
- // init to initialize the quoter_server's state and then call run
- // to run the orb.
public:
+ /// Default constructor
Quoter_Server (void);
- // Default constructor
+ /// Destructor
~Quoter_Server (void);
- // Destructor
+ /// Initialize the Quoter_Server state - parsing arguments and ...
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the Quoter_Server state - parsing arguments and ...
+ /// Run the server.
int run (void);
- // Run the server.
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// Initializes the name server and registers cubit factory with the
+ /// name server.
int init_naming_service (void);
- // Initializes the name server and registers cubit factory with the
- // name server.
+ /// Number of quoter objects we export.
int num_of_objs_;
- // Number of quoter objects we export.
+ /// Naming Service context
CosNaming::NamingContext_var namingContext_var_;
- // Naming Service context
+ /// Instantiate the Quoter Factory
Quoter_Factory_i *quoter_Factory_i_ptr_;
- // Instantiate the Quoter Factory
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* QUOTER_SERVER_H */
diff --git a/TAO/examples/Simple/Simple_util.h b/TAO/examples/Simple/Simple_util.h
index 9808d1e1a19..341a0b34102 100644
--- a/TAO/examples/Simple/Simple_util.h
+++ b/TAO/examples/Simple/Simple_util.h
@@ -1,20 +1,17 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple
-//
-// = FILENAME
-// Simple_Util.h
-//
-// = DESCRIPTION
-// The classe define the templates for the client and server.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Simple_Util.h
+ *
+ * $Id$
+ *
+ * The classe define the templates for the client and server.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_UTIL_H
#define TAO_UTIL_H
@@ -25,108 +22,112 @@
#include "ace/Read_Buffer.h"
#include "tao/Intrusive_Ref_Count_Handle_T.h"
+/**
+ * @class Server
+ *
+ * @brief A set of useful class Templates for using the TAO CORBA
+ * implementation.
+ *
+ * A template server definition. This template can be used by
+ * single server/client projects for defintion of their
+ * server/clients. See the directories time, bank, echo for
+ * further details of implemenatation.
+ */
template <class Servant>
class Server
{
- // = TITLE
- // A set of useful class Templates for using the TAO CORBA
- // implementation.
- //
- // = DESCRIPTION
- // A template server definition. This template can be used by
- // single server/client projects for defintion of their
- // server/clients. See the directories time, bank, echo for
- // further details of implemenatation.
public:
// = Initialization and termination methods.
+ /// Constructor.
Server (void);
- // Constructor.
+ /// Destructor.
~Server (void);
- // Destructor.
+ /// Initialize the Server state - parsing arguments and waiting.
+ /// interface_name is the name used to register the Servant.
int init (const char *servant_name,
int argc,
ACE_TCHAR *argv[]);
- // Initialize the Server state - parsing arguments and waiting.
- // interface_name is the name used to register the Servant.
+ /// After calling <init>, this method will register the server with
+ /// the TAO Naming Service using the name passed to this method.
int register_name (const char *name);
- // After calling <init>, this method will register the server with
- // the TAO Naming Service using the name passed to this method.
+ /// Run the orb.
int run (void);
- // Run the orb.
+ /// Ignore this method if you are not testing the InterOperable
+ /// Naming Service.
int test_for_ins (const char *ior);
- // Ignore this method if you are not testing the InterOperable
- // Naming Service.
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// A holder of the servant that does ref counting for him.
typedef TAO_Intrusive_Ref_Count_Handle<Servant> Servant_var;
Servant_var servant_;
- // A holder of the servant that does ref counting for him.
+ /// The ORB manager - a helper class for accessing the POA and
+ /// registering objects.
TAO_ORB_Manager orb_manager_;
- // The ORB manager - a helper class for accessing the POA and
- // registering objects.
+ /// helper class for getting access to Naming Service.
TAO_Naming_Client naming_client_;
- // helper class for getting access to Naming Service.
+ /// File where the IOR of the server object is stored.
ACE_TCHAR *ior_output_file_;
- // File where the IOR of the server object is stored.
+ /// Flag to indicate whether naming service could be used
int naming_;
- // Flag to indicate whether naming service could be used
+ /// Used test the INS.
ACE_TCHAR *ins_;
- // Used test the INS.
+ /// Number of command line arguments.
int argc_;
- // Number of command line arguments.
+ /// The command line arguments.
ACE_TCHAR **argv_;
- // The command line arguments.
};
+/**
+ * @class Client
+ *
+ * @brief Template Client class
+ *
+ * A template client implementation for a single server/client
+ * model. The example usage of these usage can be found in the
+ * sub-directories below
+ */
template <class ServerInterface>
class Client
{
- // = TITLE
- // Template Client class
- //
- // = DESCRIPTION
- // A template client implementation for a single server/client
- // model. The example usage of these usage can be found in the
- // sub-directories below
public:
// = Initialization and termination methods.
+ /// Constructor.
Client (void);
- // Constructor.
+ /// Destructor.
~Client (void);
- // Destructor.
+ /// Initialize the client communication endpoint with server.
int init (const char *name, int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication endpoint with server.
+ /// Return the interface object pointer.
ServerInterface *operator-> () { return server_.in (); }
- // Return the interface object pointer.
+ /// Returns the shutdown flag.
int do_shutdown (void);
- // Returns the shutdown flag.
+ /// Fills in the shutdwon flag.
void do_shutdown (int);
- // Fills in the shutdwon flag.
+ /// Initialize naming service
int obtain_initial_references (const char *name);
- // Initialize naming service
CORBA::ORB_ptr orb (void)
{
@@ -134,36 +135,36 @@ public:
}
private:
+ /// Function to read the server IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the server IOR from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// helper class for getting access to Naming Service.
TAO_Naming_Client naming_client_;
- // helper class for getting access to Naming Service.
+ /// # of arguments on the command line.
int argc_;
- // # of arguments on the command line.
+ /// arguments from command line.
ACE_TCHAR **argv_;
- // arguments from command line.
+ /// IOR of the obj ref of the server.
ACE_CString ior_;
- // IOR of the obj ref of the server.
+ /// Server object
typedef TAO_Intrusive_Ref_Count_Handle<ServerInterface> ServerInterface_var;
ServerInterface_var server_;
- // Server object
+ /// Flag to use the naming service
int naming_;
- // Flag to use the naming service
+ /// Flag for shutting down the server
int do_shutdown_;
- // Flag for shutting down the server
};
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
diff --git a/TAO/examples/Simple/bank/AccountManager_i.h b/TAO/examples/Simple/bank/AccountManager_i.h
index e6a142d4266..ede279c0840 100644
--- a/TAO/examples/Simple/bank/AccountManager_i.h
+++ b/TAO/examples/Simple/bank/AccountManager_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/Bank
-//
-// = FILENAME
-// AccountManager_i.h
-//
-// = DESCRIPTION
-// This class implements the Bank::AccountManager IDL interface.
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file AccountManager_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Bank::AccountManager IDL interface.
+ *
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ACCOUNTMANAGER_I_H
#define ACCOUNTMANAGER_I_H
@@ -38,65 +35,69 @@ TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_ORB_Manager;
TAO_END_VERSIONED_NAMESPACE_DECL
+/**
+ * @class AccountManager_i
+ *
+ * @brief Account Manager object implementation.
+ *
+ * Implementation of a simple object that has two methods, one
+ * that returns an Account Interface and the other that shuts
+ * down the server.
+ */
class AccountManager_i : public POA_Bank::AccountManager
{
- // = TITLE
- // Account Manager object implementation.
- //
- // = DESCRIPTION
- // Implementation of a simple object that has two methods, one
- // that returns an Account Interface and the other that shuts
- // down the server.
public:
// = Initialization and termination methods.
+ /// Constructor.
AccountManager_i (void);
- // Constructor.
+ /// Destructor.
virtual ~AccountManager_i (void);
- // Destructor.
+ /// Return the Account interface with the given name from the server.
+ /// Put the initial balance specified in the new account.
virtual Bank::Account_ptr open (const char *name,
CORBA::Float initial_balance);
- // Return the Account interface with the given name from the server.
- // Put the initial balance specified in the new account.
+ /// Close the given account.
virtual void close (Bank::Account_ptr);
- // Close the given account.
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
+ /// Set the POA pointer.
void poa (PortableServer::POA_ptr poa);
- // Set the POA pointer.
+ /// Set the ORB Manager.
void set_orb_manager (TAO_ORB_Manager *orb_manager);
- // Set the ORB Manager.
+ /// The ORB manager.
TAO_ORB_Manager *orb_manager_;
- // The ORB manager.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// POA pointer.
PortableServer::POA_var poa_;
- // POA pointer.
typedef TAO_Intrusive_Ref_Count_Handle<Account_i> Account_i_var;
typedef ACE_Hash_Map_Manager<ACE_CString,
Account_i_var,
ACE_Null_Mutex> MAP_MANAGER_TYPE;
+ /**
+ * Calls to <open> will create a new instance of <Account_i> and
+ * bind into the hash map manager if <name> is unique, else it will
+ * return a previously bound entry.
+ */
MAP_MANAGER_TYPE hash_map_;
- // Calls to <open> will create a new instance of <Account_i> and
- // bind into the hash map manager if <name> is unique, else it will
- // return a previously bound entry.
+ /// Keeping g++2.7.2
ACE_UNIMPLEMENTED_FUNC (void operator= (const AccountManager_i &))
- // Keeping g++2.7.2
};
#endif /* ACCOUNTMANAGER_I_H */
diff --git a/TAO/examples/Simple/bank/Account_i.h b/TAO/examples/Simple/bank/Account_i.h
index 68562fc7cc1..777097e97e8 100644
--- a/TAO/examples/Simple/bank/Account_i.h
+++ b/TAO/examples/Simple/bank/Account_i.h
@@ -1,74 +1,73 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/Bank
-//
-// = FILENAME
-// Account_i.h
-//
-// = DESCRIPTION
-// This class implements the Bank IDL interface.
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Account_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Bank IDL interface.
+ *
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ACCOUNT_I_H
#define ACCOUNT_I_H
#include "BankS.h"
+/**
+ * @class Account_i
+ *
+ * @brief Bank object implementation.
+ *
+ * Implementation of a simple object that has two methods, one
+ * that return the current balance on the server and the other
+ * that shuts down the server.
+ */
class Account_i : public POA_Bank::Account
{
- // = TITLE
- // Bank object implementation.
- //
- // = DESCRIPTION
- // Implementation of a simple object that has two methods, one
- // that return the current balance on the server and the other
- // that shuts down the server.
public:
// = Initialization and termination methods.
+ /// Constructor.
Account_i (void);
- // Constructor.
+ /// Constructor.
Account_i (const char *, CORBA::Float);
- // Constructor.
+ /// Destructor.
virtual ~Account_i (void);
- // Destructor.
+ /// Get the current balance in the account.
virtual CORBA::Float balance (void);
- // Get the current balance in the account.
+ /// Get the name of the <Account> holder.
virtual char *name (void);
- // Get the name of the <Account> holder.
+ /// Set the name of the <Account> holder.
virtual void name (const char *name);
- // Set the name of the <Account> holder.
+ /// Deposit money in the account.
virtual void deposit (CORBA::Float);
- // Deposit money in the account.
+ /// Withdraw money in the account.
virtual void withdraw (CORBA::Float);
- // Withdraw money in the account.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// balance for this account
CORBA::Float balance_;
- // balance for this account
+ /// Name of the <Account> holder.
CORBA::String_var name_;
- // Name of the <Account> holder.
};
#endif /* ACCOUNT_I_H */
diff --git a/TAO/examples/Simple/bank/Bank_Client_i.h b/TAO/examples/Simple/bank/Bank_Client_i.h
index 0a3a0c25c10..5b20c895646 100644
--- a/TAO/examples/Simple/bank/Bank_Client_i.h
+++ b/TAO/examples/Simple/bank/Bank_Client_i.h
@@ -1,22 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/bank
-//
-// = FILENAME
-// Bank_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-//
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Bank_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef BANK_CLIENT_I_H
#define BANK_CLIENT_I_H
@@ -24,43 +20,45 @@
#include "../Simple_util.h"
#include "BankC.h"
+/**
+ * @class Bank_Client_i
+ *
+ * @brief Grid_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Bank_Client_i
{
- // = TITLE
- // Grid_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Bank_Client_i (void);
- // Constructor
+ /// Destructor
~Bank_Client_i (void);
- // Destructor
+ /// Execute the methods.
int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
private:
+ /// Method that calls all the test functions
int check_accounts (void);
- // Method that calls all the test functions
+ /// Tests if accounts opened with different names return a different account
+ /// reference.
void test_for_different_name (void);
- // Tests if accounts opened with different names return a different account
- // reference.
+ /// Tests if accounts opened with the same name return the same
+ /// object reference.
void test_for_same_name (void);
- // Tests if accounts opened with the same name return the same
- // object reference.
+ /// Tests for the Overdraft Exception when the client tries to
+ /// withdraw more money than the current balance.
void test_for_overdraft (void);
- // Tests for the Overdraft Exception when the client tries to
- // withdraw more money than the current balance.
+ /// Instantiate the client object.
Client<Bank::AccountManager> client_;
- // Instantiate the client object.
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Simple/chat/Broadcaster_i.cpp b/TAO/examples/Simple/chat/Broadcaster_i.cpp
index 3a89e85a703..42aa06b3086 100644
--- a/TAO/examples/Simple/chat/Broadcaster_i.cpp
+++ b/TAO/examples/Simple/chat/Broadcaster_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Broadcaster_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the Broadcaster_i class. This class is the servant
-// object for the chat server.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Broadcaster_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Broadcaster_i class. This class is the servant
+ * object for the chat server.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Broadcaster_i.h"
diff --git a/TAO/examples/Simple/chat/Broadcaster_i.h b/TAO/examples/Simple/chat/Broadcaster_i.h
index 764bd6e808a..426f0c5ef7b 100644
--- a/TAO/examples/Simple/chat/Broadcaster_i.h
+++ b/TAO/examples/Simple/chat/Broadcaster_i.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Broadcaster_i.h
-//
-// = DESCRIPTION
-// Defines the implementation header for the Broadcaster interface.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Broadcaster_i.h
+ *
+ * $Id$
+ *
+ * Defines the implementation header for the Broadcaster interface.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef BROADCASTER_I_H
#define BROADCASTER_I_H
@@ -31,53 +28,58 @@
#include "ace/SString.h"
+/**
+ * @class Broadcaster_i
+ *
+ * @brief The implementation of the Broadcaster class, which is the
+ * servant object for the chat server.
+ */
class Broadcaster_i : public POA_Broadcaster
{
- // = TITLE
- // The implementation of the Broadcaster class, which is the
- // servant object for the chat server.
public:
// = Initialization and termination methods.
+ /// Constructor.
Broadcaster_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Broadcaster_i (void);
- // Destructor.
+ /// Saves receiver references in a list.
virtual void add (Receiver_ptr receiver,
const char *nickname);
- // Saves receiver references in a list.
+ /// Removes receiver references from the list.
virtual void remove (Receiver_ptr receiver);
- // Removes receiver references from the list.
+ /// Called by Broadcaster clients to send messages.
virtual void say (Receiver_ptr receiver,
const char *text);
- // Called by Broadcaster clients to send messages.
public:
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// Broadcasts the text to all registered clients.
void broadcast (const char* text);
- // Broadcasts the text to all registered clients.
+ /**
+ * @class Receiver_Data
+ *
+ * @brief Per-client info.
+ *
+ * Saves the Receiver_var and user nickname.
+ */
class Receiver_Data
{
- // = TITLE
- // Per-client info.
- //
- // = DESCRIPTION
- // Saves the Receiver_var and user nickname.
public:
+ /// The == op required by the ACE_Unbounded set.
bool operator == (const Receiver_Data &receiver_data) const;
- // The == op required by the ACE_Unbounded set.
+ /// Stores the receiver reference.
Receiver_var receiver_;
- // Stores the receiver reference.
+ /// Stores the client nickname.
ACE_CString nickname_;
- // Stores the client nickname.
};
typedef ACE_Unbounded_Set<Receiver_Data>
@@ -85,8 +87,8 @@ public:
typedef ACE_Unbounded_Set_Iterator<Receiver_Data>
RECEIVER_SET_ITERATOR;
+ /// Set of registered clients.
RECEIVER_SET receiver_set_;
- // Set of registered clients.
};
#endif /* BROADCASTER_I_H */
diff --git a/TAO/examples/Simple/chat/Client_i.cpp b/TAO/examples/Simple/chat/Client_i.cpp
index 863a4dc66c4..fad94839bcd 100644
--- a/TAO/examples/Simple/chat/Client_i.cpp
+++ b/TAO/examples/Simple/chat/Client_i.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Client_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the Client_i class.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Client_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Client_i class.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Client_i.h"
#include "tao/ORB.h"
diff --git a/TAO/examples/Simple/chat/Client_i.h b/TAO/examples/Simple/chat/Client_i.h
index 7f7fd3bda93..874f7ec9bf3 100644
--- a/TAO/examples/Simple/chat/Client_i.h
+++ b/TAO/examples/Simple/chat/Client_i.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Client_i.h
-//
-// = DESCRIPTION
-// Definition of the Chat Client class, Client_i.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Client_i.h
+ *
+ * $Id$
+ *
+ * Definition of the Chat Client class, Client_i.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CLIENT_I_H
#define CLIENT_I_H
@@ -34,58 +30,60 @@
#include "tao/Utils/ORB_Manager.h"
#include "tao/Intrusive_Ref_Count_Handle_T.h"
+/**
+ * @class Client_i
+ *
+ * @brief Chat Client class.
+ *
+ * Connects to the Chat server and registers the Receiver_i
+ * object with the chat server. It also takes in user chat
+ * messages and sends them to the server.
+ */
class Client_i : public ACE_Event_Handler
{
- // = TITLE
- // Chat Client class.
- //
- // = DESCRIPTION
- // Connects to the Chat server and registers the Receiver_i
- // object with the chat server. It also takes in user chat
- // messages and sends them to the server.
public:
// = Initialization and termination methods.
+ /// Constructor.
Client_i (void);
- // Constructor.
+ /// Initialize the client communication with the server.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the client communication with the server.
+ /// Start the ORB object.
int run (void);
- // Start the ORB object.
+ /// Handle the user input.
virtual int handle_input (ACE_HANDLE);
- // Handle the user input.
private:
+ /// Parse the command line arguments.
+ /// Returns 0 on success, -1 on error.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parse the command line arguments.
- // Returns 0 on success, -1 on error.
+ /// Function to read the server ior from a file.
int read_ior (const ACE_TCHAR *filename);
- // Function to read the server ior from a file.
+ /// IOR of the obj ref of the server.
ACE_CString ior_;
- // IOR of the obj ref of the server.
+ /// The filename that stores the ior of the server
const ACE_TCHAR* ior_file_name_;
- // The filename that stores the ior of the server
+ /// Nickname of the user chatting.
ACE_CString nickname_;
- // Nickname of the user chatting.
+ /// Our orb.
TAO_ORB_Manager orb_manager_;
- // Our orb.
+ /// Server object ptr.
Broadcaster_var server_;
- // Server object ptr.
+ /// The receiver object.
typedef TAO_Intrusive_Ref_Count_Handle<Receiver_i> Receiver_i_var;
Receiver_i_var receiver_i_;
- // The receiver object.
+ /// Pointer to the receiver object registered with the ORB.
Receiver_var receiver_var_;
- // Pointer to the receiver object registered with the ORB.
};
#define QUIT_STRING "quit"
diff --git a/TAO/examples/Simple/chat/Receiver_i.cpp b/TAO/examples/Simple/chat/Receiver_i.cpp
index 4156bd8dd78..af8099f89a1 100644
--- a/TAO/examples/Simple/chat/Receiver_i.cpp
+++ b/TAO/examples/Simple/chat/Receiver_i.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Receiver_i.cpp
-//
-// = DESCRIPTION
-// Implements the Receiver_i class, which is used by the chat client.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Receiver_i.cpp
+ *
+ * $Id$
+ *
+ * Implements the Receiver_i class, which is used by the chat client.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Receiver_i.h"
diff --git a/TAO/examples/Simple/chat/Receiver_i.h b/TAO/examples/Simple/chat/Receiver_i.h
index 5b07f53e877..9f0bde342c4 100644
--- a/TAO/examples/Simple/chat/Receiver_i.h
+++ b/TAO/examples/Simple/chat/Receiver_i.h
@@ -1,56 +1,57 @@
/* -*- C++ -*- */
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Receiver_i.h
-//
-// = DESCRIPTION
-// Defines the implementation header for the Receiver interface.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Receiver_i.h
+ *
+ * $Id$
+ *
+ * Defines the implementation header for the Receiver interface.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef RECEIVER_I_H
#define RECEIVER_I_H
#include "ReceiverS.h"
+/**
+ * @class Receiver_i
+ *
+ * @brief Receiver object implementation
+ *
+ * This class has methods that are called by the chat server.
+ */
class Receiver_i : public POA_Receiver
{
- // = TITLE
- // Receiver object implementation
- //
- // = DESCRIPTION
- // This class has methods that are called by the chat server.
public:
// = Initialization and termination methods.
+ /// Constructor.
Receiver_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Receiver_i (void);
- // Destructor.
+ /// Receives a message string.
virtual void message (const char *msg);
- // Receives a message string.
+ /**
+ * Called when the chat server is going away. The client
+ * implementation should shutdown the chat client in response to
+ * this.
+ */
virtual void shutdown (void);
- // Called when the chat server is going away. The client
- // implementation should shutdown the chat client in response to
- // this.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
};
#endif /* RECEIVER_I_H */
diff --git a/TAO/examples/Simple/chat/Server.h b/TAO/examples/Simple/chat/Server.h
index 4d47a8bf73d..213a914ef03 100644
--- a/TAO/examples/Simple/chat/Server.h
+++ b/TAO/examples/Simple/chat/Server.h
@@ -1,18 +1,14 @@
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Server.h
-//
-// = DESCRIPTION
-// Definition of the Server class for the chat.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Server.h
+ *
+ * $Id$
+ *
+ * Definition of the Server class for the chat.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
diff --git a/TAO/examples/Simple/chat/Server_i.cpp b/TAO/examples/Simple/chat/Server_i.cpp
index 53bca0ca320..c23bb8ab738 100644
--- a/TAO/examples/Simple/chat/Server_i.cpp
+++ b/TAO/examples/Simple/chat/Server_i.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Server_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the Chat Server_i class.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+
+//=============================================================================
+/**
+ * @file Server_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the Chat Server_i class.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Server_i.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/examples/Simple/chat/Server_i.h b/TAO/examples/Simple/chat/Server_i.h
index ee16b3dec7b..dd1e4562473 100644
--- a/TAO/examples/Simple/chat/Server_i.h
+++ b/TAO/examples/Simple/chat/Server_i.h
@@ -1,22 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// Server_i.h
-//
-// = DESCRIPTION
-// Definition of the Chat Server_i class.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file Server_i.h
+ *
+ * $Id$
+ *
+ * Definition of the Chat Server_i class.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVER_I_H
#define SERVER_I_H
@@ -25,44 +21,47 @@
#include "tao/Utils/ORB_Manager.h"
#include "tao/Intrusive_Ref_Count_Handle_T.h"
+/**
+ * @class Server_i
+ *
+ * @brief The class defines the server for the chat. It sets up the Orb
+ * manager and registers the Broadcaster servant object.
+ */
class Server_i
{
- // = TITLE
- // The class defines the server for the chat. It sets up the Orb
- // manager and registers the Broadcaster servant object.
public:
// = Initialization and termination methods.
+ /// Constructor.
Server_i (void);
- // Constructor.
+ /// Destructor.
~Server_i (void);
- // Destructor.
+ /// Initialize the server.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the server.
+ /// Run the ORB.
int run (void);
- // Run the ORB.
private:
+ /// Parses the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
+ /// Writes the server ior to a file, for the clients to pick up
+ /// later.
int write_IOR (const char *ior);
- // Writes the server ior to a file, for the clients to pick up
- // later.
+ /// The file name to save the ior to.
const ACE_TCHAR *ior_file_name_;
- // The file name to save the ior to.
+ /// The tao orb manager object.
TAO_ORB_Manager orb_manager_;
- // The tao orb manager object.
+ /// The servant object registered with the orb.
typedef TAO_Intrusive_Ref_Count_Handle<Broadcaster_i> Broadcaster_i_var;
Broadcaster_i_var broadcaster_i_;
- // The servant object registered with the orb.
};
#endif /* SERVER_I_H */
diff --git a/TAO/examples/Simple/chat/client.cpp b/TAO/examples/Simple/chat/client.cpp
index eb9d881440d..e59b3303a44 100644
--- a/TAO/examples/Simple/chat/client.cpp
+++ b/TAO/examples/Simple/chat/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// The Chat client program entry point.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * The Chat client program entry point.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Client_i.h"
diff --git a/TAO/examples/Simple/chat/server.cpp b/TAO/examples/Simple/chat/server.cpp
index e8913f11f21..f9aafeffeaf 100644
--- a/TAO/examples/Simple/chat/server.cpp
+++ b/TAO/examples/Simple/chat/server.cpp
@@ -1,21 +1,17 @@
-// $Id$
-// ===========================================================
-//
-//
-// = LIBRARY
-// TAO/tests/Simple/chat
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Entry point for the chat server.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ===========================================================
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Entry point for the chat server.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Server_i.h"
diff --git a/TAO/examples/Simple/echo/Echo_Client_i.h b/TAO/examples/Simple/echo/Echo_Client_i.h
index 83a6e3bb063..0b888d80dab 100644
--- a/TAO/examples/Simple/echo/Echo_Client_i.h
+++ b/TAO/examples/Simple/echo/Echo_Client_i.h
@@ -1,22 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/echo
-//
-// = FILENAME
-// Echo_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-//
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Echo_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ECHO_CLIENT_I_H
#define ECHO_CLIENT_I_H
@@ -24,28 +20,30 @@
#include "../Simple_util.h"
#include "EchoC.h"
+/**
+ * @class Echo_Client_i
+ *
+ * @brief Echo_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Echo_Client_i
{
- // = TITLE
- // Echo_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Echo_Client_i (void);
- // Constructor
+ /// Destructor
~Echo_Client_i (void);
- // Destructor
+ /// Execute the methods
int run (const char *, int, ACE_TCHAR **);
- // Execute the methods
private:
+ /// Instantiate the client object.
Client<Echo> client_;
- // Instantiate the client object.
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Simple/echo/Echo_i.h b/TAO/examples/Simple/echo/Echo_i.h
index b048eeb8357..5afd29de0b1 100644
--- a/TAO/examples/Simple/echo/Echo_i.h
+++ b/TAO/examples/Simple/echo/Echo_i.h
@@ -1,63 +1,62 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/echo
-//
-// = FILENAME
-// Echo_i.h
-//
-// = DESCRIPTION
-// This class implements the Echo IDL interface.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Echo_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Echo IDL interface.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ECHO_I_H
#define ECHO_I_H
#include "EchoS.h"
+/**
+ * @class Echo_i
+ *
+ * @brief Echo Object Implementation
+ *
+ * The object implementation performs teh following functions:
+ * -- To return the string which needs to be displayed
+ * from the server.
+ * -- shuts down the server
+ */
class Echo_i : public POA_Echo
{
- // = TITLE
- // Echo Object Implementation
- //
- // = DESCRIPTION
- // The object implementation performs teh following functions:
- // -- To return the string which needs to be displayed
- // from the server.
- // -- shuts down the server
public:
// = Initialization and termination methods.
+ /// Constructor.
Echo_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Echo_i (void);
- // Destructor.
+ /// Return the mesg string back from the server.
virtual Echo::List *echo_list (const char *mesg);
- // Return the mesg string back from the server.
+ /// Return the mesg string back from the server.
virtual char *echo_string (const char *mesg);
- // Return the mesg string back from the server.
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// Keeping g++ 2.7.2 happy..
ACE_UNIMPLEMENTED_FUNC (void operator= (const Echo_i&))
- // Keeping g++ 2.7.2 happy..
};
#endif /* ECHO_I_H */
diff --git a/TAO/examples/Simple/grid/Grid_Client_i.h b/TAO/examples/Simple/grid/Grid_Client_i.h
index 44cf36693a0..7359921ffd0 100644
--- a/TAO/examples/Simple/grid/Grid_Client_i.h
+++ b/TAO/examples/Simple/grid/Grid_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/grid
-//
-// = FILENAME
-// Grid_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Grid_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef GRID_CLIENT_I_H
#define GRID_CLIENT_I_H
@@ -23,46 +20,48 @@
#include "../Simple_util.h"
#include "GridC.h"
+/**
+ * @class Grid_Client_i
+ *
+ * @brief Grid_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Grid_Client_i
{
- // = TITLE
- // Grid_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Grid_Client_i (void);
- // Constructor
+ /// Destructor
~Grid_Client_i (void);
- // Destructor
+ /// Execute the methods.
int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
+ /// Parses the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
private:
+ /// Instantiate the client object.
Client<Grid_Factory> client_;
- // Instantiate the client object.
+ /// Height of the grid.
CORBA::Short height_;
- // Height of the grid.
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short setx_;
- // Cell identifier in which a value meeds to be stored.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short sety_;
- // Cell identifier in which a value meeds to be stored.
+ /// The value that needs to be stored in the cell.
CORBA::Long value_;
- // The value that needs to be stored in the cell.
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Simple/grid/Grid_i.h b/TAO/examples/Simple/grid/Grid_i.h
index c9055d55408..72166422d8a 100644
--- a/TAO/examples/Simple/grid/Grid_i.h
+++ b/TAO/examples/Simple/grid/Grid_i.h
@@ -1,20 +1,17 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/grid
-//
-// = FILENAME
-// Grid_i.h
-//
-// = DESCRIPTION
-// This class implements the Grid IDL interface.
-//
-// = AUTHOR
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Grid_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Grid IDL interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef GRID_I_H
#define GRID_I_H
@@ -22,100 +19,105 @@
#include "GridS.h"
#include <ace/Vector_T.h>
+/**
+ * @class Grid_i:
+ *
+ * @brief Grid object implementation.
+ *
+ * Grid object implementation
+ */
class Grid_i: public POA_Grid
{
- // = TITLE
- // Grid object implementation.
- //
- // = DESCRIPTION
- // Grid object implementation
public:
// = Initialization and termination methods.
+ /// Constructor
Grid_i (void);
- // Constructor
+ /// Constructor.
Grid_i (CORBA::Short,
CORBA::Short);
- // Constructor.
+ /// Destructor
virtual ~Grid_i (void);
- // Destructor
+ /// Returns the width of the grid
virtual CORBA::Short width (void);
- // Returns the width of the grid
+ /// Returns the height of the grid
virtual CORBA::Short height (void);
- // Returns the height of the grid
+ /// Sets the width of the grid.
virtual void width (CORBA::Short);
- // Sets the width of the grid.
+ /// Sets the height of the grid.
virtual void height (CORBA::Short);
- // Sets the height of the grid.
+ /// Sets the grid value.
virtual void set (CORBA::Short,
CORBA::Short,
CORBA::Long);
- // Sets the grid value.
+ /// Gets the grid value.
virtual CORBA::Long get (CORBA::Short,
CORBA::Short);
- // Gets the grid value.
+ /// Destroy the grid.
virtual void destroy (void);
- // Destroy the grid.
private:
+ /// Allocates array
static CORBA::Long *allocate_array (CORBA::Short x, CORBA::Short y);
- // Allocates array
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Height of the grid.
CORBA::Short height_;
- // Height of the grid.
+ /// Pointer to the matrix. This is organized as an "array of arrays."
typedef ACE_Auto_Array_Ptr<CORBA::Long> GridArray;
GridArray array_;
- // Pointer to the matrix. This is organized as an "array of arrays."
+ /// Solaris and some Windows compilers don't have min in std namespaces
static CORBA::UShort ushort_min (CORBA::UShort, CORBA::UShort);
- // Solaris and some Windows compilers don't have min in std namespaces
};
+/**
+ * @class Grid_Factory_i
+ *
+ * Create a <Grid>.
+ */
class Grid_Factory_i : public POA_Grid_Factory
{
- // =TITLE
- // Create a <Grid>.
public:
// = Initialization and termination methods.
+ /// Constructor.
Grid_Factory_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Grid_Factory_i (void);
- // Destructor.
+ /// This function creates and returns a <Grid>.
virtual Grid_ptr make_grid (CORBA::Short,
CORBA::Short);
- // This function creates and returns a <Grid>.
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// This container is here only for proper clean up.
typedef ACE_Vector<PortableServer::ServantBase_var> GridsHolder;
GridsHolder grids_holder_;
- // This container is here only for proper clean up.
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// Keeping g++2.7.2
ACE_UNIMPLEMENTED_FUNC (void operator= (const Grid_Factory_i &))
- // Keeping g++2.7.2
};
#endif /* GRID_I_H */
diff --git a/TAO/examples/Simple/time-date/Time_Date_Client_i.h b/TAO/examples/Simple/time-date/Time_Date_Client_i.h
index fffad2111d6..cb1562d4d4b 100644
--- a/TAO/examples/Simple/time-date/Time_Date_Client_i.h
+++ b/TAO/examples/Simple/time-date/Time_Date_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/time-date
-//
-// = FILENAME
-// Time_Date_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-// Douglas C. Schmidt <schmidt@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Time_Date_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TIME_DATE_CLIENT_I_H
#define TIME_DATE_CLIENT_I_H
@@ -23,31 +20,33 @@
#include "../Simple_util.h"
#include "Time_DateC.h"
+/**
+ * @class Time_Date_Client_i
+ *
+ * @brief Time_Date_Client interface adapter.
+ *
+ * This class implements the interface between the interface
+ * objects and the client.
+ */
class Time_Date_Client_i
{
- // = TITLE
- // Time_Date_Client interface adapter.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client.
public:
// = Initialization and termination methods.
+ /// Constructor
Time_Date_Client_i (void);
- // Constructor
+ /// Destructor
virtual ~Time_Date_Client_i (void);
- // Destructor
+ /// Execute the methods.
virtual int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
+ /// Parses the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
private:
+ /// Instantiate the client object.
Client<Time_Date> client_;
- // Instantiate the client object.
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Simple/time-date/Time_Date_i.h b/TAO/examples/Simple/time-date/Time_Date_i.h
index 47e9ef6c792..6b0f1280b65 100644
--- a/TAO/examples/Simple/time-date/Time_Date_i.h
+++ b/TAO/examples/Simple/time-date/Time_Date_i.h
@@ -1,22 +1,18 @@
// -*- C++ -*-
-//
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Simple/time_date
-//
-// = FILENAME
-// Time_Date_i.h
-//
-// = DESCRIPTION
-// This class implements the Time_Date IDL interface.
-//
-// = AUTHOR
-// Douglas C. Schmidt <schmidt@cs.wustl.edu> and Michael Kircher.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Time_Date_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Time_Date IDL interface.
+ *
+ *
+ * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> and Michael Kircher.
+ */
+//=============================================================================
+
#ifndef TIME_DATE_I_H
#define TIME_DATE_I_H
@@ -34,21 +30,21 @@ class Time_Date_i
public:
// = Initialization and termination methods.
+ /// Obtain the time and date in binary format.
virtual void bin_date (CORBA::Long_out time_date);
- // Obtain the time and date in binary format.
+ /// Obtain the time and date in string format.
virtual void str_date (CORBA::String_out time_date);
- // Obtain the time and date in string format.
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// ORB pointer.
void orb (CORBA::ORB_ptr orb_ptr);
- // ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_var_;
- // ORB pointer.
};
#endif /* TIME_DATE_I_H */
diff --git a/TAO/examples/Simple/time-date/server.cpp b/TAO/examples/Simple/time-date/server.cpp
index 9d2768b8037..e89de067dc5 100644
--- a/TAO/examples/Simple/time-date/server.cpp
+++ b/TAO/examples/Simple/time-date/server.cpp
@@ -1,22 +1,19 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// examples/Simple/time-date
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This directory contains an example that illustrates how the ACE
-// Service Configurator can dynamically configure an ORB and its
-// servants from a svc.conf file.
-//
-// = AUTHOR
-// Doug Schmidt <schmidt@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This directory contains an example that illustrates how the ACE
+ * Service Configurator can dynamically configure an ORB and its
+ * servants from a svc.conf file.
+ *
+ *
+ * @author Doug Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/Service_Config.h"
#include "ace/Reactor.h"
diff --git a/TAO/examples/Simple/time/Time_Client_i.h b/TAO/examples/Simple/time/Time_Client_i.h
index 75c84948927..41d46e1d306 100644
--- a/TAO/examples/Simple/time/Time_Client_i.h
+++ b/TAO/examples/Simple/time/Time_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/time
-//
-// = FILENAME
-// Time_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the client calls to the Time example.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Time_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the client calls to the Time example.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TIME_CLIENT_I_H
#define TIME_CLIENT_I_H
@@ -23,28 +20,30 @@
#include "../Simple_util.h"
#include "TimeC.h"
+/**
+ * @class Time_Client_i
+ *
+ * @brief Time_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client.
+ */
class Time_Client_i
{
- // = TITLE
- // Time_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client.
public:
// = Initialization and termination methods.
+ /// Constructor
Time_Client_i (void);
- // Constructor
+ /// Destructor
~Time_Client_i (void);
- // Destructor
+ /// Execute the methods
int run (const char *, int, ACE_TCHAR**);
- // Execute the methods
private:
+ /// Instantiate the client object.
Client<Time> client_;
- // Instantiate the client object.
};
#endif /* TIME_CLIENT_I_H */
diff --git a/TAO/examples/Simple/time/Time_i.h b/TAO/examples/Simple/time/Time_i.h
index 9d1c0a74c5b..2260d52a185 100644
--- a/TAO/examples/Simple/time/Time_i.h
+++ b/TAO/examples/Simple/time/Time_i.h
@@ -1,59 +1,58 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/time
-//
-// = FILENAME
-// Time_i.h
-//
-// = DESCRIPTION
-// This class implements the Time IDL interface.
-//
-// = AUTHOR
-// Darrell Brunsch <brunsch@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Time_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Time IDL interface.
+ *
+ *
+ * @author Darrell Brunsch <brunsch@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TIME_I_H
#define TIME_I_H
#include "TimeS.h"
+/**
+ * @class Time_i:
+ *
+ * @brief Time Object Implementation
+ *
+ * Implementation of a simple object that has two methods, one that
+ * return the current time/date on the server and the other that
+ * shuts down the server.
+ */
class Time_i: public POA_Time
{
- // = TITLE
- // Time Object Implementation
- //
- // = DESCRIPTION
- // Implementation of a simple object that has two methods, one that
- // return the current time/date on the server and the other that
- // shuts down the server.
public:
// = Initialization and termination methods.
+ /// Constructor
Time_i (void);
- // Constructor
+ /// Destructor
virtual ~Time_i (void);
- // Destructor
+ /// Return the current time/date on the server
virtual CORBA::Long current_time (void);
- // Return the current time/date on the server
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
+ /// Keeping g++2.7.2
ACE_UNIMPLEMENTED_FUNC (void operator= (const Time_i &))
- // Keeping g++2.7.2
};
#endif /* TIME_I_H */
diff --git a/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.cpp b/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.cpp
index 3a4c016a77c..21322c09a05 100644
--- a/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.cpp
+++ b/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// DOVE_Supplier.cpp
-//
-// = DESCRIPTION
-// A wrapper around the event service initialization and
-// marshalling
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file DOVE_Supplier.cpp
+ *
+ * $Id$
+ *
+ * A wrapper around the event service initialization and
+ * marshalling
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "DOVE_Supplier.h"
#include "tao/ORB_Core.h"
diff --git a/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.h b/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.h
index c1e1e6b7764..68730f98e1d 100644
--- a/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.h
+++ b/TAO/examples/Simulator/Event_Supplier/DOVE_Supplier.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// DOVE_Supplier.h
-//
-// = DESCRIPTION
-// A wrapper around the event service initialization and marshalling.
-//
-// = AUTHORS
-// Michael Kircher (mk1@cs.wustl.edu)
-// Chris Gill (cdgill@cs.wustl.edu)
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file DOVE_Supplier.h
+ *
+ * $Id$
+ *
+ * A wrapper around the event service initialization and marshalling.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu) Chris Gill (cdgill@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "orbsvcs/RtecEventChannelAdminC.h"
@@ -34,35 +34,35 @@ class DOVE_Supplier
{
public:
+ /// Constructor.
DOVE_Supplier ();
- // Constructor.
+ /// Destructor.
~DOVE_Supplier (void);
- // Destructor.
+ /// Initialize the ORB and the connection to the Name Service
int init (void);
- // Initialize the ORB and the connection to the Name Service
+ /// Connect to the event service.
int connect (const char * MIB_name = 0,
const char* es_name = 0,
const char * ss_name = 0,
ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info = 0);
- // Connect to the event service.
+ /// Perform all post-connection-establishment processing.
void connected ();
- // Perform all post-connection-establishment processing.
+ /// Disconnect from the event service.
void disconnect ();
- // Disconnect from the event service.
+ /// Notify the consumer proxy that we have events
void notify (CORBA::Any& message);
- // Notify the consumer proxy that we have events
+ /// Use the next connection in the list of established connections.
void use_next_connection ();
- // Use the next connection in the list of established connections.
+ /// Use the previous connection in the list of established connections.
void use_prev_connection ();
- // Use the previous connection in the list of established connections.
private:
@@ -100,17 +100,17 @@ private:
ACE_Scheduler_Factory::POD_RT_Info pod_rt_info_;
};
+ /// Get the event channel reference.
int get_EventChannel ();
- // Get the event channel reference.
+ /// Get the scheduler reference.
int get_Scheduler ();
- // Get the scheduler reference.
+ /// Connect the the supplier with the event channel.
int connect_Supplier ();
- // Connect the the supplier with the event channel.
+ /// Access the default rt_info singleton.
static ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info_instance ();
- // Access the default rt_info singleton.
static ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info_instance_;
@@ -130,8 +130,8 @@ private:
Internal_DOVE_Supplier* internal_DOVE_Supplier_ptr_;
+ /// Keep the name of the MIB around.
const char * MIB_name_;
- // Keep the name of the MIB around.
};
#endif /* DOVE_SUPPLIER_H */
diff --git a/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.cpp b/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.cpp
index e7ee5055e28..fcdf12bba92 100644
--- a/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.cpp
+++ b/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.cpp
@@ -1,25 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// DualEC_Sup.cpp
-//
-// = DESCRIPTION
-// Event Supplier for visualizing scheduling behavior, using arrival
-// and dispatch data logged by an event channel dispatch command object
-//
-// = AUTHOR
-// Chris Gill (cdgill@cs.wustl.edu)
-//
-// Adapted from the DOVE simulation event supplier
-// originally
-// David Levine (levine@cs.wustl.edu) and
-// Tim Harrison (harrison@cs.wustl.edu)
-// modified
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file DualEC_Sup.cpp
+ *
+ * $Id$
+ *
+ * Event Supplier for visualizing scheduling behavior, using arrival
+ * and dispatch data logged by an event channel dispatch command object
+ *
+ *
+ * @author Chris Gill (cdgill@cs.wustl.edu) Adapted from the DOVE simulation event supplier originally David Levine (levine@cs.wustl.edu) and Tim Harrison (harrison@cs.wustl.edu) modified Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "DualEC_Sup.h"
#include "NavWeapC.h"
diff --git a/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.h b/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.h
index 0762d2b31f6..0cba4a31d20 100644
--- a/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.h
+++ b/TAO/examples/Simulator/Event_Supplier/DualEC_Sup.h
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// DualEC_Sup.h
-//
-// = DESCRIPTION
-// Event supplier for visualization of scheduling behavior, using
-// arrival and dispatch data logged by an EC dispatch command object
-//
-// = AUTHOR
-// Chris Gill (cdgill@cs.wustl.edu)
-//
-// Adapted from the orginal DOVE simulation event supplier written by
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file DualEC_Sup.h
+ *
+ * $Id$
+ *
+ * Event supplier for visualization of scheduling behavior, using
+ * arrival and dispatch data logged by an EC dispatch command object
+ *
+ *
+ * @author Chris Gill (cdgill@cs.wustl.edu) Adapted from the orginal DOVE simulation event supplier written by Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef DUALEC_SUP_H
#define DUALEC_SUP_H
@@ -43,66 +40,71 @@ struct Schedule_Viewer_Data
};
+/**
+ * @class DualEC_Supplier
+ *
+ * @brief Event Supplier.
+ *
+ * Reads information out of a file and
+ * feeds it with additional navigation and
+ * weapon data into the dove_supplier, which
+ * is connected to the event channel
+ */
class DualEC_Supplier
{
- // = TITLE
- // Event Supplier.
- //
- // = DESCRIPTION
- // Reads information out of a file and
- // feeds it with additional navigation and
- // weapon data into the dove_supplier, which
- // is connected to the event channel
public:
DualEC_Supplier (int argc, ACE_TCHAR** argv);
~DualEC_Supplier (void);
+ /// Initialize: set up, resolve ORB services,
+ /// connect the DOVE_Suppliers.
int init (void);
- // Initialize: set up, resolve ORB services,
- // connect the DOVE_Suppliers.
+ /// Compute schedule priorities, possibly dump
+ /// data into runtime scheduler header files.
void compute_schedules (void);
- // Compute schedule priorities, possibly dump
- // data into runtime scheduler header files.
+ /// here is really something going on,
+ /// here we deliver the messages
void start_generating_events (void);
- // here is really something going on,
- // here we deliver the messages
+ /// Load the scheduling information into memory
void load_schedule_data ();
- // Load the scheduling information into memory
private:
+/**
+ * @class Terminator
+ *
+ * Private class that implements a termination servant.
+ */
class Terminator : public POA_NavWeapTerminator
- // = DESCRIPTION
- // Private class that implements a termination servant.
{
void shutdown (void);
};
+ /// Run the orb event loop.
static ACE_THR_FUNC_RETURN run_orb (void *);
- // Run the orb event loop.
+ /// Run navigation event generation thread.
static ACE_THR_FUNC_RETURN run_nav_thread (void *arg);
- // Run navigation event generation thread.
+ /// Run weapons event generation thread.
static ACE_THR_FUNC_RETURN run_weap_thread (void *arg);
- // Run weapons event generation thread.
+ /// Create two scheduling service instances, registers
+ /// them with the Naming Service.
int create_schedulers (void);
- // Create two scheduling service instances, registers
- // them with the Naming Service.
+ /// Create two event service instances, registers
+ /// them with the Naming Service.
int create_event_channels (void);
- // Create two event service instances, registers
- // them with the Naming Service.
+ /// Get command line options.
unsigned int get_options (int argc, ACE_TCHAR *argv []);
- // Get command line options.
// Time values to pause before notifying the supplier each time.
ACE_Time_Value nav_pause_;
diff --git a/TAO/examples/Simulator/Event_Supplier/Event_Con.cpp b/TAO/examples/Simulator/Event_Supplier/Event_Con.cpp
index 5c1d36578b9..9bf83416e8d 100644
--- a/TAO/examples/Simulator/Event_Supplier/Event_Con.cpp
+++ b/TAO/examples/Simulator/Event_Supplier/Event_Con.cpp
@@ -1,26 +1,22 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Event_Con.cpp
-//
-// = DESCRIPTION
-// This demo just tests the basic functionality of the Event Service
-// One Conumer which inherits from the Rtec Consumer. One Supplier
-// with an internal Rtec Consumer and one internal Rtec Supplier.
-// The internal Supplier is just a demo supplier because the
-// architecture expects an supplier which has inherited from the
-// Rtec Supplier.
-//
-// = AUTHOR
-// originally
-// David Levine (levine@cs.wustl.edu) and
-// Tim Harrison (harrison@cs.wustl.edu)
-// modified
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Event_Con.cpp
+ *
+ * $Id$
+ *
+ * This demo just tests the basic functionality of the Event Service
+ * One Conumer which inherits from the Rtec Consumer. One Supplier
+ * with an internal Rtec Consumer and one internal Rtec Supplier.
+ * The internal Supplier is just a demo supplier because the
+ * architecture expects an supplier which has inherited from the
+ * Rtec Supplier.
+ *
+ *
+ * @author originally David Levine (levine@cs.wustl.edu) and Tim Harrison (harrison@cs.wustl.edu) modified Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Event_Con.h"
#include "NavWeapC.h"
diff --git a/TAO/examples/Simulator/Event_Supplier/Event_Con.h b/TAO/examples/Simulator/Event_Supplier/Event_Con.h
index 89c2b4cd905..b89a1962a67 100644
--- a/TAO/examples/Simulator/Event_Supplier/Event_Con.h
+++ b/TAO/examples/Simulator/Event_Supplier/Event_Con.h
@@ -1,18 +1,14 @@
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Event_Con.h
-//
-// = AUTHOR
-// originally
-// David Levine (levine@cs.wustl.edu) and
-// Tim Harrison (harrison@cs.wustl.edu)
-// modified
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Event_Con.h
+ *
+ * $Id$
+ *
+ * @author originally David Levine (levine@cs.wustl.edu) and Tim Harrison (harrison@cs.wustl.edu) modified Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EVENT_CON_H
#define EVENT_CON_H
@@ -27,37 +23,43 @@
#include "orbsvcs/RtecEventCommS.h"
#include "orbsvcs/RtecSchedulerC.h"
+/**
+ * @class Demo_Consumer
+ *
+ * @brief Demo Consumer
+ *
+ * Simple example of a consumer that registers for supplier
+ * notifications.
+ */
class Demo_Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Demo Consumer
- //
- // = DESCRIPTION
- // Simple example of a consumer that registers for supplier
- // notifications.
public:
Demo_Consumer (void);
+ /**
+ * Uses the name server to obtain a reference to the <supplier_name>
+ * and registers with channel to receive notifications from the
+ * supplier. Also registers to receive shutdown messages from the
+ * supplier. Stores <my_name> for printing out messages. Returns 0
+ * on success, -1 on failure.
+ */
int open_consumer (RtecEventChannelAdmin::EventChannel_ptr ec,
const char *my_name);
- // Uses the name server to obtain a reference to the <supplier_name>
- // and registers with channel to receive notifications from the
- // supplier. Also registers to receive shutdown messages from the
- // supplier. Stores <my_name> for printing out messages. Returns 0
- // on success, -1 on failure.
+ /// The channel is disconnecting.
virtual void disconnect_push_consumer (void);
- // The channel is disconnecting.
// = (not protected to allow short-circuiting) protected:
+ /**
+ * If the <events>[0] is a notification, prints out the data from
+ * the supplier. If its a shutdown message, the consumer
+ * disconnects from the channel.
+ */
virtual void push (const RtecEventComm::EventSet &events);
- // If the <events>[0] is a notification, prints out the data from
- // the supplier. If its a shutdown message, the consumer
- // disconnects from the channel.
protected:
+ /// Disconnect from the Event Service.
void shutdown (void);
- // Disconnect from the Event Service.
// = Event channel adminstration references.
RtecEventChannelAdmin::EventChannel_var channel_admin_;
diff --git a/TAO/examples/Simulator/Event_Supplier/Event_Sup.cpp b/TAO/examples/Simulator/Event_Supplier/Event_Sup.cpp
index ab2d5110bdb..6eb162dc74d 100644
--- a/TAO/examples/Simulator/Event_Supplier/Event_Sup.cpp
+++ b/TAO/examples/Simulator/Event_Supplier/Event_Sup.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Event_Sup.cpp
-//
-// = DESCRIPTION
-// Event Supplier for the flight simulator
-//
-// = AUTHOR
-// originally
-// David Levine (levine@cs.wustl.edu) and
-// Tim Harrison (harrison@cs.wustl.edu)
-// modified
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Event_Sup.cpp
+ *
+ * $Id$
+ *
+ * Event Supplier for the flight simulator
+ *
+ *
+ * @author originally David Levine (levine@cs.wustl.edu) and Tim Harrison (harrison@cs.wustl.edu) modified Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Event_Sup.h"
#include "NavWeapC.h"
diff --git a/TAO/examples/Simulator/Event_Supplier/Event_Sup.h b/TAO/examples/Simulator/Event_Supplier/Event_Sup.h
index 194bbbf4ab8..96a0e2a33ae 100644
--- a/TAO/examples/Simulator/Event_Supplier/Event_Sup.h
+++ b/TAO/examples/Simulator/Event_Supplier/Event_Sup.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Event_Sup.h
-//
-// = DESCRIPTION
-// Event Supplier for the simulation
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Event_Sup.h
+ *
+ * $Id$
+ *
+ * Event Supplier for the simulation
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EVENT_SUP_H
#define EVENT_SUP_H
@@ -32,37 +32,39 @@ struct Schedule_Viewer_Data
u_long computation_time;
};
+/**
+ * @class Event_Supplier
+ *
+ * @brief Event Supplier.
+ *
+ * Reads Scheduler information out of a file and
+ * feeds it with additional navigation and
+ * weapon data into the dove_supplier, which
+ * is connected to the event channel
+ */
class Event_Supplier
{
- // = TITLE
- // Event Supplier.
- //
- // = DESCRIPTION
- // Reads Scheduler information out of a file and
- // feeds it with additional navigation and
- // weapon data into the dove_supplier, which
- // is connected to the event channel
public:
Event_Supplier (int argc, ACE_TCHAR** argv);
~Event_Supplier (void);
+ /// connect the DOVE_Supplier
int init (void);
- // connect the DOVE_Supplier
+ /// here is really something going on,
+ /// here we deliver the messages
void start_generating_events (void);
- // here is really something going on,
- // here we deliver the messages
+ /// Load the scheduling information into memory
void load_schedule_data (ACE_Unbounded_Queue<Schedule_Viewer_Data *> &schedule_data);
- // Load the scheduling information into memory
private:
+ /// just a helper to put all the information into the CORBA::Any
void insert_event_data (CORBA::Any &data,
ACE_Unbounded_Queue_Iterator<Schedule_Viewer_Data *> &schedule_iter);
- // just a helper to put all the information into the CORBA::Any
unsigned int get_options (int argc, ACE_TCHAR *argv []);
diff --git a/TAO/examples/Simulator/Event_Supplier/Logging_Sup.cpp b/TAO/examples/Simulator/Event_Supplier/Logging_Sup.cpp
index b7663a2bd0f..72901acca3e 100644
--- a/TAO/examples/Simulator/Event_Supplier/Logging_Sup.cpp
+++ b/TAO/examples/Simulator/Event_Supplier/Logging_Sup.cpp
@@ -1,25 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Logging_Sup.cpp
-//
-// = DESCRIPTION
-// Event Supplier for visualizing scheduling behavior, using arrival
-// and dispatch data logged by an event channel dispatch command object
-//
-// = AUTHOR
-// Chris Gill (cdgill@cs.wustl.edu)
-//
-// Adapted from the DOVE simulation event supplier
-// originally
-// David Levine (levine@cs.wustl.edu) and
-// Tim Harrison (harrison@cs.wustl.edu)
-// modified
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Logging_Sup.cpp
+ *
+ * $Id$
+ *
+ * Event Supplier for visualizing scheduling behavior, using arrival
+ * and dispatch data logged by an event channel dispatch command object
+ *
+ *
+ * @author Chris Gill (cdgill@cs.wustl.edu) Adapted from the DOVE simulation event supplier originally David Levine (levine@cs.wustl.edu) and Tim Harrison (harrison@cs.wustl.edu) modified Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Logging_Sup.h"
#include "NavWeapC.h"
diff --git a/TAO/examples/Simulator/Event_Supplier/Logging_Sup.h b/TAO/examples/Simulator/Event_Supplier/Logging_Sup.h
index 208be88cde7..0443c94324b 100644
--- a/TAO/examples/Simulator/Event_Supplier/Logging_Sup.h
+++ b/TAO/examples/Simulator/Event_Supplier/Logging_Sup.h
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Logging_Sup.h
-//
-// = DESCRIPTION
-// Event supplier for visualization of scheduling behavior, using
-// arrival and dispatch data logged by an EC dispatch command object
-//
-// = AUTHOR
-// Chris Gill (cdgill@cs.wustl.edu)
-//
-// Adapted from the orginal DOVE simulation event supplier written by
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Logging_Sup.h
+ *
+ * $Id$
+ *
+ * Event supplier for visualization of scheduling behavior, using
+ * arrival and dispatch data logged by an EC dispatch command object
+ *
+ *
+ * @author Chris Gill (cdgill@cs.wustl.edu) Adapted from the orginal DOVE simulation event supplier written by Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef LOGGING_SUP_H
#define LOGGING_SUP_H
@@ -36,37 +33,39 @@ struct Schedule_Viewer_Data
u_long computation_time;
};
+/**
+ * @class Logging_Supplier
+ *
+ * @brief Event Supplier.
+ *
+ * Reads Scheduler information out of a file and
+ * feeds it with additional navigation and
+ * weapon data into the dove_supplier, which
+ * is connected to the event channel
+ */
class Logging_Supplier
{
- // = TITLE
- // Event Supplier.
- //
- // = DESCRIPTION
- // Reads Scheduler information out of a file and
- // feeds it with additional navigation and
- // weapon data into the dove_supplier, which
- // is connected to the event channel
public:
Logging_Supplier (int argc, ACE_TCHAR** argv);
~Logging_Supplier (void);
+ /// connect the DOVE_Supplier
int init (void);
- // connect the DOVE_Supplier
+ /// here is really something going on,
+ /// here we deliver the messages
void start_generating_events (void);
- // here is really something going on,
- // here we deliver the messages
+ /// Load the scheduling information into memory
void load_schedule_data (ACE_Unbounded_Queue<Schedule_Viewer_Data *> &schedule_data);
- // Load the scheduling information into memory
private:
+ /// just a helper to put all the information into the CORBA::Any
void insert_event_data (CORBA::Any &data,
ACE_Unbounded_Queue_Iterator<Schedule_Viewer_Data *> &schedule_iter);
- // just a helper to put all the information into the CORBA::Any
unsigned int get_options (int argc, ACE_TCHAR *argv []);
diff --git a/TAO/examples/ior_corbaloc/client.cpp b/TAO/examples/ior_corbaloc/client.cpp
index 828c18a5efe..95cb1c92879 100644
--- a/TAO/examples/ior_corbaloc/client.cpp
+++ b/TAO/examples/ior_corbaloc/client.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaloc/
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This implements a simple CORBA client for the
-// corbaloc: style IOR parser
-//
-// = AUTHOR
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This implements a simple CORBA client for the
+ * corbaloc: style IOR parser
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "ior_corbaloc_client_i.h"
diff --git a/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.cpp b/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.cpp
index 4211452cc13..61d9191b29a 100644
--- a/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.cpp
+++ b/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaloc/
-//
-// = FILENAME
-// ior_corbaloc_client_i.cpp
-//
-// = DESCRIPTION
-// This example implements a simple client which sends a corbaloc:
-// style url to the server and gets a response from the
-// server to indicate that the server has received the request.
-//
-// = AUTHORS
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//============================================================
+
+//=============================================================================
+/**
+ * @file ior_corbaloc_client_i.cpp
+ *
+ * $Id$
+ *
+ * This example implements a simple client which sends a corbaloc:
+ * style url to the server and gets a response from the
+ * server to indicate that the server has received the request.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "ior_corbaloc_client_i.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.h b/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.h
index a4488b08a31..b58827ad65b 100644
--- a/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.h
+++ b/TAO/examples/ior_corbaloc/ior_corbaloc_client_i.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaloc/
-//
-// = FILENAME
-// ior_corbaloc_client_i.h
-//
-// = DESCRIPTION
-// This class implements a simple client which sends a corbaloc:
-// style url to the server and gets a response from the
-// server to indicate that the server has received the request.
-//
-// = AUTHORS
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//============================================================
+
+//=============================================================================
+/**
+ * @file ior_corbaloc_client_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple client which sends a corbaloc:
+ * style url to the server and gets a response from the
+ * server to indicate that the server has received the request.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#if !defined (IOR_CORBALOC_CLIENT_I_H)
#define IOR_CORBALOC_CLIENT_I_H
@@ -27,24 +24,25 @@
#include "ace/SString.h"
+/**
+ * @class IOR_corbaloc_Client_i
+ *
+ * @brief NContextExt Client Implementation
+ *
+ */
class IOR_corbaloc_Client_i
{
- // = TITLE
- // NContextExt Client Implementation
- //
- // = DESCRIPTION
- //
public:
// = Constructor and destructor.
IOR_corbaloc_Client_i (void);
~IOR_corbaloc_Client_i (void);
+ /// Execute the client example code.
int run (void);
- // Execute the client example code.
+ /// Initialize the client communication endpoint with the server.
int init (int& argc, ACE_TCHAR *argv[]);
- // Initialize the client communication endpoint with the server.
private:
/// corbaloc url to test