summaryrefslogtreecommitdiff
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
commit28cda3369d797a9d14c2f42bec09982068c7cbb4 (patch)
tree8c669040dc33a8daac94e5516e39e4c1115cc136
parentfb545b5251e19d89762043793dd0dceaafec01e4 (diff)
downloadATCD-28cda3369d797a9d14c2f42bec09982068c7cbb4.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:
-rw-r--r--TAO/ChangeLog922
-rw-r--r--TAO/TAO_IDL/be/be_visitor_array/array_ci.cpp31
-rw-r--r--TAO/TAO_IDL/be/be_visitor_exception/any_op_cs.cpp31
-rw-r--r--TAO/TAO_IDL/be/be_visitor_interface/any_op_cs.cpp33
-rw-r--r--TAO/TAO_IDL/be/be_visitor_interface/interface_ci.cpp31
-rw-r--r--TAO/TAO_IDL/be/be_visitor_root/root.cpp29
-rw-r--r--TAO/TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp33
-rw-r--r--TAO/TAO_IDL/be_include/be_helper.h6
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_argument/invoke_cs.h91
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_exception/ctor.h4
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_exception/ctor_assign.h4
-rw-r--r--TAO/TAO_IDL/be_include/be_visitor_exception/exception_ctor.h4
-rw-r--r--TAO/TAO_IDL/include/utl_idlist.h2
-rw-r--r--TAO/docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp30
-rw-r--r--TAO/docs/tutorials/Quoter/Simple/Persistent/server.cpp32
-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
-rw-r--r--TAO/interop-tests/wchar/client.cpp29
-rw-r--r--TAO/interop-tests/wchar/server.cpp31
-rw-r--r--TAO/interop-tests/wchar/wchar_reference.cpp35
-rw-r--r--TAO/interop-tests/wchar/wchar_reference.h35
-rw-r--r--TAO/orbsvcs/IFR_Service/IFR_Service.h25
-rw-r--r--TAO/orbsvcs/IFR_Service/be_global.cpp32
-rw-r--r--TAO/orbsvcs/IFR_Service/be_global.h63
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_adding_visitor.h85
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_adding_visitor_exception.h69
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_adding_visitor_operation.h59
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_adding_visitor_structure.h55
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_adding_visitor_union.h63
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_removing_visitor.h53
-rw-r--r--TAO/orbsvcs/IFR_Service/ifr_visitor.h51
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp28
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.h34
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/Factory_Trader.cpp38
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/Factory_Trader.h36
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp28
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.h53
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp28
-rw-r--r--TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h49
-rw-r--r--TAO/orbsvcs/Naming_Service/NT_Naming_Server.cpp42
-rw-r--r--TAO/orbsvcs/Notify_Service/NT_Notify_Server.cpp45
-rw-r--r--TAO/orbsvcs/TAO_Service/TAO_Service.cpp33
-rw-r--r--TAO/orbsvcs/Time_Service/Clerk_i.h109
-rw-r--r--TAO/orbsvcs/Time_Service/Server_i.h71
-rw-r--r--TAO/orbsvcs/Trading_Service/Trading_Service.h56
-rw-r--r--TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h75
-rw-r--r--TAO/orbsvcs/examples/CosEC/Factory/FactoryDriver.h69
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h83
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h46
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h103
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h66
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h52
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h50
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h50
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h75
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h61
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h57
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h69
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h61
-rw-r--r--TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h51
-rw-r--r--TAO/orbsvcs/examples/CosEC/Simple/Consumer.h49
-rw-r--r--TAO/orbsvcs/examples/CosEC/Simple/Supplier.h43
-rw-r--r--TAO/orbsvcs/examples/Notify/Filter/Filter.h133
-rw-r--r--TAO/orbsvcs/examples/Notify/Subscribe/Subscribe.h117
-rw-r--r--TAO/orbsvcs/examples/RtEC/Kokyu/Consumer.h54
-rw-r--r--TAO/orbsvcs/examples/RtEC/Kokyu/Supplier.h75
-rw-r--r--TAO/orbsvcs/examples/RtEC/MCast/AddrServer.h53
-rw-r--r--TAO/orbsvcs/examples/RtEC/MCast/Consumer.h51
-rw-r--r--TAO/orbsvcs/examples/RtEC/MCast/Supplier.h53
-rw-r--r--TAO/orbsvcs/examples/RtEC/Schedule/Consumer.h54
-rw-r--r--TAO/orbsvcs/examples/RtEC/Schedule/Supplier.h54
-rw-r--r--TAO/orbsvcs/examples/RtEC/Simple/Consumer.h51
-rw-r--r--TAO/orbsvcs/examples/RtEC/Simple/Supplier.h45
-rw-r--r--TAO/orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h25
-rw-r--r--TAO/orbsvcs/examples/Security/Send_File/test_i.h40
-rw-r--r--TAO/orbsvcs/orbsvcs/Trader/Constraint_l.cpp24
-rw-r--r--TAO/orbsvcs/orbsvcs/Trader/Constraint_y.cpp14
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h75
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h120
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h103
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h92
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h113
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h116
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h77
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Component_Switching/distributer.h171
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Component_Switching/receiver.h120
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Component_Switching/sender.h137
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Latency/ping.h29
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Latency/pong.h33
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h111
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Multiple_Flows/sender.h100
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Pluggable/ftp.h137
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Pluggable/server.h85
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h89
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h100
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h128
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h89
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h96
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h89
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h108
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h89
-rw-r--r--TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h106
-rw-r--r--TAO/orbsvcs/tests/Bug_2248_Regression/Client_i.h28
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_client.cpp35
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_client.h110
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_command.cpp29
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_command.h486
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_naming_service.cpp33
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_naming_service.h80
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_test_utils.cpp31
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_test_utils.h37
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_tests.cpp33
-rw-r--r--TAO/orbsvcs/tests/Concurrency/CC_tests.h177
-rw-r--r--TAO/orbsvcs/tests/Concurrency/lex.CC_command.cpp17
-rw-r--r--TAO/orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h34
-rw-r--r--TAO/orbsvcs/tests/CosEvent/Basic/Random.h60
-rw-r--r--TAO/orbsvcs/tests/CosEvent/lib/Counting_Consumer.h100
-rw-r--r--TAO/orbsvcs/tests/CosEvent/lib/Counting_Supplier.h88
-rw-r--r--TAO/orbsvcs/tests/Event/Performance/Connect.h62
-rw-r--r--TAO/orbsvcs/tests/Event/Performance/Inversion.h62
-rw-r--r--TAO/orbsvcs/tests/Event/Performance/Latency.h24
-rw-r--r--TAO/orbsvcs/tests/Event/Performance/Throughput.h46
-rw-r--r--TAO/orbsvcs/tests/Event/UDP/AddrServer.h53
-rw-r--r--TAO/orbsvcs/tests/Event/UDP/Consumer.h51
-rw-r--r--TAO/orbsvcs/tests/Event/UDP/Supplier.h53
-rw-r--r--TAO/orbsvcs/tests/FaultTolerance/IOGR/Client_i.h35
-rw-r--r--TAO/orbsvcs/tests/FaultTolerance/IOGR/Manager.h44
-rw-r--r--TAO/orbsvcs/tests/FaultTolerance/IOGR/test_i.h42
-rw-r--r--TAO/orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp32
-rw-r--r--TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp33
-rw-r--r--TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.h40
-rw-r--r--TAO/orbsvcs/tests/HTIOP/AMI/client.cpp56
-rw-r--r--TAO/orbsvcs/tests/HTIOP/AMI/server.cpp33
-rw-r--r--TAO/orbsvcs/tests/HTIOP/AMI/simple_client.cpp37
-rw-r--r--TAO/orbsvcs/tests/HTIOP/BiDirectional/test_i.h71
-rw-r--r--TAO/orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h61
-rw-r--r--TAO/orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h77
-rw-r--r--TAO/orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h67
-rw-r--r--TAO/orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h71
-rw-r--r--TAO/orbsvcs/tests/Interoperable_Naming/client.cpp34
-rw-r--r--TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp36
-rw-r--r--TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h74
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/AdminProperties.h76
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/ConnectDisconnect.h63
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/Events.h60
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/Filter.h46
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/IdAssignment.h34
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/LifeCycle.h28
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/MultiTypes.h46
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/Sequence.h54
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/Simple.h58
-rw-r--r--TAO/orbsvcs/tests/Notify/Basic/Updates.h56
-rw-r--r--TAO/orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Persistent_Filter/Filter.h157
-rw-r--r--TAO/orbsvcs/tests/Notify/Reconnecting/Consumer.h26
-rw-r--r--TAO/orbsvcs/tests/Notify/Reconnecting/Supplier.h26
-rw-r--r--TAO/orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_PushConsumer.h47
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h31
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h31
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h31
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h31
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/Notify_Test_Client.h79
-rw-r--r--TAO/orbsvcs/tests/Notify/lib/common.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h29
-rw-r--r--TAO/orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h152
-rw-r--r--TAO/orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h117
-rw-r--r--TAO/orbsvcs/tests/Property/client.cpp31
-rw-r--r--TAO/orbsvcs/tests/Property/client.h79
-rw-r--r--TAO/orbsvcs/tests/Property/server.cpp31
-rw-r--r--TAO/orbsvcs/tests/Property/server.h29
-rw-r--r--TAO/orbsvcs/tests/Security/BiDirectional/test_i.h71
-rw-r--r--TAO/orbsvcs/tests/Security/Crash_Test/test_i.h40
-rw-r--r--TAO/orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h48
-rw-r--r--TAO/orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h40
-rw-r--r--TAO/orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h48
-rw-r--r--TAO/orbsvcs/tests/Security/MT_SSLIOP/test_i.h57
-rw-r--r--TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.cpp44
-rw-r--r--TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.h349
-rw-r--r--TAO/orbsvcs/tests/Simple_Naming/client.cpp44
-rw-r--r--TAO/orbsvcs/tests/Simple_Naming/client.h373
-rw-r--r--TAO/orbsvcs/tests/Time/Client_i.h97
-rw-r--r--TAO/orbsvcs/tests/ior_corbaname/client.cpp33
-rw-r--r--TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp36
-rw-r--r--TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h58
-rw-r--r--TAO/orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp41
-rw-r--r--TAO/performance-tests/Anyop/anyop.cpp34
-rw-r--r--TAO/performance-tests/Cubit/TAO/DII_Cubit/client.cpp101
-rw-r--r--TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h142
-rw-r--r--TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h74
-rw-r--r--TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp26
-rw-r--r--TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h96
-rw-r--r--TAO/performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h23
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h64
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/Globals.h133
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h259
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/Timer.h49
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h55
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/client.h132
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h40
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/server.cpp31
-rw-r--r--TAO/performance-tests/Cubit/TAO/MT_Cubit/server.h100
-rw-r--r--TAO/performance-tests/POA/Demux/client.cpp30
-rw-r--r--TAO/performance-tests/POA/Demux/demux_stats.cpp32
-rw-r--r--TAO/performance-tests/POA/Demux/demux_test_client.cpp24
-rw-r--r--TAO/performance-tests/POA/Demux/demux_test_client.h84
-rw-r--r--TAO/performance-tests/POA/Demux/demux_test_macros.h30
-rw-r--r--TAO/performance-tests/POA/Demux/demux_test_server.cpp24
-rw-r--r--TAO/performance-tests/POA/Demux/demux_test_server.h78
-rw-r--r--TAO/performance-tests/POA/Demux/server.cpp30
-rw-r--r--TAO/performance-tests/POA/Object_Creation_And_Registration/registration.cpp40
-rw-r--r--TAO/performance-tests/Pluggable/PP_Test_Client.h104
-rw-r--r--TAO/performance-tests/Pluggable/PP_Test_Server.h74
-rw-r--r--TAO/performance-tests/Pluggable/PP_Test_i.cpp25
-rw-r--r--TAO/performance-tests/Pluggable/PP_Test_i.h69
-rw-r--r--TAO/performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h40
-rw-r--r--TAO/performance-tests/RTCorba/Oneways/Reliable/test_i.h42
-rw-r--r--TAO/tao/IORManipulation/IORManip_Filter.h25
-rw-r--r--TAO/tao/IORManipulation/IORManip_IIOP_Filter.h25
-rw-r--r--TAO/tests/AMI_Timeouts/timeout_client.h31
-rw-r--r--TAO/tests/AMI_Timeouts/timeout_i.cpp31
-rw-r--r--TAO/tests/AMI_Timeouts/timeout_i.h31
-rw-r--r--TAO/tests/Alt_Mapping/alt_mapping_i.cpp22
-rw-r--r--TAO/tests/Alt_Mapping/alt_mapping_i.h33
-rw-r--r--TAO/tests/Alt_Mapping/client.cpp30
-rw-r--r--TAO/tests/Alt_Mapping/client.h60
-rw-r--r--TAO/tests/Alt_Mapping/driver.cpp28
-rw-r--r--TAO/tests/Alt_Mapping/driver.h52
-rw-r--r--TAO/tests/Alt_Mapping/helper.cpp30
-rw-r--r--TAO/tests/Alt_Mapping/helper.h33
-rw-r--r--TAO/tests/Alt_Mapping/options.cpp31
-rw-r--r--TAO/tests/Alt_Mapping/options.h64
-rw-r--r--TAO/tests/Alt_Mapping/results.cpp28
-rw-r--r--TAO/tests/Alt_Mapping/results.h61
-rw-r--r--TAO/tests/Alt_Mapping/server.cpp25
-rw-r--r--TAO/tests/Alt_Mapping/tests.h26
-rw-r--r--TAO/tests/Alt_Mapping/ub_string.cpp31
-rw-r--r--TAO/tests/Alt_Mapping/ub_string.h51
-rw-r--r--TAO/tests/Alt_Mapping/ub_struct_seq.cpp31
-rw-r--r--TAO/tests/Alt_Mapping/ub_struct_seq.h51
-rw-r--r--TAO/tests/BiDirectional/test_i.h71
-rw-r--r--TAO/tests/BiDirectional_DelayedUpcall/test_i.h73
-rw-r--r--TAO/tests/BiDirectional_MultipleORB/destroy.cpp32
-rw-r--r--TAO/tests/BiDirectional_NestedUpcall/test_i.h71
-rw-r--r--TAO/tests/Bug_2174_Regression/test_i.h42
-rw-r--r--TAO/tests/Bug_2734_Regression/test_i.h42
-rw-r--r--TAO/tests/Bug_2935_Regression/middle_i.h46
-rw-r--r--TAO/tests/Bug_2935_Regression/sink_i.h37
-rw-r--r--TAO/tests/Bug_2935_Regression/source_i.h47
-rw-r--r--TAO/tests/Bug_3068_Regression/test_i.h72
-rw-r--r--TAO/tests/Bug_3683_Regression/Echo_Client_i.h54
-rw-r--r--TAO/tests/Bug_3683_Regression/Echo_i.h65
-rw-r--r--TAO/tests/Bug_3683_Regression/Simple_util.h131
-rw-r--r--TAO/tests/CDR/alignment.cpp33
-rw-r--r--TAO/tests/CDR/allocator.cpp74
-rw-r--r--TAO/tests/CDR/basic_types.cpp31
-rw-r--r--TAO/tests/CDR/growth.cpp33
-rw-r--r--TAO/tests/CDR/octet_sequence.cpp32
-rw-r--r--TAO/tests/CDR/tc.cpp31
-rw-r--r--TAO/tests/CSD_Collocation/Collocation_Tester.h40
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp33
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h35
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp33
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp35
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h37
-rw-r--r--TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp31
-rw-r--r--TAO/tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp33
-rw-r--r--TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp29
-rw-r--r--TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h33
-rw-r--r--TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp58
-rw-r--r--TAO/tests/CodeSets/simple/client.cpp31
-rw-r--r--TAO/tests/CodeSets/simple/server.cpp31
-rw-r--r--TAO/tests/Collocation/Collocation_Tester.h40
-rw-r--r--TAO/tests/DIOP/UDP_Client_i.h33
-rw-r--r--TAO/tests/DIOP/UDP_i.h59
-rw-r--r--TAO/tests/DIOP/client.cpp31
-rw-r--r--TAO/tests/DIOP/server.cpp31
-rw-r--r--TAO/tests/DSI_AMI_Gateway/test_dsi.h52
-rw-r--r--TAO/tests/DSI_AMI_Gateway/test_i.h40
-rw-r--r--TAO/tests/DSI_Gateway/test_dsi.h44
-rw-r--r--TAO/tests/DSI_Gateway/test_i.h40
-rw-r--r--TAO/tests/Explicit_Event_Loop/client.cpp32
-rw-r--r--TAO/tests/Explicit_Event_Loop/server.cpp34
-rw-r--r--TAO/tests/Explicit_Event_Loop/server.h31
-rw-r--r--TAO/tests/Exposed_Policies/Counter_i.h31
-rw-r--r--TAO/tests/Exposed_Policies/Policy_Tester.h34
-rw-r--r--TAO/tests/Exposed_Policies/Policy_Verifier.h32
-rw-r--r--TAO/tests/Exposed_Policies/RT_Properties.h32
-rw-r--r--TAO/tests/FL_Cube/test_i.h52
-rw-r--r--TAO/tests/Faults/ping_i.h48
-rw-r--r--TAO/tests/Faults/test_i.h67
-rw-r--r--TAO/tests/File_IO/File_i.cpp30
-rw-r--r--TAO/tests/File_IO/File_i.h85
-rw-r--r--TAO/tests/File_IO/client.cpp30
-rwxr-xr-xTAO/tests/ForwardOnceUponException/test_i.h42
-rwxr-xr-xTAO/tests/ForwardUponObjectNotExist/test_i.h42
-rw-r--r--TAO/tests/Forwarding/test_i.h42
-rw-r--r--TAO/tests/IDL_Test/main.cpp33
-rw-r--r--TAO/tests/InterOp-Naming/INS_i.h41
-rw-r--r--TAO/tests/InterOp-Naming/Server_i.h57
-rw-r--r--TAO/tests/Leader_Followers/client.cpp28
-rw-r--r--TAO/tests/Leader_Followers/test_i.h35
-rw-r--r--TAO/tests/MProfile/test_i.h42
-rw-r--r--TAO/tests/MProfile_Connection_Timeout/test_i.h42
-rw-r--r--TAO/tests/MProfile_Forwarding/Servant_Locator.cpp34
-rw-r--r--TAO/tests/MProfile_Forwarding/Servant_Locator.h52
-rw-r--r--TAO/tests/MProfile_Forwarding/test_i.h39
-rw-r--r--TAO/tests/MT_Client/test_i.h40
-rw-r--r--TAO/tests/MT_Server/test_i.h42
-rw-r--r--TAO/tests/Multiple/Collocation_Tester.h62
-rw-r--r--TAO/tests/Multiple/Multiple_Impl.h64
-rw-r--r--TAO/tests/Multiple_Inheritance/client.cpp29
-rw-r--r--TAO/tests/Muxed_GIOP_Versions/test_i.h42
-rw-r--r--TAO/tests/Native_Exceptions/test_i.h40
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp33
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.h45
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/client.cpp35
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/client.h86
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/local_server.cpp33
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/local_server.h90
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/server.cpp33
-rw-r--r--TAO/tests/NestedUpcall/MT_Client_Test/server.h66
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.cpp33
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.h49
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.cpp31
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.h45
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.cpp33
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.h45
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/initiator.cpp33
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/initiator.h76
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/server_A.cpp33
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/server_A.h66
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/server_B.cpp33
-rw-r--r--TAO/tests/NestedUpcall/Triangle_Test/server_B.h66
-rw-r--r--TAO/tests/OBV/Any/AnyS_impl.h44
-rw-r--r--TAO/tests/OBV/Collocated/Forward/Test_impl.h44
-rw-r--r--TAO/tests/OBV/Factory/FactoryS_impl.h44
-rw-r--r--TAO/tests/OBV/Forward/Test_impl.h44
-rw-r--r--TAO/tests/OBV/Simple/Client_i.h60
-rw-r--r--TAO/tests/OBV/Simple/Server_i.h41
-rw-r--r--TAO/tests/OBV/Simple/Simple_util.h136
-rw-r--r--TAO/tests/OBV/TC_Alignment/test_i.h25
-rw-r--r--TAO/tests/OBV/Truncatable/TruncatableS_impl.h42
-rw-r--r--TAO/tests/OBV/ValueBox/Test_impl.h29
-rw-r--r--TAO/tests/ORB_destroy/ORB_destroy.cpp31
-rw-r--r--TAO/tests/Object_Loader/Loader.h40
-rw-r--r--TAO/tests/Object_Loader/Test_i.h40
-rw-r--r--TAO/tests/OctetSeq/OctetSeq.cpp35
-rw-r--r--TAO/tests/OctetSeq/test_i.h43
-rw-r--r--TAO/tests/POA/Adapter_Activator/server.cpp45
-rw-r--r--TAO/tests/POA/Bug_2511_Regression/server.cpp33
-rw-r--r--TAO/tests/POA/Current/Current.cpp33
-rw-r--r--TAO/tests/POA/DSI/client.cpp30
-rw-r--r--TAO/tests/POA/DSI/server.cpp30
-rw-r--r--TAO/tests/POA/Default_Servant/Default_Servant.cpp33
-rw-r--r--TAO/tests/POA/Default_Servant2/File_i.cpp30
-rw-r--r--TAO/tests/POA/Default_Servant2/File_i.h85
-rw-r--r--TAO/tests/POA/Default_Servant2/client.cpp30
-rw-r--r--TAO/tests/POA/Default_Servant2/server.cpp30
-rw-r--r--TAO/tests/POA/Etherealization/Etherealization.cpp33
-rw-r--r--TAO/tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp37
-rw-r--r--TAO/tests/POA/Explicit_Activation/server.cpp31
-rw-r--r--TAO/tests/POA/FindPOA/FindPOA.cpp31
-rw-r--r--TAO/tests/POA/Forwarding/Servant_Activator.h38
-rw-r--r--TAO/tests/POA/Forwarding/client.cpp33
-rw-r--r--TAO/tests/POA/Forwarding/server.cpp33
-rw-r--r--TAO/tests/POA/Forwarding/test_i.h24
-rw-r--r--TAO/tests/POA/Generic_Servant/test_i.h43
-rw-r--r--TAO/tests/POA/Identity/Identity.cpp31
-rw-r--r--TAO/tests/POA/Loader/Servant_Activator.cpp31
-rw-r--r--TAO/tests/POA/Loader/Servant_Activator.h95
-rw-r--r--TAO/tests/POA/Loader/Servant_Locator.cpp33
-rw-r--r--TAO/tests/POA/Loader/Servant_Locator.h101
-rw-r--r--TAO/tests/POA/Loader/Server_Manager.h93
-rw-r--r--TAO/tests/POA/Loader/server.cpp24
-rw-r--r--TAO/tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp33
-rw-r--r--TAO/tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp33
-rw-r--r--TAO/tests/POA/NewPOA/NewPOA.cpp43
-rw-r--r--TAO/tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp37
-rw-r--r--TAO/tests/POA/Object_Reactivation/Object_Reactivation.cpp33
-rw-r--r--TAO/tests/POA/On_Demand_Activation/Servant_Activator.cpp33
-rw-r--r--TAO/tests/POA/On_Demand_Activation/Servant_Activator.h43
-rw-r--r--TAO/tests/POA/On_Demand_Activation/Servant_Locator.cpp31
-rw-r--r--TAO/tests/POA/On_Demand_Activation/Servant_Locator.h45
-rw-r--r--TAO/tests/POA/On_Demand_Activation/server.cpp26
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Activator.cpp31
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Activator.h83
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Locator.cpp33
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Locator.h81
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Manager.cpp33
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Servant_Manager.h108
-rw-r--r--TAO/tests/POA/On_Demand_Loading/Server_Manager.h93
-rw-r--r--TAO/tests/POA/On_Demand_Loading/server.cpp24
-rw-r--r--TAO/tests/POA/POAManagerFactory/POAManagerFactory.cpp35
-rw-r--r--TAO/tests/POA/POA_BiDir/POA_BiDir.cpp33
-rw-r--r--TAO/tests/POA/POA_Destruction/POA_Destruction.cpp33
-rw-r--r--TAO/tests/POA/Persistent_ID/client.cpp29
-rw-r--r--TAO/tests/POA/Persistent_ID/server.cpp33
-rw-r--r--TAO/tests/POA/Policies/Policies.cpp35
-rw-r--r--TAO/tests/POA/Reference_Counted_Servant/server.cpp39
-rw-r--r--TAO/tests/POA/RootPOA/RootPOA.cpp34
-rw-r--r--TAO/tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp37
-rw-r--r--TAO/tests/POA/TIE/client.cpp29
-rw-r--r--TAO/tests/POA/TIE/server.cpp29
-rw-r--r--TAO/tests/POA/TIE/test_i.cpp27
-rw-r--r--TAO/tests/POA/TIE/test_i.h29
-rw-r--r--TAO/tests/POA/wait_for_completion/wait_for_completion.cpp31
-rw-r--r--TAO/tests/Param_Test/any.cpp31
-rw-r--r--TAO/tests/Param_Test/any.h65
-rw-r--r--TAO/tests/Param_Test/anyop.cpp29
-rw-r--r--TAO/tests/Param_Test/bd_array_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_array_seq.h65
-rw-r--r--TAO/tests/Param_Test/bd_long_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_long_seq.h61
-rw-r--r--TAO/tests/Param_Test/bd_short_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_short_seq.h61
-rw-r--r--TAO/tests/Param_Test/bd_str_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_str_seq.h61
-rw-r--r--TAO/tests/Param_Test/bd_string.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_string.h61
-rw-r--r--TAO/tests/Param_Test/bd_struct_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_struct_seq.h65
-rw-r--r--TAO/tests/Param_Test/bd_wstr_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_wstr_seq.h61
-rw-r--r--TAO/tests/Param_Test/bd_wstring.cpp31
-rw-r--r--TAO/tests/Param_Test/bd_wstring.h61
-rw-r--r--TAO/tests/Param_Test/big_union.cpp31
-rw-r--r--TAO/tests/Param_Test/big_union.h65
-rw-r--r--TAO/tests/Param_Test/client.cpp33
-rw-r--r--TAO/tests/Param_Test/client.h64
-rw-r--r--TAO/tests/Param_Test/complex_any.cpp31
-rw-r--r--TAO/tests/Param_Test/complex_any.h67
-rw-r--r--TAO/tests/Param_Test/driver.cpp29
-rw-r--r--TAO/tests/Param_Test/driver.h52
-rw-r--r--TAO/tests/Param_Test/except.cpp31
-rw-r--r--TAO/tests/Param_Test/except.h63
-rw-r--r--TAO/tests/Param_Test/fixed_array.cpp31
-rw-r--r--TAO/tests/Param_Test/fixed_array.h65
-rw-r--r--TAO/tests/Param_Test/fixed_struct.cpp31
-rw-r--r--TAO/tests/Param_Test/fixed_struct.h61
-rw-r--r--TAO/tests/Param_Test/helper.cpp33
-rw-r--r--TAO/tests/Param_Test/helper.h37
-rw-r--r--TAO/tests/Param_Test/multdim_array.cpp31
-rw-r--r--TAO/tests/Param_Test/multdim_array.h65
-rw-r--r--TAO/tests/Param_Test/nested_struct.cpp31
-rw-r--r--TAO/tests/Param_Test/nested_struct.h61
-rw-r--r--TAO/tests/Param_Test/objref.cpp31
-rw-r--r--TAO/tests/Param_Test/objref.h61
-rw-r--r--TAO/tests/Param_Test/objref_struct.cpp31
-rw-r--r--TAO/tests/Param_Test/objref_struct.h61
-rw-r--r--TAO/tests/Param_Test/options.cpp31
-rw-r--r--TAO/tests/Param_Test/options.h64
-rw-r--r--TAO/tests/Param_Test/param_test_i.cpp25
-rw-r--r--TAO/tests/Param_Test/param_test_i.h98
-rw-r--r--TAO/tests/Param_Test/recursive_struct.cpp32
-rw-r--r--TAO/tests/Param_Test/recursive_struct.h66
-rw-r--r--TAO/tests/Param_Test/recursive_union.cpp31
-rw-r--r--TAO/tests/Param_Test/recursive_union.h65
-rw-r--r--TAO/tests/Param_Test/results.cpp31
-rw-r--r--TAO/tests/Param_Test/results.h61
-rw-r--r--TAO/tests/Param_Test/server.cpp25
-rw-r--r--TAO/tests/Param_Test/short.cpp31
-rw-r--r--TAO/tests/Param_Test/short.h61
-rw-r--r--TAO/tests/Param_Test/small_union.cpp31
-rw-r--r--TAO/tests/Param_Test/small_union.h65
-rw-r--r--TAO/tests/Param_Test/tests.h29
-rw-r--r--TAO/tests/Param_Test/typecode.cpp31
-rw-r--r--TAO/tests/Param_Test/typecode.h65
-rw-r--r--TAO/tests/Param_Test/ub_any_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_any_seq.h65
-rw-r--r--TAO/tests/Param_Test/ub_array_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_array_seq.h65
-rw-r--r--TAO/tests/Param_Test/ub_long_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_long_seq.h61
-rw-r--r--TAO/tests/Param_Test/ub_objref_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_objref_seq.h65
-rw-r--r--TAO/tests/Param_Test/ub_short_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_short_seq.h61
-rw-r--r--TAO/tests/Param_Test/ub_str_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_str_seq.h61
-rw-r--r--TAO/tests/Param_Test/ub_string.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_string.h61
-rw-r--r--TAO/tests/Param_Test/ub_struct_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_struct_seq.h99
-rw-r--r--TAO/tests/Param_Test/ub_wstr_seq.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_wstr_seq.h61
-rw-r--r--TAO/tests/Param_Test/ub_wstring.cpp31
-rw-r--r--TAO/tests/Param_Test/ub_wstring.h61
-rw-r--r--TAO/tests/Param_Test/ulonglong.cpp31
-rw-r--r--TAO/tests/Param_Test/ulonglong.h61
-rw-r--r--TAO/tests/Param_Test/var_array.cpp31
-rw-r--r--TAO/tests/Param_Test/var_array.h65
-rw-r--r--TAO/tests/Param_Test/var_struct.cpp29
-rw-r--r--TAO/tests/Param_Test/var_struct.h61
-rw-r--r--TAO/tests/Portable_Interceptors/Benchmark/test_i.h38
-rw-r--r--TAO/tests/Portable_Interceptors/Collocated/Dynamic/test_i.h36
-rw-r--r--TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h36
-rw-r--r--TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h36
-rw-r--r--TAO/tests/QtTests/client.h41
-rw-r--r--TAO/tests/QtTests/test_i.h39
-rw-r--r--TAO/tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h51
-rw-r--r--TAO/tests/RTCORBA/Policies/Policies.cpp35
-rw-r--r--TAO/tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp29
-rw-r--r--TAO/tests/Single_Read/test_i.h35
-rw-r--r--TAO/tests/Smart_Proxies/Benchmark/client.cpp33
-rw-r--r--TAO/tests/Smart_Proxies/Benchmark/server.cpp33
-rw-r--r--TAO/tests/Smart_Proxies/On_Demand/client.cpp31
-rw-r--r--TAO/tests/Smart_Proxies/On_Demand/server.cpp33
-rw-r--r--TAO/tests/Smart_Proxies/Policy/client.cpp31
-rw-r--r--TAO/tests/Smart_Proxies/Policy/server.cpp33
-rw-r--r--TAO/tests/Smart_Proxies/client.cpp31
-rw-r--r--TAO/tests/Smart_Proxies/server.cpp33
-rw-r--r--TAO/tests/Strategies/simple_test_i.h40
-rw-r--r--TAO/tests/Timed_Buffered_Oneways/client.cpp30
-rw-r--r--TAO/tests/Timed_Buffered_Oneways/test_i.h37
-rw-r--r--TAO/tests/Timeout/test_i.h42
-rw-r--r--TAO/tests/Xt_Stopwatch/Client.h39
-rw-r--r--TAO/tests/Xt_Stopwatch/Control.h43
-rw-r--r--TAO/tests/Xt_Stopwatch/Stopwatch_display.h37
-rw-r--r--TAO/tests/Xt_Stopwatch/test_i.h44
-rw-r--r--TAO/tests/Xt_Stopwatch/timer.h51
-rw-r--r--TAO/utils/catior/Catior_i.cpp36
-rw-r--r--TAO/utils/catior/Catior_i.h34
-rw-r--r--TAO/utils/nslist/nsadd.cpp32
-rw-r--r--TAO/utils/nslist/nsdel.cpp33
684 files changed, 18129 insertions, 18207 deletions
diff --git a/TAO/ChangeLog b/TAO/ChangeLog
index 27b0ebb902b..1fba24d3b22 100644
--- a/TAO/ChangeLog
+++ b/TAO/ChangeLog
@@ -1,3 +1,925 @@
+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:
+
Fri Mar 25 15:32:09 UTC 2011 Adam Mitz <mitza@ociweb.com>
* DevGuideExamples/Messaging/AMIcallback/AMIcallback.mpc:
diff --git a/TAO/TAO_IDL/be/be_visitor_array/array_ci.cpp b/TAO/TAO_IDL/be/be_visitor_array/array_ci.cpp
index 078f9fae73d..f634b7042cc 100644
--- a/TAO/TAO_IDL/be/be_visitor_array/array_ci.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_array/array_ci.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// array_ci.cpp
-//
-// = DESCRIPTION
-// Visitor generating code for Arrays in the client inline.
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file array_ci.cpp
+ *
+ * $Id$
+ *
+ * Visitor generating code for Arrays in the client inline.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// ************************************************************************
// visitor for array declaration in client inline
diff --git a/TAO/TAO_IDL/be/be_visitor_exception/any_op_cs.cpp b/TAO/TAO_IDL/be/be_visitor_exception/any_op_cs.cpp
index c0162fa485e..a1cecbb2468 100644
--- a/TAO/TAO_IDL/be/be_visitor_exception/any_op_cs.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_exception/any_op_cs.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// any_op_cs.cpp
-//
-// = DESCRIPTION
-// Visitor generating code for the Any operators for Exceptions.
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file any_op_cs.cpp
+ *
+ * $Id$
+ *
+ * Visitor generating code for the Any operators for Exceptions.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// ***************************************************************************
// Exception visitor for generating Any operator declarations in the client
diff --git a/TAO/TAO_IDL/be/be_visitor_interface/any_op_cs.cpp b/TAO/TAO_IDL/be/be_visitor_interface/any_op_cs.cpp
index 2c103356d41..9794c4e8e0a 100644
--- a/TAO/TAO_IDL/be/be_visitor_interface/any_op_cs.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_interface/any_op_cs.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// any_op_cs.cpp
-//
-// = DESCRIPTION
-// Visitor generating code for Any operators for Interface in the stubs
-// file.
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file any_op_cs.cpp
+ *
+ * $Id$
+ *
+ * Visitor generating code for Any operators for Interface in the stubs
+ * file.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// ***************************************************************************
// Interface visitor for generating Any operator declarations in the client
diff --git a/TAO/TAO_IDL/be/be_visitor_interface/interface_ci.cpp b/TAO/TAO_IDL/be/be_visitor_interface/interface_ci.cpp
index 9866c6dddb6..75a3f3b0ef7 100644
--- a/TAO/TAO_IDL/be/be_visitor_interface/interface_ci.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_interface/interface_ci.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// interface_ci.cpp
-//
-// = DESCRIPTION
-// Visitor generating code for Interfaces in the client inline file
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file interface_ci.cpp
+ *
+ * $Id$
+ *
+ * Visitor generating code for Interfaces in the client inline file
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// **************************************************
// Interface visitor for client inline
diff --git a/TAO/TAO_IDL/be/be_visitor_root/root.cpp b/TAO/TAO_IDL/be/be_visitor_root/root.cpp
index 8b0150e7963..85642a7d750 100644
--- a/TAO/TAO_IDL/be/be_visitor_root/root.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_root/root.cpp
@@ -1,20 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// root.cpp
-//
-// = DESCRIPTION
-// Visitor generating code for the Root node. This is a generic visitor.
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file root.cpp
+ *
+ * $Id$
+ *
+ * Visitor generating code for the Root node. This is a generic visitor.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// Generic Root visitor
be_visitor_root::be_visitor_root (be_visitor_context *ctx)
diff --git a/TAO/TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp b/TAO/TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp
index beb7f2e2b8f..d362ec1f474 100644
--- a/TAO/TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp
+++ b/TAO/TAO_IDL/be/be_visitor_sequence/cdr_op_cs.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// cdr_op_cs.cpp
-//
-// = DESCRIPTION
-// Visitor for code generation of Sequences for the CDR operators
-// in the client stubs.
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file cdr_op_cs.cpp
+ *
+ * $Id$
+ *
+ * Visitor for code generation of Sequences for the CDR operators
+ * in the client stubs.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// ***************************************************************************
// Sequence visitor for generating CDR operator declarations in the client
diff --git a/TAO/TAO_IDL/be_include/be_helper.h b/TAO/TAO_IDL/be_include/be_helper.h
index 584d5804f89..c9da90e7d32 100644
--- a/TAO/TAO_IDL/be_include/be_helper.h
+++ b/TAO/TAO_IDL/be_include/be_helper.h
@@ -84,9 +84,7 @@ struct TAO_ACE_CHECK
/**
* @class TAO_OutStream
- =TITLE
- * TAO_OutStream
- * =DESCRIPTION
+ *
* Defines an interface by which the backend code generator can
* print its output to the underlying I/O handle. This is a
* helper class that will be used by the TAO_CodeGen
@@ -97,7 +95,7 @@ class TAO_OutStream
{
public:
- // Enumerated type to indicate the stream type
+ /// Enumerated type to indicate the stream type
enum STREAM_TYPE
{
TAO_CLI_HDR,
diff --git a/TAO/TAO_IDL/be_include/be_visitor_argument/invoke_cs.h b/TAO/TAO_IDL/be_include/be_visitor_argument/invoke_cs.h
index 88a7c7f4c0c..e1038ca8763 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_argument/invoke_cs.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_argument/invoke_cs.h
@@ -1,23 +1,18 @@
-//
-// $Id$
-//
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO IDL
-//
-// = FILENAME
-// invoke_cs.h
-//
-// = DESCRIPTION
-// Visitors for generation of code for Arguments for passing the arguments
-// to the CDR << and >> operators
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file invoke_cs.h
+ *
+ * $Id$
+ *
+ * Visitors for generation of code for Arguments for passing the arguments
+ * to the CDR << and >> operators
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef _BE_VISITOR_ARGUMENT_INVOKE_CS_H_
#define _BE_VISITOR_ARGUMENT_INVOKE_CS_H_
@@ -26,79 +21,79 @@
// class be_visitor_args_invoke_cs
// ************************************************************
+/**
+ * @class be_visitor_args_invoke_cs
+ *
+ * @brief be_visitor_args_invoke_cs
+ *
+ * Code to be generated when making the invocation
+ */
class be_visitor_args_invoke_cs : public be_visitor_args
{
- //
- // = TITLE
- // be_visitor_args_invoke_cs
- //
- // = DESCRIPTION
- // Code to be generated when making the invocation
- //
public:
+ /// constructor
be_visitor_args_invoke_cs (be_visitor_context *ctx);
- // constructor
+ /// destructor
virtual ~be_visitor_args_invoke_cs (void);
- // destructor
+ /// visit the argument node
virtual int visit_argument (be_argument *node);
- // visit the argument node
// =visit all the nodes that can be the types for the argument
+ /// visit array type
virtual int visit_array (be_array *node);
- // visit array type
+ /// visit the enum node
virtual int visit_enum (be_enum *node);
- // visit the enum node
+ /// visit interface
virtual int visit_interface (be_interface *node);
- // visit interface
+ /// visit interface forward
virtual int visit_interface_fwd (be_interface_fwd *node);
- // visit interface forward
+ /// visit valuebox
virtual int visit_valuebox (be_valuebox *node);
- // visit valuebox
+ /// visit valuetype
virtual int visit_valuetype (be_valuetype *node);
- // visit valuetype
+ /// visit valuetype forward
virtual int visit_valuetype_fwd (be_valuetype_fwd *node);
- // visit valuetype forward
+ /// visit predefined type
virtual int visit_predefined_type (be_predefined_type *node);
- // visit predefined type
+ /// visit sequence type
virtual int visit_sequence (be_sequence *node);
- // visit sequence type
+ /// visit string type
virtual int visit_string (be_string *node);
- // visit string type
+ /// visit structure type
virtual int visit_structure (be_structure *node);
- // visit structure type
+ /// visit union type
virtual int visit_union (be_union *node);
- // visit union type
+ /// visit the typedef type
+ /// visit a component node
virtual int visit_typedef (be_typedef *node);
- // visit the typedef type
virtual int visit_component (be_component *node);
- // visit a component node
+ /// visit a forward declared component node
virtual int visit_component_fwd (be_component_fwd *node);
- // visit a forward declared component node
+ /// visit an eventtype node
virtual int visit_eventtype (be_eventtype *node);
- // visit an eventtype node
+ /// visit a forward declared eventtype node
virtual int visit_eventtype_fwd (be_eventtype_fwd *node);
- // visit a forward declared eventtype node
+ /// visit home
virtual int visit_home (be_home *node);
- // visit home
private:
int emit_common (void);
diff --git a/TAO/TAO_IDL/be_include/be_visitor_exception/ctor.h b/TAO/TAO_IDL/be_include/be_visitor_exception/ctor.h
index 05f4611b87b..87f2e6a1720 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_exception/ctor.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_exception/ctor.h
@@ -20,9 +20,7 @@
/**
* @class be_visitor_exception_ctor
- =TITLE
- * be_visitor_exception_ctor
- * =DESCRIPTION
+ *
* generation of the special constructor
*/
class be_visitor_exception_ctor : public be_visitor_scope
diff --git a/TAO/TAO_IDL/be_include/be_visitor_exception/ctor_assign.h b/TAO/TAO_IDL/be_include/be_visitor_exception/ctor_assign.h
index ac4db665d2b..7d7ebc5b49a 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_exception/ctor_assign.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_exception/ctor_assign.h
@@ -20,9 +20,7 @@
/**
* @class be_visitor_exception_ctor_assign
- =TITLE
- * be_visitor_exception_ctor_assign
- * =DESCRIPTION
+ *
* generation of the assignment statements in
*/
class be_visitor_exception_ctor_assign : public be_visitor_scope
diff --git a/TAO/TAO_IDL/be_include/be_visitor_exception/exception_ctor.h b/TAO/TAO_IDL/be_include/be_visitor_exception/exception_ctor.h
index b9bfe9f59c5..f3beedde63b 100644
--- a/TAO/TAO_IDL/be_include/be_visitor_exception/exception_ctor.h
+++ b/TAO/TAO_IDL/be_include/be_visitor_exception/exception_ctor.h
@@ -19,9 +19,7 @@
/**
* @class be_visitor_exception_ctor
- =TITLE
- * be_visitor_exception_ctor
- * =DESCRIPTION
+ *
* generation of the special constructor
*/
class be_visitor_exception_ctor : public be_visitor_scope
diff --git a/TAO/TAO_IDL/include/utl_idlist.h b/TAO/TAO_IDL/include/utl_idlist.h
index 626a909a5e7..e66ddc6efd1 100644
--- a/TAO/TAO_IDL/include/utl_idlist.h
+++ b/TAO/TAO_IDL/include/utl_idlist.h
@@ -131,8 +131,8 @@ class TAO_IDL_FE_Export UTL_IdListActiveIterator
public:
UTL_IdListActiveIterator (UTL_IdList *s);
+ /// Retrieves the next item.
Identifier *item (void);
- // Retrieves the next item.
};
#endif // _UTL_IDLIST_UTL_IDLIST_HH
diff --git a/TAO/docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp b/TAO/docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp
index b5a7838526c..eb0b39105a3 100644
--- a/TAO/docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp
+++ b/TAO/docs/tutorials/Quoter/Simple/Impl-Repo/server.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-//===========================================================================
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// In this example,
-// - Example showing the working of implementation repository.
-//
-// = AUTHOR
-// Priyanka Gontla
-//
-//============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * In this example,
+ * - Example showing the working of implementation repository.
+ *
+ *
+ * @author Priyanka Gontla
+ */
+//=============================================================================
+
#include "Stock_Factory_i.h"
#include "tao/IORTable/IORTable.h"
diff --git a/TAO/docs/tutorials/Quoter/Simple/Persistent/server.cpp b/TAO/docs/tutorials/Quoter/Simple/Persistent/server.cpp
index 95cc2869e69..c42f81726a5 100644
--- a/TAO/docs/tutorials/Quoter/Simple/Persistent/server.cpp
+++ b/TAO/docs/tutorials/Quoter/Simple/Persistent/server.cpp
@@ -1,19 +1,19 @@
-// $Id$
-
-//===========================================================================
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-//
-// In this example, a new POA (childPOA) is created and its
-// policy is set so that it object references are persistent.
-//
-// = AUTHOR
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ *
+ * In this example, a new POA (childPOA) is created and its
+ * policy is set so that it object references are persistent.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "Stock_Factory_i.h"
#include "ace/streams.h"
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
diff --git a/TAO/interop-tests/wchar/client.cpp b/TAO/interop-tests/wchar/client.cpp
index 99fd348c9df..2318662bf35 100644
--- a/TAO/interop-tests/wchar/client.cpp
+++ b/TAO/interop-tests/wchar/client.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// interop_test/wchar
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// C++ client side for testing interoperability with wchar data.
-//
-// = AUTHOR
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * C++ client side for testing interoperability with wchar data.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "interop_wcharC.h"
#include "wchar_reference.h"
diff --git a/TAO/interop-tests/wchar/server.cpp b/TAO/interop-tests/wchar/server.cpp
index d17ff127ccf..54ca14054f4 100644
--- a/TAO/interop-tests/wchar/server.cpp
+++ b/TAO/interop-tests/wchar/server.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// interop_test/wchar
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// C++ server side for testing interoperability with wchar data.
-//
-// = AUTHOR
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * C++ server side for testing interoperability with wchar data.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "interop_wchar_i.h"
#include "ace/Get_Opt.h"
#include "ace/Argv_Type_Converter.h"
diff --git a/TAO/interop-tests/wchar/wchar_reference.cpp b/TAO/interop-tests/wchar/wchar_reference.cpp
index 13f13712f53..7a7031c904b 100644
--- a/TAO/interop-tests/wchar/wchar_reference.cpp
+++ b/TAO/interop-tests/wchar/wchar_reference.cpp
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// interop_test/wchar
-//
-// = FILENAME
-// wchar_reference.cpp
-//
-// = DESCRIPTION
-// C++ reference data for testing interoperability with wchars. This is
-// linked into both clients and servers so that both sides have common
-// values for testing what is received or sent.
-//
-// = AUTHOR
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file wchar_reference.cpp
+ *
+ * $Id$
+ *
+ * C++ reference data for testing interoperability with wchars. This is
+ * linked into both clients and servers so that both sides have common
+ * values for testing what is received or sent.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "wchar_reference.h"
#include "ace/Log_Msg.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/interop-tests/wchar/wchar_reference.h b/TAO/interop-tests/wchar/wchar_reference.h
index 88be0efdcc3..f4a0ad497fb 100644
--- a/TAO/interop-tests/wchar/wchar_reference.h
+++ b/TAO/interop-tests/wchar/wchar_reference.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// interop_test/wchar
-//
-// = FILENAME
-// wchar_reference.cpp
-//
-// = DESCRIPTION
-// C++ reference data for testing interoperability with wchars. This is
-// linked into both clients and servers so that both sides have common
-// values for testing what is received or sent.
-//
-// = AUTHOR
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file wchar_reference.cpp
+ *
+ * $Id$
+ *
+ * C++ reference data for testing interoperability with wchars. This is
+ * linked into both clients and servers so that both sides have common
+ * values for testing what is received or sent.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#ifndef WCHAR_REFERENCE_H
#define WCHAR_REFERENCE_H
diff --git a/TAO/orbsvcs/IFR_Service/IFR_Service.h b/TAO/orbsvcs/IFR_Service/IFR_Service.h
index a7fc21f7476..b0300bf1973 100644
--- a/TAO/orbsvcs/IFR_Service/IFR_Service.h
+++ b/TAO/orbsvcs/IFR_Service/IFR_Service.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ========================================================================
-//
-// = LIBRARY
-// orbsvcs/IFR_Service
-//
-// = FILENAME
-// IFR_Service.h
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// =======================================================================
+
+//=============================================================================
+/**
+ * @file IFR_Service.h
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IFR_SERVICE_H
#define IFR_SERVICE_H
diff --git a/TAO/orbsvcs/IFR_Service/be_global.cpp b/TAO/orbsvcs/IFR_Service/be_global.cpp
index a1cf1de6e9b..f010d756b33 100644
--- a/TAO/orbsvcs/IFR_Service/be_global.cpp
+++ b/TAO/orbsvcs/IFR_Service/be_global.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// be_global.cpp
-//
-// = DESCRIPTION
-// Stores global data specific to the compiler back end.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file be_global.cpp
+ *
+ * $Id$
+ *
+ * Stores global data specific to the compiler back end.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "be_global.h"
#include "ast_generator.h"
diff --git a/TAO/orbsvcs/IFR_Service/be_global.h b/TAO/orbsvcs/IFR_Service/be_global.h
index d0c5fb389c0..2935f41d5ea 100644
--- a/TAO/orbsvcs/IFR_Service/be_global.h
+++ b/TAO/orbsvcs/IFR_Service/be_global.h
@@ -1,21 +1,18 @@
/* -*- c++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// be_global.h
-//
-// = DESCRIPTION
-// Header file for class containing compiler back end global data.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file be_global.h
+ *
+ * $Id$
+ *
+ * Header file for class containing compiler back end global data.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_BE_GLOBAL_H
#define TAO_IFR_BE_GLOBAL_H
@@ -43,11 +40,11 @@ public:
// = DESCRIPTION
// Storage of global data specific to the compiler back end
//
+ /// Constructor.
BE_GlobalData (void);
- // Constructor.
+ /// Destructor.
virtual ~BE_GlobalData (void);
- // Destructor.
// Data accessors.
@@ -62,8 +59,8 @@ public:
ACE_Unbounded_Stack<CORBA::Container_ptr> &ifr_scopes (void);
+ /// Cleanup function.
void destroy (void);
- // Cleanup function.
const char *filename (void) const;
void filename (char *fname);
@@ -80,43 +77,43 @@ public:
ACE_CString orb_args (void) const;
void orb_args (const ACE_CString& args);
+ /// Command line passed to ACE_Process::spawn. Different
+ /// implementations in IDL and IFR backends.
ACE_CString spawn_options (void);
- // Command line passed to ACE_Process::spawn. Different
- // implementations in IDL and IFR backends.
+ /// Parse args that affect the backend.
void parse_args (long &i, char **av);
- // Parse args that affect the backend.
private:
+ /// Are we removing IR objects from the repository?
bool removing_;
- // Are we removing IR objects from the repository?
+ /// Reference to our ORB.
CORBA::ORB_var orb_;
- // Reference to our ORB.
+ /// Reference to the interface repository.
CORBA::Repository_var repository_;
- // Reference to the interface repository.
+ /// Must be something unlikely to clash.
CORBA::String_var holding_scope_name_;
- // Must be something unlikely to clash.
+ /// IR object scope stack.
ACE_Unbounded_Stack<CORBA::Container_ptr> ifr_scopes_;
- // IR object scope stack.
+ /// Name of the IDL file we are processing.
char *filename_;
- // Name of the IDL file we are processing.
+ /// Option to lock at the IDL file level.
bool enable_locking_;
- // Option to lock at the IDL file level.
+ /// Option to process included IDL files.
bool do_included_files_;
- // Option to process included IDL files.
+ /// Option to enable duplicate typedefs in parsed IDL.
bool allow_duplicate_typedefs_;
- // Option to enable duplicate typedefs in parsed IDL.
+ /// Holder for -ORB args saved and passed to DRV_fork.
ACE_CString orb_args_;
- // Holder for -ORB args saved and passed to DRV_fork.
};
#endif /* TAO_IFR_BE_GLOBAL_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor.h b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor.h
index bc42e852620..8ee7c3b46a7 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- C++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_adding_visitor.h
-//
-// = DESCRIPTION
-// Header file for class ifr_adding_visitor.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_adding_visitor.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_adding_visitor.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_ADDING_VISITOR_H
#define TAO_IFR_ADDING_VISITOR_H
@@ -29,16 +26,16 @@
class UTL_ExceptList;
+/**
+ * @class ifr_adding_visitor
+ *
+ * @brief ifr_adding_visitor.
+ *
+ * This visitor adds items found in the IDL file being processed
+ * to the Interface Repository.
+ */
class ifr_adding_visitor : public ifr_visitor
{
- //
- // = TITLE
- // ifr_adding_visitor.
- //
- // = DESCRIPTION
- // This visitor adds items found in the IDL file being processed
- // to the Interface Repository.
- //
public:
ifr_adding_visitor (AST_Decl *scope,
CORBA::Boolean in_reopened = 0,
@@ -82,39 +79,39 @@ public:
virtual int visit_native (AST_Native *node);
protected:
+ /// Conversion functions.
CORBA::PrimitiveKind expr_type_to_pkind (AST_Expression::ExprType et);
CORBA::PrimitiveKind predefined_type_to_pkind (AST_PredefinedType *node);
- // Conversion functions.
+ /// Determine the primitive type and insert into the Any.
void load_any (AST_Expression::AST_ExprValue *ev,
CORBA::Any &any);
- // Determine the primitive type and insert into the Any.
+ /// Creates or looks up the element type of an array or sequence,
+ /// and stores the result in ir_current_.
void element_type (AST_Type *base_type, bool owned = false);
- // Creates or looks up the element type of an array or sequence,
- // and stores the result in ir_current_.
+ /// Code encapsulated out of visit_interface().
int create_interface_def (AST_Interface *node);
- // Code encapsulated out of visit_interface().
+ /// Code encapsulated out of visit_valuetype().
int create_value_def (AST_ValueType *node);
- // Code encapsulated out of visit_valuetype().
+ /// Code encapsulated out of visit_component().
int create_component_def (AST_Component *node);
- // Code encapsulated out of visit_component().
+ /// Code encapsulated out of visit_home().
int create_home_def (AST_Home *node);
- // Code encapsulated out of visit_home().
+ /// Code encapsulated out of visit_eventtype().
int create_event_def (AST_EventType *node);
- // Code encapsulated out of visit_eventtype().
+ /// Conditional call from visit_field().
int create_value_member (AST_Field *node);
- // Conditional call from visit_field().
+ /// Utility method to update ir_current_ for struct members, union
+ /// members, operation parameters and operation return types.
void get_referenced_type (AST_Type *node);
- // Utility method to update ir_current_ for struct members, union
- // members, operation parameters and operation return types.
void fill_base_value (CORBA::ValueDef_ptr &result,
AST_ValueType *node);
@@ -172,20 +169,22 @@ protected:
const char *local_name);
protected:
+ /**
+ * Holder for the IR object most recently created or looked up by
+ * the visitor. This makes it accessible by visitor methods that
+ * need the result of a call to another visitor method that
+ * creates an IR object.
+ */
CORBA::IDLType_var ir_current_;
- // Holder for the IR object most recently created or looked up by
- // the visitor. This makes it accessible by visitor methods that
- // need the result of a call to another visitor method that
- // creates an IR object.
+ /// Store the node whose scope (if any) we will be visiting.
AST_Decl *scope_;
- // Store the node whose scope (if any) we will be visiting.
+ /// Are we traversing the scope of a reopened module?
bool in_reopened_;
- // Are we traversing the scope of a reopened module?
+ /// Do we allow duplicate typedefs?
bool allow_duplicate_typedefs_;
- // Do we allow duplicate typedefs?
};
#endif /* TAO_IFR_ADDING_VISITOR_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_exception.h b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_exception.h
index 2e716f65d40..7abac7d0051 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_exception.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_exception.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- c++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_adding_visitor_exception.h
-//
-// = DESCRIPTION
-// Header file for class ifr_adding_visitor_exception.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_adding_visitor_exception.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_adding_visitor_exception.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_ADDING_VISITOR_EXCEPTION_H
#define TAO_IFR_ADDING_VISITOR_EXCEPTION_H
@@ -26,51 +23,51 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_adding_visitor_exception
+ *
+ * @brief ifr_adding_visitor_exception.
+ *
+ * This visitor overrides a few of the visit methods
+ * for the case when an exception node is seen in the AST.
+ */
class ifr_adding_visitor_exception : public ifr_adding_visitor
{
- //
- // = TITLE
- // ifr_adding_visitor_exception.
- //
- // = DESCRIPTION
- // This visitor overrides a few of the visit methods
- // for the case when an exception node is seen in the AST.
- //
public:
+ /// Constructor.
ifr_adding_visitor_exception (AST_Decl *scope,
CORBA::Boolean in_reopened_);
- // Constructor.
+ /// Destructor.
virtual ~ifr_adding_visitor_exception (void);
- // Destructor.
+ /// Visit a struct.
virtual int visit_scope (UTL_Scope *node);
- // Visit a struct.
+ /// Visit a struct.
virtual int visit_structure (AST_Structure *node);
- // Visit a struct.
+ /// Visit a struct.
virtual int visit_exception (AST_Exception *node);
- // Visit a struct.
+ /// Visit an enum.
virtual int visit_enum (AST_Enum *node);
- // Visit an enum.
+ /// Visit union.
virtual int visit_union (AST_Union *node);
- // Visit union.
+ /// Lets the visitor one level above acess this value.
virtual CORBA::IDLType_ptr ir_current (void) const;
- // Lets the visitor one level above acess this value.
private:
+ /// Common code called whether we are creating a new exception
+ /// or filling out a forward declaration.
int add_members (AST_Exception *node, CORBA::ExceptionDef_ptr except_def);
- // Common code called whether we are creating a new exception
- // or filling out a forward declaration.
private:
+ /// Holder for the member list passed to create_struct() or
+ /// create_exception().
CORBA::StructMemberSeq members_;
- // Holder for the member list passed to create_struct() or
- // create_exception().
};
diff --git a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_operation.h b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_operation.h
index 73cc1bb6e95..33f4646614e 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_operation.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_operation.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- C++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_adding_visitor_operation.h
-//
-// = DESCRIPTION
-// Header file for class ifr_adding_visitor_operation.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_adding_visitor_operation.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_adding_visitor_operation.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_ADDING_VISITOR_OPERATION_H
#define TAO_IFR_ADDING_VISITOR_OPERATION_H
@@ -26,36 +23,36 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_adding_visitor_operation
+ *
+ * @brief ifr_adding_visitor_operation.
+ *
+ * This visitor overrides a few of the visit methods
+ * for the case when an operation node is seen in the AST.
+ */
class ifr_adding_visitor_operation : public ifr_adding_visitor
{
- //
- // = TITLE
- // ifr_adding_visitor_operation.
- //
- // = DESCRIPTION
- // This visitor overrides a few of the visit methods
- // for the case when an operation node is seen in the AST.
- //
public:
+ /// Constructor.
ifr_adding_visitor_operation (AST_Decl *scope);
- // Constructor.
+ /// Destructor.
virtual ~ifr_adding_visitor_operation (void);
- // Destructor.
+ /// Visit an operation.
virtual int visit_operation (AST_Operation *node);
- // Visit an operation.
+ /// Visit argument.
virtual int visit_argument (AST_Argument *node);
- // Visit argument.
private:
+ /// Holder for the operation parameter info passed to the
+ /// interface repository method create_operation().
CORBA::ParDescriptionSeq params_;
- // Holder for the operation parameter info passed to the
- // interface repository method create_operation().
+ /// Counter for building the parameter list.
CORBA::ULong index_;
- // Counter for building the parameter list.
};
#endif /* TAO_IFR_ADDING_VISITOR_OPERATION_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_structure.h b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_structure.h
index 0be2c96e0bb..24687da8af1 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_structure.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_structure.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- C++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_adding_visitor_structure.h
-//
-// = DESCRIPTION
-// Header file for class ifr_adding_visitor_structure.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_adding_visitor_structure.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_adding_visitor_structure.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_ADDING_VISITOR_STRUCTURE_H
#define TAO_IFR_ADDING_VISITOR_STRUCTURE_H
@@ -26,16 +23,16 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_adding_visitor_structure
+ *
+ * @brief ifr_adding_visitor_structure.
+ *
+ * This visitor overrides a few of the visit methods
+ * for the case when a struct or exception node is seen in the AST.
+ */
class ifr_adding_visitor_structure : public ifr_adding_visitor
{
- //
- // = TITLE
- // ifr_adding_visitor_structure.
- //
- // = DESCRIPTION
- // This visitor overrides a few of the visit methods
- // for the case when a struct or exception node is seen in the AST.
- //
public:
ifr_adding_visitor_structure (AST_Decl *scope);
@@ -46,18 +43,18 @@ public:
virtual int visit_enum (AST_Enum *node);
virtual int visit_union (AST_Union *node);
+ /// Lets the visitor one level above acess this value.
virtual CORBA::IDLType_ptr ir_current (void) const;
- // Lets the visitor one level above acess this value.
private:
+ /// Common code called whether we are creating a new struct
+ /// or filling out a forward declaration.
int add_members (AST_Structure *node, CORBA::StructDef_ptr struct_def);
- // Common code called whether we are creating a new struct
- // or filling out a forward declaration.
private:
+ /// Holder for the member list passed to create_struct() or
+ /// create_exception().
CORBA::StructMemberSeq members_;
- // Holder for the member list passed to create_struct() or
- // create_exception().
};
#endif /* TAO_IFR_ADDING_VISITOR_STRUCTURE_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_union.h b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_union.h
index bb19ea4ed0d..496b7224e3a 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_union.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_adding_visitor_union.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- C++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_adding_visitor_union.h
-//
-// = DESCRIPTION
-// Header file for class ifr_adding_visitor_union.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_adding_visitor_union.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_adding_visitor_union.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_ADDING_VISITOR_UNION_H
#define TAO_IFR_ADDING_VISITOR_UNION_H
@@ -26,16 +23,16 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_adding_visitor_union
+ *
+ * @brief ifr_adding_visitor_exception.
+ *
+ * This visitor overrides a few of the visit methods
+ * for the case when a union node is seen in the AST.
+ */
class ifr_adding_visitor_union : public ifr_adding_visitor
{
- //
- // = TITLE
- // ifr_adding_visitor_exception.
- //
- // = DESCRIPTION
- // This visitor overrides a few of the visit methods
- // for the case when a union node is seen in the AST.
- //
public:
ifr_adding_visitor_union (AST_Decl *scope);
@@ -46,23 +43,25 @@ public:
virtual int visit_enum (AST_Enum *node);
virtual int visit_union (AST_Union *node);
+ /// Lets the visitor one level above acess this value.
virtual CORBA::IDLType_ptr ir_current (void) const;
- // Lets the visitor one level above acess this value.
private:
+ /// Common code called whether we are creating a new union
+ /// or filling out a forward declaration.
int add_members (AST_Union *node, CORBA::UnionDef_ptr union_def);
- // Common code called whether we are creating a new union
- // or filling out a forward declaration.
private:
+ /// Holder for the member list passed to create_struct() or
+ /// create_exception().
CORBA::UnionMemberSeq members_;
- // Holder for the member list passed to create_struct() or
- // create_exception().
+ /**
+ * Holds the typecode of the discriminator (used only if the
+ * discriminator is an enum type, so we can insert the label
+ * values into Anys for UnionMemberSeq[i].label).
+ */
CORBA::TypeCode_var disc_tc_;
- // Holds the typecode of the discriminator (used only if the
- // discriminator is an enum type, so we can insert the label
- // values into Anys for UnionMemberSeq[i].label).
};
#endif /* TAO_IFR_ADDING_VISITOR_UNION_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_removing_visitor.h b/TAO/orbsvcs/IFR_Service/ifr_removing_visitor.h
index 4b6f82fa44e..fafd298476f 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_removing_visitor.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_removing_visitor.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- c++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_removing_visitor.h
-//
-// = DESCRIPTION
-// Header file for class ifr_removing_visitor.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_removing_visitor.h
+ *
+ * $Id$
+ *
+ * Header file for class ifr_removing_visitor.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_REMOVING_VISITOR_H
#define TAO_IFR_REMOVING_VISITOR_H
@@ -26,28 +23,28 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_removing_visitor
+ *
+ * @brief ifr_removing_visitor.
+ *
+ * This visitor removes items found in the IDL file being processed
+ * from the Interface Repository.
+ */
class ifr_removing_visitor : public ifr_visitor
{
- //
- // = TITLE
- // ifr_removing_visitor.
- //
- // = DESCRIPTION
- // This visitor removes items found in the IDL file being processed
- // from the Interface Repository.
- //
public:
+ /// Constructor.
ifr_removing_visitor (void);
- // Constructor.
+ /// Destructor.
virtual ~ifr_removing_visitor (void);
- // Destructor.
+ /// Visit the scope.
virtual int visit_scope (UTL_Scope *node);
- // Visit the scope.
+ /// Visit the root.
virtual int visit_root (AST_Root *node);
- // Visit the root.
};
#endif /* TAO_IFR_REMOVING_VISITOR_H */
diff --git a/TAO/orbsvcs/IFR_Service/ifr_visitor.h b/TAO/orbsvcs/IFR_Service/ifr_visitor.h
index f9b91f173b3..1074e1c0fbd 100644
--- a/TAO/orbsvcs/IFR_Service/ifr_visitor.h
+++ b/TAO/orbsvcs/IFR_Service/ifr_visitor.h
@@ -1,21 +1,18 @@
-// $Id$
/* -*- c++ -*- */
-// ============================================================================
-//
-// = LIBRARY
-// TAO_IFR_BE_DLL
-//
-// = FILENAME
-// ifr_visitor.h
-//
-// = DESCRIPTION
-// The Interface Repository administration visitor base class.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ifr_visitor.h
+ *
+ * $Id$
+ *
+ * The Interface Repository administration visitor base class.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IFR_VISITOR_H
#define TAO_IFR_VISITOR_H
@@ -28,17 +25,17 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ifr_visitor
+ *
+ * @brief ifr_visitor.
+ *
+ * Base class for the IfR administration visitors. The methods are
+ * not pure virtual to facilitate the implementation of some
+ * derived visitors that override only a few.
+ */
class ifr_visitor : public ast_visitor
{
- //
- // = TITLE
- // ifr_visitor.
- //
- // = DESCRIPTION
- // Base class for the IfR administration visitors. The methods are
- // not pure virtual to facilitate the implementation of some
- // derived visitors that override only a few.
- //
public:
virtual ~ifr_visitor (void);
@@ -94,16 +91,16 @@ public:
virtual int visit_native (AST_Native *node);
virtual int visit_param_holder (AST_Param_Holder *node);
+ /// Accessor for our lock.
ACE_Lock &lock (void) const;
- // Accessor for our lock.
protected:
// Not abstract but we want to force subclassing anyway.
ifr_visitor (void);
private:
+ /// Lock.
ACE_Lock *lock_;
- // Lock.
};
#endif /* TAO_IFR_VISITOR_H */
diff --git a/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp b/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp
index 81713505d56..c56a9ec5ee6 100644
--- a/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp
+++ b/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Criteria_Evaluator.cpp
-//
-// = DESCRIPTION
-// An Evaluator for the CosLifeCycle Criteria
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Criteria_Evaluator.cpp
+ *
+ * $Id$
+ *
+ * An Evaluator for the CosLifeCycle Criteria
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Criteria_Evaluator.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.h b/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.h
index 346685a6993..7f0d96565a6 100644
--- a/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.h
+++ b/TAO/orbsvcs/LifeCycle_Service/Criteria_Evaluator.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Criteria_Evaluaotr.h
-//
-// = DESCRIPTION
-// An Evaluator for the CosLifeCycle Criteria
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Criteria_Evaluaotr.h
+ *
+ * $Id$
+ *
+ * An Evaluator for the CosLifeCycle Criteria
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "orbsvcs/CosLifeCycleC.h"
@@ -20,10 +20,12 @@
#ifndef CRITERIA_EVALUATOR_H_H
#define CRITERIA_EVALUATOR_H_H
+/**
+ * @class Criteria_Evaluator//
+ *
+ */
class Criteria_Evaluator// : public LifeCycleService::Criteria_Evaluator
{
- // = TITLE
- //
public:
Criteria_Evaluator (const CosLifeCycle::Criteria &criteria);
~Criteria_Evaluator (void);
diff --git a/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.cpp b/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.cpp
index 90786a10729..aced8420040 100644
--- a/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.cpp
+++ b/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.cpp
@@ -1,23 +1,21 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//
-// = FILENAME
-// Factory_Trader.cpp
-//
-// = DESCRIPTION
-// A colocated instance of the Trading Service, only part of
-// the functionality provided is used. This class serves
-// as Wrapper around the Trading Service and provides
-// smaller interfaces.
-// TRADER_AVAILABLE is defined via compiler switch in the Makefile
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Factory_Trader.cpp
+ *
+ * $Id$
+ *
+ * A colocated instance of the Trading Service, only part of
+ * the functionality provided is used. This class serves
+ * as Wrapper around the Trading Service and provides
+ * smaller interfaces.
+ * TRADER_AVAILABLE is defined via compiler switch in the Makefile
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "Factory_Trader.h"
#include "orbsvcs/CosTradingC.h"
diff --git a/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.h b/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.h
index ebf8a024d32..a2151d4244d 100644
--- a/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.h
+++ b/TAO/orbsvcs/LifeCycle_Service/Factory_Trader.h
@@ -1,18 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-//
-// = FILENAME
-// Factory_Trader.cpp
-//
-// = DESCRIPTION
-// Factory Trader for the Generic Factory.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Factory_Trader.cpp
+ *
+ * $Id$
+ *
+ * Factory Trader for the Generic Factory.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef FACTORY_TRADER_H
#define FACTORY_TRADER_H
@@ -28,17 +26,17 @@ public:
Factory_Trader (int debug_level = 1);
~Factory_Trader ();
+ /// Add a the Factory type to the repository
void add_type ();
- // Add a the Factory type to the repository
+ /// export a specific factory
void _cxx_export (const char * name,
const char * location,
const char * description,
const CORBA::Object_ptr object_ptr);
- // export a specific factory
+ /// query for a specific factory using a constraint
CORBA::Object_ptr query (const char* constraint);
- // query for a specific factory using a constraint
static const char * GENERIC_FACTORY_INTERFACE_REPOSITORY_ID;
private:
@@ -47,8 +45,8 @@ private:
TAO_Trading_Components_i *trading_Components_ptr_;
TAO_Support_Attributes_i *support_Attributes_ptr_;
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif // FACTORY_TRADER_H
diff --git a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp
index 34ab729be84..24c316904dd 100644
--- a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp
+++ b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Life_Cycle_Service.cpp
-//
-// = DESCRIPTION
-// The server for the LifeCycleService of the quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Life_Cycle_Service.cpp
+ *
+ * $Id$
+ *
+ * The server for the LifeCycleService of the quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "LifeCycle_Service.h"
diff --git a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.h b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.h
index 112c0e431b5..553be958ec7 100644
--- a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.h
+++ b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// LifeCycle_Service.h
-//
-// = DESCRIPTION
-// A creation service for objects using the CosLifeCycle GenericFactory.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file LifeCycle_Service.h
+ *
+ * $Id$
+ *
+ * A creation service for objects using the CosLifeCycle GenericFactory.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
@@ -25,41 +25,44 @@
#ifndef LIFECYCLE_SERVICE_H
#define LIFECYCLE_SERVICE_H
+/**
+ * @class Life_Cycle_Service_Server
+ = TILE
+ * Server object for the LifeCycle Service
+ */
class Life_Cycle_Service_Server
{
- // = TILE
- // Server object for the LifeCycle Service
public:
+ /// Default constructor
Life_Cycle_Service_Server (void);
- // Default constructor
+ /// Destructor
~Life_Cycle_Service_Server (void);
- // Destructor
+ /// Initialize the Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Server state - parsing arguments and ...
+ /// Run the orb.
int run (void);
- // Run the orb.
+ /// Parse the passed parameters.
u_int parse_args (int argc,
ACE_TCHAR* argv[]);
- // Parse the passed parameters.
private:
+ /// instance of the ORB Manager
TAO_ORB_Manager orb_manager_;
- // instance of the ORB Manager
+ /// Instance of the creation service
Life_Cycle_Service_i *life_Cycle_Service_i_ptr_;
- // Instance of the creation service
+ /// reference to the naming service
CosNaming::NamingContext_var namingContext_var_;
- // reference to the naming service
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* LIFECYCLE_SERVICE_H */
diff --git a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp
index c7212503fd7..0202f129108 100644
--- a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp
+++ b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Life_Cycle_Service_i.cpp
-//
-// = DESCRIPTION
-// The implementation of a LifeCycle Service GenericFactory.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Life_Cycle_Service_i.cpp
+ *
+ * $Id$
+ *
+ * The implementation of a LifeCycle Service GenericFactory.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
diff --git a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h
index 2d0aa105925..9be8a4d7077 100644
--- a/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h
+++ b/TAO/orbsvcs/LifeCycle_Service/LifeCycle_Service_i.h
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// LifeCycle_Service_i.h
-//
-// = DESCRIPTION
-// A Life Cycle Service for the Quoter example.
-//
-// = AUTHOR
-// Michael Kircher (mk1@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file LifeCycle_Service_i.h
+ *
+ * $Id$
+ *
+ * A Life Cycle Service for the Quoter example.
+ *
+ *
+ * @author Michael Kircher (mk1@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "orbsvcs/LifeCycleServiceS.h"
#include "Factory_Trader.h"
@@ -20,24 +20,29 @@
#ifndef LIFECYCLE_SERVICE_IMPL_H
#define LIFECYCLE_SERVICE_IMPL_H
+/**
+ * @class Life_Cycle_Service_i
+ = TILE
+ * A CosLifeCycle conforming Generic Factory.
+ */
class Life_Cycle_Service_i : public POA_LifeCycleService::Life_Cycle_Service
{
- // = TILE
- // A CosLifeCycle conforming Generic Factory.
public:
Life_Cycle_Service_i (int debug_level = 1);
~Life_Cycle_Service_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.
void register_factory (const char * name,
const char * location,
@@ -49,8 +54,8 @@ public:
private:
Factory_Trader *factory_trader_ptr_;
+ /// debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
int debug_level_;
- // debug level (0 = quiet, 1 = default, informative, 2+ = noisy);
};
#endif /* LIFECYCLE_SERVICE_IMPL_H */
diff --git a/TAO/orbsvcs/Naming_Service/NT_Naming_Server.cpp b/TAO/orbsvcs/Naming_Service/NT_Naming_Server.cpp
index d0623f57192..f13ebbcbe59 100644
--- a/TAO/orbsvcs/Naming_Service/NT_Naming_Server.cpp
+++ b/TAO/orbsvcs/Naming_Service/NT_Naming_Server.cpp
@@ -1,24 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// NT_Naming_Server.cpp
-//
-//
-// = DESCRIPTION
-// Driver program that runs the TAO Naming Service as a Windows NT
-// Service.
-//
-// = AUTHORS
-// John Tucker <jtucker@infoglide.com> and
-// Mike Vitalo <mvitalo@infoglide.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file NT_Naming_Server.cpp
+ *
+ * $Id$
+ *
+ * Driver program that runs the TAO Naming Service as a Windows NT
+ * Service.
+ *
+ *
+ * @author John Tucker <jtucker@infoglide.com> and Mike Vitalo <mvitalo@infoglide.com>
+ */
+//=============================================================================
+
#include "ace/Log_Msg.h"
@@ -43,10 +38,13 @@ ACE_TMAIN(int, ACE_TCHAR *[])
// Default for the -i (install) option
#define DEFAULT_SERVICE_INIT_STARTUP SERVICE_DEMAND_START
+/**
+ * @class Options
+ *
+ * @brief Keeps track of the command-line options for this program.
+ */
class Options
{
- // = TITLE
- // Keeps track of the command-line options for this program.
public:
Options (void);
~Options (void);
diff --git a/TAO/orbsvcs/Notify_Service/NT_Notify_Server.cpp b/TAO/orbsvcs/Notify_Service/NT_Notify_Server.cpp
index 0343052703b..703e27f02a2 100644
--- a/TAO/orbsvcs/Notify_Service/NT_Notify_Server.cpp
+++ b/TAO/orbsvcs/Notify_Service/NT_Notify_Server.cpp
@@ -1,25 +1,21 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// NT_Notify_Server.cpp
-//
-//
-// = DESCRIPTION
-// Driver program that runs the TAO Notification Service as a Windows NT
-// Service.
-//
-// = AUTHORS
-// John Tucker <jtucker@infoglide.com>,
-// Mike Vitalo <mvitalo@infoglide.com>, and
-// David Robison <drrobison@openroadsconsulting.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file NT_Notify_Server.cpp
+ *
+ * $Id$
+ *
+ * Driver program that runs the TAO Notification Service as a Windows NT
+ * Service.
+ *
+ *
+ * @author John Tucker <jtucker@infoglide.com>
+ * @author Mike Vitalo <mvitalo@infoglide.com>
+ * @author and David Robison <drrobison@openroadsconsulting.com>
+ */
+//=============================================================================
+
#include "ace/Log_Msg.h"
@@ -47,10 +43,13 @@ ACE_TMAIN(int, ACE_TCHAR *[])
// Default for the -i (install) option
#define DEFAULT_SERVICE_INIT_STARTUP SERVICE_DEMAND_START
+/**
+ * @class Options
+ *
+ * @brief Keeps track of the command-line options for this program.
+ */
class Options
{
- // = TITLE
- // Keeps track of the command-line options for this program.
public:
Options (void);
~Options (void);
diff --git a/TAO/orbsvcs/TAO_Service/TAO_Service.cpp b/TAO/orbsvcs/TAO_Service/TAO_Service.cpp
index eae63229c81..a5b9df174b5 100644
--- a/TAO/orbsvcs/TAO_Service/TAO_Service.cpp
+++ b/TAO/orbsvcs/TAO_Service/TAO_Service.cpp
@@ -1,22 +1,19 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// orbsvcs/TAO_Service/
-//
-// = FILENAME
-// TAO_Service.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
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file TAO_Service.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 Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "tao/ORB_Constants.h"
#include "tao/ORB.h"
diff --git a/TAO/orbsvcs/Time_Service/Clerk_i.h b/TAO/orbsvcs/Time_Service/Clerk_i.h
index bd9ce302f01..0b4f8c700da 100644
--- a/TAO/orbsvcs/Time_Service/Clerk_i.h
+++ b/TAO/orbsvcs/Time_Service/Clerk_i.h
@@ -1,18 +1,15 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Time_Service
-//
-// = FILENAME
-// Clerk_i.h
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Clerk_i.h
+ *
+ * $Id$
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CLERK_I_H
#define CLERK_I_H
@@ -24,14 +21,16 @@
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/Time/TAO_Time_Service_Clerk.h"
+/**
+ * @class Clerk_i
+ *
+ * @brief CORBA Time Clerk implementation.
+ *
+ * A CORBA server that initializes the TimeService clerk
+ * implementation and the ORB.
+ */
class Clerk_i
{
- // = TITLE
- // CORBA Time Clerk implementation.
- //
- // = DESCRIPTION
- // A CORBA server that initializes the TimeService clerk
- // implementation and the ORB.
public:
enum {
@@ -41,98 +40,100 @@ public:
};
// = Initialization and termination methods.
+ /// Constructor.
Clerk_i (void);
- // Constructor.
+ /// Destructor.
~Clerk_i (void);
- // Destructor.
+ /// Set of available Time servers.
typedef ACE_Array_Base<CosTime::TimeService_var> IORS;
- // Set of available Time servers.
+ /// Initialize the Clerk state - parsing arguments and waiting.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Clerk state - parsing arguments and waiting.
+ /// Run the orb.
int run (void);
- // Run the orb.
private:
+ /// Insert a server in the internal data structure (servers_).
void insert_server (CosTime::TimeService_ptr server);
- // Insert a server in the internal data structure (servers_).
private:
+ /// Read the server IORs from a file instead of using a naming
+ /// service.
int read_ior (const ACE_TCHAR* filename);
- // Read the server IORs from a file instead of using a naming
- // service.
+ /// 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 where the IOR of the Clerk object is stored.
FILE *ior_output_file_;
- // File where the IOR of the Clerk object is stored.
+ /// Initialises the name client and registers the <TimeService> Clerk
+ /// object with it.
int init_naming_service ();
- // Initialises the name client and registers the <TimeService> Clerk
- // object with it.
+ /// Create an instance of the clerk to use.
int create_clerk (void);
- // Create an instance of the clerk to use.
+ /// Bind the clerk in the appropriate context in the Naming Service.
int register_clerk (void);
- // Bind the clerk in the appropriate context in the Naming Service.
+ /// Initialise the Interface Repository and register the clerk
+ /// implementation with it.
int init_IR (void);
- // Initialise the Interface Repository and register the clerk
- // implementation with it.
+ /// Get the reference to the server naming context and the first
+ /// server IOR.
int get_first_IOR (void);
- // Get the reference to the server naming context and the first
- // server IOR.
+ /// Iterate over the given server context to get the rest of the
+ /// server IORs.
int next_n_IORs (CosNaming::BindingIterator_var iter,
CosNaming::NamingContext_var server_context);
- // Iterate over the given server context to get the rest of the
- // server IORs.
+ /**
+ * An instance of the name server used for registering the
+ * <TimeService Clerk> object. The same instance is used by the
+ * Clerk to periodically iterate through the Server Naming Context
+ * and get IORs of the available servers.
+ */
TAO_Naming_Client naming_client_;
- // An instance of the name server used for registering the
- // <TimeService Clerk> object. The same instance is used by the
- // Clerk to periodically iterate through the Server Naming Context
- // and get IORs of the available servers.
+ /// Implementation of the <TimeService> Clerk object.
TAO_Time_Service_Clerk *time_service_clerk_impl_;
- // Implementation of the <TimeService> Clerk object.
+ /// Reference of the time service clerk.
CosTime::TimeService_var time_service_clerk_;
- // Reference of the time service clerk.
+ /// Naming context for the Naming Service.
CosNaming::NamingContext_var time_service_clerk_context_;
- // Naming context for the Naming Service.
+ /// My orb.
CORBA::ORB_var orb_;
- // My orb.
+ /// Clerk seeks time periodically after this interval in secs. from the
+ /// servers in the network.
int timer_value_ ;
- // Clerk seeks time periodically after this interval in secs. from the
- // servers in the network.
+ /// Continues the precision of timer_value_ in microseconds.
int timer_value_usecs_;
- // Continues the precision of timer_value_ in microseconds.
// IR_Helper *ir_helper_;
// Helper class for using the IR.
+ /// The unbounded set of server IORS.
IORS server_;
- // The unbounded set of server IORS.
+ /// Read IORs from a file.
int ior_fp_;
- // Read IORs from a file.
};
#endif /* CLERK_I_H */
diff --git a/TAO/orbsvcs/Time_Service/Server_i.h b/TAO/orbsvcs/Time_Service/Server_i.h
index 2727cc51ec8..c7c62376c74 100644
--- a/TAO/orbsvcs/Time_Service/Server_i.h
+++ b/TAO/orbsvcs/Time_Service/Server_i.h
@@ -1,18 +1,15 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Time_Service
-//
-// = FILENAME
-// Server_i.h
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Server_i.h
+ *
+ * $Id$
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVER_I_H
#define SERVER_I_H
@@ -24,65 +21,67 @@
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/Time/TAO_Time_Service_Server.h"
+/**
+ * @class Server_i
+ *
+ * @brief CORBA Server implementation.
+ *
+ * A CORBA server that initializes the <TimeService Server>
+ * servant implementation and the ORB.
+ */
class Server_i
{
- // = TITLE
- // CORBA Server implementation.
- //
- // = DESCRIPTION
- // A CORBA server that initializes the <TimeService Server>
- // servant implementation and the ORB.
public:
// = Initialization and termination methods.
+ /// Constructor.
Server_i (void);
- // Constructor.
+ /// Destructor.
~Server_i (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.
+ /// Initialises the name client.
int init_naming_service ();
- // Initialises the name client.
+ /// Create the time server object.
int create_server (void);
- // Create the time server object.
+ /// Register the time server object with the Naming Service.
int register_server (void);
- // Register the time server object with the Naming Service.
+ /// Parse the commandline arguments.
int parse_args (int argc,
ACE_TCHAR* argv[]);
- // Parse the commandline arguments.
private:
+ /// My orb.
CORBA::ORB_var orb_;
- // My orb.
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// File where the IOR of the Clerk object is stored.
FILE *ior_output_file_;
- // File where the IOR of the Clerk object is stored.
+ /// An instance of the name server used for registering the
+ /// <TimeService Server> object.
TAO_Naming_Client naming_client_;
- // An instance of the name server used for registering the
- // <TimeService Server> object.
+ /// Implementation of the <TimeService> Server object.
TAO_Time_Service_Server *time_service_server_impl_;
- // Implementation of the <TimeService> Server object.
+ /// Reference of the time server.
CosTime::TimeService_var time_service_server_;
- // Reference of the time server.
+ /// Naming context for the Naming Service.
CosNaming::NamingContext_var time_service_server_context_;
- // Naming context for the Naming Service.
};
#endif /* SERVER_I_H */
diff --git a/TAO/orbsvcs/Trading_Service/Trading_Service.h b/TAO/orbsvcs/Trading_Service/Trading_Service.h
index b33337661f7..bcd169bc287 100644
--- a/TAO/orbsvcs/Trading_Service/Trading_Service.h
+++ b/TAO/orbsvcs/Trading_Service/Trading_Service.h
@@ -1,19 +1,15 @@
// -*- C++ -*-
-//
-// $Id$
-
-// ========================================================================
-//
-// = BINARY
-// trader
-//
-// = FILENAME
-// Trading_Service.h
-//
-// = AUTHOR
-// Seth Widoff <sbw1@cs.wustl.edu>
-//
-// =======================================================================
+
+//=============================================================================
+/**
+ * @file Trading_Service.h
+ *
+ * $Id$
+ *
+ * @author Seth Widoff <sbw1@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _TRADING_SERVICE_H
#define _TRADING_SERVICE_H
@@ -32,52 +28,58 @@
class Trading_Service;
+/**
+ * @class Trading_Shutdown
+ *
+ * @brief A class that shutsdown a Trading Service instance.
+ */
class Trading_Shutdown : public ACE_Event_Handler
{
- // = TITLE
- // A class that shutsdown a Trading Service instance.
public:
+ /// Constructor.
Trading_Shutdown (Trading_Service& trader);
- // Constructor.
+ /// Signal handler.
virtual int handle_signal (int,
siginfo_t *,
ucontext_t *);
- // Signal handler.
protected:
Trading_Service &trader_;
ACE_Sig_Handler shutdown_;
};
+/**
+ * @class Trading_Service
+ *
+ * @brief A class that initializes a Trading Service instance.
+ */
class Trading_Service
{
- // = TITLE
- // A class that initializes a Trading Service instance.
public:
+ /// Default constructor.
Trading_Service (void);
- // Default constructor.
+ /// Destructor
~Trading_Service (void);
- // Destructor
+ /// Initialize the Trading Service with arguments.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Trading Service with arguments.
+ /// Run the Trading Service.
int run (void);
- // Run the Trading Service.
int shutdown (void);
protected:
+ /// Pointer to the linked trader.
auto_ptr<TAO_Trader_Factory::TAO_TRADER> trader_;
- // Pointer to the linked trader.
+ /// Instance of TAO_Trading_Laoder
TAO_Trading_Loader trading_loader_;
- // Instance of TAO_Trading_Laoder
};
#endif /* _TRADING_SERVICE_H */
diff --git a/TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h b/TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h
index 13ebcb5b406..df950da6a24 100644
--- a/TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h
+++ b/TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/examples/CosEC/Factory
-//
-// = FILENAME
-// CosEventChannelFactory_i.h
-//
-// = DESCRIPTION
-// This class implements the CosEventChannelFactory
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CosEventChannelFactory_i.h
+ *
+ * $Id$
+ *
+ * This class implements the CosEventChannelFactory
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_COSEVENTCHANNELFACTORY_I_H
#define TAO_COSEVENTCHANNELFACTORY_I_H
@@ -34,32 +31,34 @@ class TAO_CosEventChannelFactory_i :
{
public:
// = Initialization and termination code.
+ /// Constructor.
TAO_CosEventChannelFactory_i (void);
- // Constructor.
+ /// Destructor.
~TAO_CosEventChannelFactory_i (void);
- // Destructor.
+ /**
+ * This method creates a child poa with <poa> as the
+ * parent. It also accepts a Naming_Context which is used to register
+ * the event channels if specified.
+ * Returns -1 on error, 0 on success.
+ * @@ Pradeep: this looks OK. I wonder if it would be a good idea to
+ * raise exceptions, but I'm undecided.
+ * @@ Pradeep: when is the child poa destroyed? Maybe we should add
+ * a destroy() method to the factory interface (in IDL).
+ * @@ Carlos: if we add a <destroy> to the factory, any client will be
+ * able to destroy the factory!
+ * @@ Pradeep: it could be a method of the Factory_i class, it
+ * doesn't have to be exposed through the IDL interface. Anyway,
+ * there must be a way to cleanup any resources created by the
+ * factory, and you must avoid CORBA calls in the destructor,
+ * first because you won't have an and second because
+ * exceptions in destructors are evil.
+ * @@ Pradeep: anyway you can just use exceptions and not return -1?
+ */
int init (PortableServer::POA_ptr poa,
const char* child_poa_name,
CosNaming::NamingContext_ptr naming = CosNaming::NamingContext::_nil ());
- // This method creates a child poa with <poa> as the
- // parent. It also accepts a Naming_Context which is used to register
- // the event channels if specified.
- // Returns -1 on error, 0 on success.
- // @@ Pradeep: this looks OK. I wonder if it would be a good idea to
- // raise exceptions, but I'm undecided.
- // @@ Pradeep: when is the child poa destroyed? Maybe we should add
- // a destroy() method to the factory interface (in IDL).
- // @@ Carlos: if we add a <destroy> to the factory, any client will be
- // able to destroy the factory!
- // @@ Pradeep: it could be a method of the Factory_i class, it
- // doesn't have to be exposed through the IDL interface. Anyway,
- // there must be a way to cleanup any resources created by the
- // factory, and you must avoid CORBA calls in the destructor,
- // first because you won't have an and second because
- // exceptions in destructors are evil.
- // @@ Pradeep: anyway you can just use exceptions and not return -1?
// = CosEventChannelFactory::ChannelFactory methods.
virtual CosEventChannelAdmin::EventChannel_ptr create
@@ -85,11 +84,11 @@ class TAO_CosEventChannelFactory_i :
);
protected:
+ /// The Poa with which we activate all the Event Channels.
PortableServer::POA_var poa_;
- // The Poa with which we activate all the Event Channels.
+ /// The naming context to use.
CosNaming::NamingContext_var naming_;
- // The naming context to use.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/Factory/FactoryDriver.h b/TAO/orbsvcs/examples/CosEC/Factory/FactoryDriver.h
index 866c7c840e8..40c1af54d1f 100644
--- a/TAO/orbsvcs/examples/CosEC/Factory/FactoryDriver.h
+++ b/TAO/orbsvcs/examples/CosEC/Factory/FactoryDriver.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/examples/CosEC/Factory
-//
-// = FILENAME
-// FactoryDriver.h
-//
-// = DESCRIPTION
-// This class implements the Factory driver.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryDriver.h
+ *
+ * $Id$
+ *
+ * This class implements the Factory driver.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_FACTORYDRIVER_H
#define TAO_FACTORYDRIVER_H
@@ -29,52 +26,54 @@
// using the -ORBInitRef mechanisms? That way we can run this
// stuff without the naming service running.
+ /**
+ * @class FactoryDriver
+ *
+ * @brief Driver class for the CosEventChannel Factory.
+ *
+ * creates a CosEventChannel Factory and registers it with the
+ * naming service.
+ */
class FactoryDriver
{
- // = TITLE
- // Driver class for the CosEventChannel Factory.
- // = DESCRIPTION
- // creates a CosEventChannel Factory and registers it with the
- // naming service.
- //
public:
// = Initialization and termination code.
+ /// Constructor.
FactoryDriver (const ACE_TCHAR* factory = ACE_TEXT("CosEC_Factory"));
- // Constructor.
+ /// Destructor.
~FactoryDriver (void);
- // Destructor.
+ /// Start the driver.
int start (int argc, ACE_TCHAR *argv []);
- // Start the driver.
+ ///Stop the driver.
int stop (void);
- //Stop the driver.
protected:
+ /// Parse the command-line arguments and set options.
int parse_args (int argc, ACE_TCHAR *argv []);
- // Parse the command-line arguments and set options.
+ /// The name of the factory registered with the naming service.
const ACE_TCHAR *factoryName_;
- // The name of the factory registered with the naming service.
+ /// The name of the Child POA.
const char* child_poa_name_;
- // The name of the Child POA.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// The factory servant.
TAO_CosEventChannelFactory_i *factory_servant_;
- // The factory servant.
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The corba object after activation.
CosEventChannelFactory::ChannelFactory_var factory_;
- // The corba object after activation.
+ /// Use a naming client.
TAO_Naming_Client naming_client_;
- // Use a naming client.
};
#endif /* TAO_FACTORYDRIVER_H */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h
index 5b9a122d54e..bc061941e68 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/bin/RtEC_Based_CosEC.h
@@ -1,17 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// RtEC_Based_CosEC.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// The COS Event Channel service.
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file RtEC_Based_CosEC.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * The COS Event Channel service.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef RTEC_BASED_COSEC_H
#define RTEC_BASED_COSEC_H
@@ -24,77 +25,79 @@
#pragma warning(disable:4250)
#endif /* _MSC_VER */
+/**
+ * @class RtEC_Based_CosEC
+ *
+ * @brief RtEC_Based_CosEC
+ *
+ * Implementation of the COS Event Service.
+ */
class RtEC_Based_CosEC : public CosEC_ServantBase
{
- // = TITLE
- // RtEC_Based_CosEC
- //
- // = DESCRIPTION
- // Implementation of the COS Event Service.
public:
// = Initialization and termination methods.
+ /// Constructor.
RtEC_Based_CosEC (void);
- // Constructor.
+ /// Destructor.
virtual ~RtEC_Based_CosEC (void);
- // Destructor.
+ /// Parses the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv []);
- // Parses the command line arguments.
+ /// Initializes the COS Event Service.
+ /// Returns 0 on success, -1 on error.
void startup (int argc, ACE_TCHAR *argv[]);
- // Initializes the COS Event Service.
- // Returns 0 on success, -1 on error.
+ /// run the COS Event Service.
+ /// Returns 0 on success, -1 on error.
int run (void);
- // run the COS Event Service.
- // Returns 0 on success, -1 on error.
+ /// Shutdown the COS Event Service.
+ /// Returns 0 on success, -1 on error.
void shutdown (void);
- // Shutdown the COS Event Service.
- // Returns 0 on success, -1 on error.
protected:
// = Methods from CosEC_ServantBase
+ /// Create a local rtec.
virtual POA_RtecEventChannelAdmin::EventChannel_ptr
create_rtec (void);
- // Create a local rtec.
+ /// Activates the rtec.
virtual void activate_rtec (void);
- // Activates the rtec.
+ /// Deactivates the rtec.
virtual void deactivate_rtec (void);
- // Deactivates the rtec.
+ /// initialize the ORB.
void init_ORB (int& argc, ACE_TCHAR *argv []);
- // initialize the ORB.
+ /// Resolve the naming service.
void resolve_naming_service (void);
- // Resolve the naming service.
+ /// Locate a rtec.
void locate_rtec (void);
- // Locate a rtec.
// = Data members
+ /// The name we use to register with the Naming Service.
const ACE_TCHAR *service_name;
- // The name we use to register with the Naming Service.
+ /// The name of the Real Time Event Service.
const ACE_TCHAR *rt_service_name;
- // The name of the Real Time Event Service.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Reference to the root poa.
PortableServer::POA_var poa_;
- // Reference to the root poa.
+ /// A naming context.
CosNaming::NamingContext_var naming_;
- // A naming context.
+ /// Flag to indicate if the RtEC is local/remote,
+ /// 0 => local, 1 => remote, default is local.
CORBA::Boolean remote_rtec_;
- // Flag to indicate if the RtEC is local/remote,
- // 0 => local, 1 => remote, default is local.
};
#if defined (_MSC_VER)
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h
index 83689e0dbb0..3181285b7ec 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ConsumerAdmin_i.h
@@ -1,22 +1,20 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// ConsumerAdmin_i
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This has the implementation of the
-// CosEventChannelAdmin::ConsumerAdmin interface.
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ConsumerAdmin_i
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This has the implementation of the
+ * CosEventChannelAdmin::ConsumerAdmin interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef CONSUMERADMIN_I_H
#define CONSUMERADMIN_I_H
@@ -37,30 +35,30 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_ConsumerAdmin_i :
// RtecEventChannelAdmin::ConsumerAdmin.
public:
// = Initialization and termination methods.
+ /// Constructor.
TAO_CosEC_ConsumerAdmin_i (void);
- // Constructor.
+ /// Destructor.
~TAO_CosEC_ConsumerAdmin_i (void);
- // Destructor.
int init (const RtecEventChannelAdmin::ConsumerQOS &consumerqos,
RtecEventChannelAdmin::ConsumerAdmin_ptr rtec_consumeradmin);
+ /// Returns a new ProxyPushSupplier_ptr.
virtual CosEventChannelAdmin::ProxyPushSupplier_ptr
obtain_push_supplier(void);
- // Returns a new ProxyPushSupplier_ptr.
+ /// Returns a new ProxyPullSupplier_ptr.
virtual CosEventChannelAdmin::ProxyPullSupplier_ptr
obtain_pull_supplier(void);
- // Returns a new ProxyPullSupplier_ptr.
private:
+ /// The ConsumerQOS specified by the user of this class.
RtecEventChannelAdmin::ConsumerQOS qos_;
- // The ConsumerQOS specified by the user of this class.
+ /// The RtecEventChannelAdmin::ConsumerAdmin specified by the user of
+ /// this class.
RtecEventChannelAdmin::ConsumerAdmin_var rtec_consumeradmin_;
- // The RtecEventChannelAdmin::ConsumerAdmin specified by the user of
- // this class.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h
index b9dbf4271ea..7fb9cc1d7ce 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/CosEvent_Utilities.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/orbsvcs
-//
-// = FILENAME
-// CosEvent_Utilities.h
-//
-// = DESCRIPTION
-// A few utility classes to make it easier to write EC applications.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CosEvent_Utilities.h
+ *
+ * $Id$
+ *
+ * A few utility classes to make it easier to write EC applications.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_COSEVENT_UTILITIES_H
#define TAO_COSEVENT_UTILITIES_H
@@ -40,113 +37,117 @@ class TAO_RTEC_COSEC_Export CosEC_ServantBase :
// Clients can derive from this class and create servants.
public:
// = Initialization method.
+ /// Constructor.
CosEC_ServantBase (void);
- // Constructor.
+ /// Destructor.
virtual ~CosEC_ServantBase (void);
- // Destructor.
+ /**
+ * This method creates a local scheduler, rtec and cosec.
+ * The POA <poa> specified here is used when <activate> is called to
+ * activate the contained servants.
+ * The POA <thispoa> is used to activate this.
+ */
virtual void init (PortableServer::POA_ptr thispoa,
PortableServer::POA_ptr poa,
ACE_TCHAR *eventTypeIds,
ACE_TCHAR *eventSourceIds,
ACE_TCHAR *source_type_pairs);
- // This method creates a local scheduler, rtec and cosec.
- // The POA <poa> specified here is used when <activate> is called to
- // activate the contained servants.
- // The POA <thispoa> is used to activate this.
+ /// Activates the CosEC with <thispoa_> and friends with the <poa_>
int activate (void);
- // Activates the CosEC with <thispoa_> and friends with the <poa_>
+ /// If the servant_id is not nil then it is used to supply the object id
+ /// for <this> servant.
int activate (const char* servant_id);
- // If the servant_id is not nil then it is used to supply the object id
- // for <this> servant.
+ /// Deactivates the CosEC and friends with the POA.
void deactivate (void);
- // Deactivates the CosEC and friends with the POA.
// = POA_CosEventChannelAdmin::EventChannel methods.
virtual CosEventChannelAdmin::ConsumerAdmin_ptr for_consumers (void);
virtual CosEventChannelAdmin::SupplierAdmin_ptr for_suppliers (void);
+ /// Destroys this Event Channel object.
virtual void destroy (void);
- // Destroys this Event Channel object.
protected:
// = RtEC creation, activation and deactivation methods.
+ /// Create a local rtec.
virtual POA_RtecEventChannelAdmin::EventChannel_ptr
create_rtec (void);
- // Create a local rtec.
+ /// Activates the rtec.
virtual void activate_rtec (void);
- // Activates the rtec.
+ /// Deactivates the rtec.
virtual void deactivate_rtec (void);
- // Deactivates the rtec.
// = CosEC creation, activation and deactivation methods.
+ /// Create a local cosec.
TAO_CosEC_EventChannel_i*
create_cosec (void);
- // Create a local cosec.
+ /// Activates the cosec.
int activate_cosec (void);
- // Activates the cosec.
+ /// Deactivates the cosec.
void deactivate_cosec (void);
- // Deactivates the cosec.
+ /// Initialize the SupplierQOS Factory.
void init_SupplierQOS (RtecBase::handle_t supp_handle,
ACE_SupplierQOS_Factory &supplier_qos,
ACE_TCHAR *source_type_pairs);
- // Initialize the SupplierQOS Factory.
+ /// Initialize the ConsumerQOS Factory.
void init_ConsumerQOS (RtecBase::handle_t cons_handle,
ACE_ConsumerQOS_Factory &consumer_qos,
ACE_TCHAR *eventTypeIds,
ACE_TCHAR *eventSourceIds);
- // Initialize the ConsumerQOS Factory.
// = Protected Data members.
+ /// The poa that we use to activate ourselves.
PortableServer::POA_var thispoa_;
- // The poa that we use to activate ourselves.
+ /// The poa that we use to activate others
PortableServer::POA_var poa_;
- // The poa that we use to activate others
+ /// The Event Channel servant.
POA_RtecEventChannelAdmin::EventChannel_ptr rtec_servant_;
- // The Event Channel servant.
+ /// The servant object of the COS Event Channel.
TAO_CosEC_EventChannel_i *cosec_servant_;
- // The servant object of the COS Event Channel.
+ /// Ref to the Rtec.
RtecEventChannelAdmin::EventChannel_var rtec_;
- // Ref to the Rtec.
+ /// Ref to the cosec.
CosEventChannelAdmin::EventChannel_var cosec_;
- // Ref to the cosec.
+ /// The Consumer QOS.
ACE_ConsumerQOS_Factory consumer_qos_;
- // The Consumer QOS.
+ /// The Supplier QOS.
ACE_SupplierQOS_Factory supplier_qos_;
- // The Supplier QOS.
+ /// The list of EventTypeIDs (for ConsumerQOS) seperated by spaces.
+ /// e.g. "1 2 3 4"
ACE_TCHAR *eventTypeIds_;
- // The list of EventTypeIDs (for ConsumerQOS) seperated by spaces.
- // e.g. "1 2 3 4"
+ /// The list of EventSourceIDs (for ConsumerQOS) seperated by spaces.
+ /// e.g. "1 2 3 4"
ACE_TCHAR *eventSourceIds_;
- // The list of EventSourceIDs (for ConsumerQOS) seperated by spaces.
- // e.g. "1 2 3 4"
+ /**
+ * The pairs of Source and EventType Ids (for the SupplierQOS).
+ * e.g "1 4 2 5 3 6" where (1,4) (2,5) and (3,6) from source id,
+ * event id pairs.
+ */
ACE_TCHAR *source_type_pairs_;
- // The pairs of Source and EventType Ids (for the SupplierQOS).
- // e.g "1 4 2 5 3 6" where (1,4) (2,5) and (3,6) from source id,
- // event id pairs.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h
index cc30861b4f8..84eab7dbcda 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h
@@ -1,22 +1,20 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// EventChannel_i
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This has the implementation of the
-// CosEventChannelAdmin::EventChannel interface.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file EventChannel_i
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This has the implementation of the
+ * CosEventChannelAdmin::EventChannel interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef EVENTCHANNEL_I_H
#define EVENTCHANNEL_I_H
@@ -42,46 +40,46 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_EventChannel_i :
//
public:
// = Initialization and termination methods.
+ /// Constructor.
TAO_CosEC_EventChannel_i (void);
- // Constructor.
+ /// Destructor.
~TAO_CosEC_EventChannel_i (void);
- // Destructor.
+ /// Activates the ConsumerAdmin and SupplierAdmin servants. Returns
+ /// -1 on error, 0 on success.
int init (const RtecEventChannelAdmin::ConsumerQOS &consumerqos,
const RtecEventChannelAdmin::SupplierQOS &supplierqos,
RtecEventChannelAdmin::EventChannel_ptr rtec);
- // Activates the ConsumerAdmin and SupplierAdmin servants. Returns
- // -1 on error, 0 on success.
+ /// The for_consumers method will return the same ConsumerAdmin_ptr
+ /// everytime its called.
virtual CosEventChannelAdmin::ConsumerAdmin_ptr for_consumers (void);
- // The for_consumers method will return the same ConsumerAdmin_ptr
- // everytime its called.
+ /// The for_suppliers method will return the same SupplierAdmin_ptr
+ /// everytime its called.
virtual CosEventChannelAdmin::SupplierAdmin_ptr for_suppliers (void);
- // The for_suppliers method will return the same SupplierAdmin_ptr
- // everytime its called.
+ /// Destroys this Event Channel object.
virtual void destroy (void);
- // Destroys this Event Channel object.
+ /// destroys this Event Channel object and <delete>s this object.
void shutdown (void);
- // destroys this Event Channel object and <delete>s this object.
private:
+ /// ConsumerAdmin servant object.
TAO_CosEC_ConsumerAdmin_i* consumer_admin_;
- // ConsumerAdmin servant object.
+ /// SupplierAdmin servant object.
TAO_CosEC_SupplierAdmin_i* supplier_admin_;
- // SupplierAdmin servant object.
+ /// The reference to the ConsumerAdmin interface returned after
+ /// activating the servant in the ORB.
CosEventChannelAdmin::ConsumerAdmin_var consumeradmin_;
- // The reference to the ConsumerAdmin interface returned after
- // activating the servant in the ORB.
+ /// The reference to the SupplierAdmin interface returned after
+ /// activating the servant in the ORB.
CosEventChannelAdmin::SupplierAdmin_var supplieradmin_;
- // The reference to the SupplierAdmin interface returned after
- // activating the servant in the ORB.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h
index b4c6bf6bc59..5fcede3ebef 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushConsumer_i.h
@@ -1,22 +1,20 @@
/* -*- C++ -*- */
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// ProxyPushConsumer_i
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This has the implementation of the
-// CosEventChannelAdmin::ProxyPushConsumer interface.
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file ProxyPushConsumer_i
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This has the implementation of the
+ * CosEventChannelAdmin::ProxyPushConsumer interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef _PROXYPUSHCONSUMER_I_H
#define _PROXYPUSHCONSUMER_I_H
@@ -46,35 +44,35 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_ProxyPushConsumer_i :
//
public:
// = Initialization and termination methods.
+ /// Constructor.
TAO_CosEC_ProxyPushConsumer_i (const RtecEventChannelAdmin::SupplierQOS &qos,
RtecEventChannelAdmin::ProxyPushConsumer_ptr proxypushconsumer);
- // Constructor.
+ /// Destructor.
~TAO_CosEC_ProxyPushConsumer_i (void);
- // Destructor.
+ /// Suppliers call this method to pass data to connected consumers.
virtual void push (const CORBA::Any &data);
- // Suppliers call this method to pass data to connected consumers.
+ /// Disconnects the supplier from the event communication.
virtual void disconnect_push_consumer (void);
- // Disconnects the supplier from the event communication.
+ /// Connects a push supplier.
virtual void connect_push_supplier(CosEventComm::PushSupplier_ptr push_supplier);
- // Connects a push supplier.
private:
+ /// Returns 0 if a push_supplier is already connected to this
+ /// ProxyPushConsumer, otherwise it returns a 1.
int connected (void);
- // Returns 0 if a push_supplier is already connected to this
- // ProxyPushConsumer, otherwise it returns a 1.
+ /// The SupplierQOS specified by the user of this class.
const RtecEventChannelAdmin::SupplierQOS &qos_;
- // The SupplierQOS specified by the user of this class.
+ /// The Rtec ProxyPushConsumer specified by the user of this class.
RtecEventChannelAdmin::ProxyPushConsumer_var proxypushconsumer_;
- // The Rtec ProxyPushConsumer specified by the user of this class.
+ /// The Rtec PushSupplier wrapper used by the Rtec ProxyPushConsumer.
TAO_CosEC_PushSupplierWrapper *wrapper_;
- // The Rtec PushSupplier wrapper used by the Rtec ProxyPushConsumer.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h
index 875feca65d5..a111f0f106d 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/ProxyPushSupplier_i.h
@@ -1,22 +1,20 @@
/* -*- C++ -*- */
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// ProxyPushSupplier_i
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This has the implementation of the
-// CosEventChannelAdmin::ProxyPushSupplier interface.
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file ProxyPushSupplier_i
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This has the implementation of the
+ * CosEventChannelAdmin::ProxyPushSupplier interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef _PROXYPUSHSUPPLIER_H
#define _PROXYPUSHSUPPLIER_H
@@ -39,32 +37,32 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_ProxyPushSupplier_i :
// RtecEventChannelAdmin::ProxyPushSupplier.
public:
// = Initialization and termination methods.
+ /// Constructor.
TAO_CosEC_ProxyPushSupplier_i (const RtecEventChannelAdmin::ConsumerQOS &qos,
RtecEventChannelAdmin::ProxyPushSupplier_ptr pps);
- // Constructor.
+ /// Destructor.
~TAO_CosEC_ProxyPushSupplier_i (void);
- // Destructor.
+ /// Ends the event communication and disposes this object.
virtual void disconnect_push_supplier (void);
- // Ends the event communication and disposes this object.
+ /// Connects the <push_consumer> to the Event Channel.
virtual void connect_push_consumer(CosEventComm::PushConsumer_ptr push_consumer);
- // Connects the <push_consumer> to the Event Channel.
private:
+ /// Returns 0 if a push_consumer is already connected to this
+ /// ProxyPushSupplier, otherwise it returns a 1.
int connected (void);
- // Returns 0 if a push_consumer is already connected to this
- // ProxyPushSupplier, otherwise it returns a 1.
+ /// The ConsumerQOS specified by the user of this class.
const RtecEventChannelAdmin::ConsumerQOS &qos_;
- // The ConsumerQOS specified by the user of this class.
+ /// The Rtec ProxyPushSupplier specified by the user of this class.
RtecEventChannelAdmin::ProxyPushSupplier_var pps_;
- // The Rtec ProxyPushSupplier specified by the user of this class.
+ /// The Rtec PushConsumer wrapper used by the Rtec ProxyPushSupplier.
TAO_CosEC_PushConsumerWrapper *wrapper_;
- // The Rtec PushConsumer wrapper used by the Rtec ProxyPushSupplier.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h
index bab4970dbbc..234a5590210 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/lib/SupplierAdmin_i.h
@@ -1,22 +1,20 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO services
-//
-// = FILENAME
-// SupplierAdmin_i.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This has the implementation of the
-// CosEventChannelAdmin::SupplierAdmin interface.
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file SupplierAdmin_i.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This has the implementation of the
+ * CosEventChannelAdmin::SupplierAdmin interface.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef SUPPLIER_ADMIN_I_H
#define SUPPLIER_ADMIN_I_H
@@ -37,32 +35,32 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_SupplierAdmin_i :
// TAO's RtecEventChannelAdmin::SupplierAdmin.
public:
// = Initialization and termination methods.
+ /// Constructor.
TAO_CosEC_SupplierAdmin_i (void);
- // Constructor.
+ /// Destructor.
~TAO_CosEC_SupplierAdmin_i (void);
- // Destructor.
+ /// Initializes the SupplierAdmin. Returns 0 on success, -1 on
+ /// error.
int init (const RtecEventChannelAdmin::SupplierQOS &supplierqos,
RtecEventChannelAdmin::SupplierAdmin_ptr rtec_supplieradmin);
- // Initializes the SupplierAdmin. Returns 0 on success, -1 on
- // error.
+ /// Returns a new ProxyPushConsumer_ptr.
virtual CosEventChannelAdmin::ProxyPushConsumer_ptr
obtain_push_consumer (void);
- // Returns a new ProxyPushConsumer_ptr.
+ /// Returns a new ProxyPullConsumer_ptr.
virtual CosEventChannelAdmin::ProxyPullConsumer_ptr
obtain_pull_consumer(void);
- // Returns a new ProxyPullConsumer_ptr.
private:
+ /// The SupplierQOS specified by the user of this class.
RtecEventChannelAdmin::SupplierQOS qos_;
- // The SupplierQOS specified by the user of this class.
+ /// The RtecEventChannelAdmin::SupplierAdmin specified by the user of
+ /// this class.
RtecEventChannelAdmin::SupplierAdmin_var rtec_supplieradmin_;
- // The RtecEventChannelAdmin::SupplierAdmin specified by the user of
- // this class.
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h
index 37f7657a5ac..15ca31490ab 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Basic.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Basic.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This is a simple test class for the standard Cos Event Channel.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Basic.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This is a simple test class for the standard Cos Event Channel.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECBASIC_H
#define COSECBASIC_H
@@ -20,56 +21,58 @@
#include "Consumer.h"
#include "Supplier.h"
+/**
+ * @class Basic
+ *
+ * @brief class Basic
+ *
+ * Creates a CORBA Standard Event Channel (COSEC) implemented with
+ * TAO's Real-time Event Channel (RtEC) and sends an event across.
+ */
class Basic
{
- // = TITLE
- // class Basic
- //
- // = DESCRIPTION
- // Creates a CORBA Standard Event Channel (COSEC) implemented with
- // TAO's Real-time Event Channel (RtEC) and sends an event across.
public:
// = Initialization and termination methods.
+ /// Constructor.
Basic (void);
- // Constructor.
+ /// Destructor.
~Basic (void);
- // Destructor.
+ /// Starts up an ORB and the CosEC.
+ /// Returns 0 on success, -1 on error.
void init (int argc, ACE_TCHAR *argv[]);
- // Starts up an ORB and the CosEC.
- // Returns 0 on success, -1 on error.
+ /// Connects a consumer and a supplier to the CosEC and sends 1 event
+ /// across.
void run (void);
- // Connects a consumer and a supplier to the CosEC and sends 1 event
- // across.
+ /// Closes down the CosEC.
void shutdown (void);
- // Closes down the CosEC.
private:
+ /// initializes the ORB.
+ /// Returns 0 on success, -1 on error.
void init_ORB (int argc, ACE_TCHAR *argv[]);
- // initializes the ORB.
- // Returns 0 on success, -1 on error.
+ /// initializes the COS EC.
+ /// Returns 0 on success, -1 on error.
void init_CosEC (void);
- // initializes the COS EC.
- // Returns 0 on success, -1 on error.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// The root poa.
PortableServer::POA_var root_poa_;
- // The root poa.
+ /// Reference to the CosEC returned after activating it in the ORB.
CosEventChannelAdmin::EventChannel_var cos_ec_;
- // Reference to the CosEC returned after activating it in the ORB.
+ /// The Cos Consumer that will receive the event.
Consumer consumer_;
- // The Cos Consumer that will receive the event.
+ /// The Cos Supplier that will supply the event.
Supplier supplier_;
- // The Cos Supplier that will supply the event.
};
#endif /* COSECBASIC_H */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h
index 7466073ed0f..4343aaef780 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// Consumer.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// Defines a simple Push Consumer.
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * Defines a simple Push Consumer.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECCONSUMER_H_
#define COSECCONSUMER_H_
@@ -22,45 +23,47 @@
#include "orbsvcs/CosEventCommS.h"
#include "orbsvcs/CosEventChannelAdminS.h"
+/**
+ * @class Consumer
+ *
+ * @brief Consumer
+ *
+ * The Consumer is a simple PushConsumer that connects to the
+ * CosEC and receives events from it.
+ */
class Consumer : public POA_CosEventComm::PushConsumer
{
- // = TITLE
- // Consumer
- //
- // = DESCRIPTION
- // The Consumer is a simple PushConsumer that connects to the
- // CosEC and receives events from it.
public:
+ /// This method connects the consumer to the EC.
void open (CosEventChannelAdmin::EventChannel_ptr event_channel,
CORBA::ORB_ptr orb);
- // This method connects the consumer to the EC.
+ /// Disconnect from the EC.
void close (void);
- // Disconnect from the EC.
+ /// Connect the Consumer to the EventChannel.
void connect (void);
- // Connect the Consumer to the EventChannel.
+ /// Disconnect from the supplier, but do not forget about it or close
+ /// it.
void disconnect (void);
- // Disconnect from the supplier, but do not forget about it or close
- // it.
+ /// push the event to the consumer.
virtual void push (const CORBA::Any &data);
- // push the event to the consumer.
+ /// disconnect the consumer from the EC.
virtual void disconnect_push_consumer (void);
- // disconnect the consumer from the EC.
private:
+ /// The orb that we as using.
CORBA::ORB_var orb_;
- // The orb that we as using.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
- // We talk to the EC using this proxy.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // We talk to the EC using this proxy.
};
#endif /* COSECCONSUMER_H_ */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h
index ac7f7e77f35..c315ed7f1a0 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Supplier.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Supplier.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// Defines a simple Push Supplier.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Supplier.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * Defines a simple Push Supplier.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECSUPPLIER_H_
#define COSECSUPPLIER_H_
@@ -22,38 +23,40 @@
#include "orbsvcs/CosEventCommS.h"
#include "orbsvcs/CosEventChannelAdminS.h"
+/**
+ * @class Supplier
+ *
+ * @brief Supplier
+ *
+ * The Supplier is a simple Push Supplier that connects to
+ * the CosEC and sends events to it.
+ */
class Supplier : public POA_CosEventComm::PushSupplier
{
- // = TITLE
- // Supplier
- //
- // = DESCRIPTION
- // The Supplier is a simple Push Supplier that connects to
- // the CosEC and sends events to it.
public:
+ /// This method connects the supplier to the EC.
void open (CosEventChannelAdmin::EventChannel_ptr event_channel);
- // This method connects the supplier to the EC.
+ /// Disconnect from the EC.
void close (void);
- // Disconnect from the EC.
void connect (void);
+ /// Disconnect from the EC, but do not forget about it or close it.
void disconnect (void);
- // Disconnect from the EC, but do not forget about it or close it.
+ /// Send one event.
void send_event (const CORBA::Any &data);
- // Send one event.
+ /// The POA_CosEventComm::PushSupplier method.
virtual void disconnect_push_supplier (void);
- // The POA_CosEventComm::PushSupplier method.
private:
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ProxyPushConsumer_var consumer_proxy_;
- // We talk to the EC using this proxy.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::SupplierAdmin_var supplier_admin_;
- // We talk to the EC using this proxy.
};
#endif /* COSECSUPPLIER_H_ */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
index 2f70d238fb2..741df7d2ea5 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Consumer.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// Defines a simple Push Consumer.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Consumer.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * Defines a simple Push Consumer.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECCONSUMER_H_
#define COSECCONSUMER_H_
@@ -23,55 +24,57 @@
#include "orbsvcs/CosEventChannelAdminS.h"
#include "Multiple.h"
+/**
+ * @class Consumer
+ *
+ * @brief Consumer
+ *
+ * The Consumer is a simple PushConsumer that connects to the
+ * CosEC and receives events from it.
+ */
class Consumer : public POA_CosEventComm::PushConsumer, public Multiple
{
- // = TITLE
- // Consumer
- //
- // = DESCRIPTION
- // The Consumer is a simple PushConsumer that connects to the
- // CosEC and receives events from it.
public:
// = Initializatiopn and termination methods.
+ /// Constructor.
Consumer ();
- // Constructor.
+ /// Initialize the Consumer.
int init_Consumer (void);
- // Initialize the Consumer.
+ /// This method connects the consumer to the EC.
void open (CosEventChannelAdmin::EventChannel_ptr event_channel);
- // This method connects the consumer to the EC.
+ /// Disconnect from the EC.
void close (void);
- // Disconnect from the EC.
+ /// Connect the Consumer to the EventChannel.
void connect (void);
- // Connect the Consumer to the EventChannel.
+ /// Disconnect from the supplier, but do not forget about it or close
+ /// it.
void disconnect (void);
- // Disconnect from the supplier, but do not forget about it or close
- // it.
+ /// push the event to the consumer.
virtual void push (const CORBA::Any &data);
- // push the event to the consumer.
+ /// disconnect the consumer from the EC.
virtual void disconnect_push_consumer (void);
- // disconnect the consumer from the EC.
// = CosEC_Multiple methods.
+ /// Parse the command line options.
virtual int parse_args (int argc, ACE_TCHAR *argv []);
- // Parse the command line options.
private:
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
- // We talk to the EC using this proxy.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // We talk to the EC using this proxy.
+ /// The number of Events to receive before switching off.
int event_count_;
- // The number of Events to receive before switching off.
};
#endif /* COSECCONSUMER_H_ */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h
index e56bb936ea6..8fa0526f545 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Multiple.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Multiple.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// This is a test class for the Cos Event Service.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Multiple.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * This is a test class for the Cos Event Service.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECMULTIPLE_H
#define COSECMULTIPLE_H
@@ -33,47 +34,47 @@ class Multiple
// via the Cos Event Service.
public:
// = Initialization and termination methods.
+ /// Constructor.
Multiple (void);
- // Constructor.
+ /// Destructor.
virtual ~Multiple (void);
- // Destructor.
+ /// Calls parse_args, Starts up an ORB, gets hold of the Event Service.
+ /// Returns 0 on success, -1 on error.
int init (int argc, ACE_TCHAR *argv[]);
- // Calls parse_args, Starts up an ORB, gets hold of the Event Service.
- // Returns 0 on success, -1 on error.
+ /// Calls the ORB's <run> method.
int runORB (void);
- // Calls the ORB's <run> method.
+ /// Closes down the ORB and exits.
void shutdown (void);
- // Closes down the ORB and exits.
protected:
+ /// Parse the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv []) = 0;
- // Parse the command line arguments.
+ /// Reference to a running Event Service.
CosEventChannelAdmin::EventChannel_ptr cos_ec_;
- // Reference to a running Event Service.
+ /// The name with which to locate the Event Service.
const ACE_TCHAR *service_name_;
- // The name with which to locate the Event Service.
private:
+ /// initializes the ORB.
+ /// Returns 0 on success, -1 on error.
int init_ORB (int argc, ACE_TCHAR *argv[]);
- // initializes the ORB.
- // Returns 0 on success, -1 on error.
+ /// initializes the COS EC.
+ /// Returns 0 on success, -1 on error.
int init_CosEC (void);
- // initializes the COS EC.
- // Returns 0 on success, -1 on error.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// 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.
};
#endif /* COSECMULTIPLE_H */
diff --git a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h
index e5daf50692e..b5c5a4dc199 100644
--- a/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h
+++ b/TAO/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Supplier.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Supplier.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// Defines a simple Push Supplier.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Supplier.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * Defines a simple Push Supplier.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECSUPPLIER_H_
#define COSECSUPPLIER_H_
@@ -34,41 +35,41 @@ class Supplier : public POA_CosEventComm::PushSupplier,
// the CosEC and sends events to it.
public:
// = Initializatiopn and termination methods.
+ /// Constructor.
Supplier ();
- // Constructor.
+ /// This method connects the supplier to the EC.
void open (CosEventChannelAdmin::EventChannel_ptr event_channel);
- // This method connects the supplier to the EC.
+ /// Disconnect from the EC.
void close (void);
- // Disconnect from the EC.
void connect (void);
+ /// Disconnect from the EC, but do not forget about it or close it.
void disconnect (void);
- // Disconnect from the EC, but do not forget about it or close it.
+ /// Send one event.
void send_event (const CORBA::Any &data);
- // Send one event.
+ /// The POA_CosEventComm::PushSupplier method.
virtual void disconnect_push_supplier (void);
- // The POA_CosEventComm::PushSupplier method.
+ /// Sends the events to the EC.
void run (void);
- // Sends the events to the EC.
// = Multiple methods.
+ /// Parses the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv []);
- // Parses the command line arguments.
private:
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ProxyPushConsumer_var consumer_proxy_;
- // We talk to the EC using this proxy.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::SupplierAdmin_var supplier_admin_;
- // We talk to the EC using this proxy.
+ /// The number of Events to send to the EC.
int event_count_;
- // The number of Events to send to the EC.
};
#endif /* COSECSUPPLIER_H_ */
diff --git a/TAO/orbsvcs/examples/CosEC/Simple/Consumer.h b/TAO/orbsvcs/examples/CosEC/Simple/Consumer.h
index cd03b0c7b32..f62ba39eccf 100644
--- a/TAO/orbsvcs/examples/CosEC/Simple/Consumer.h
+++ b/TAO/orbsvcs/examples/CosEC/Simple/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS COS Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -23,34 +19,35 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ */
class Consumer : public POA_CosEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- //
public:
+ /// Constructor
Consumer (void);
- // Constructor
+ /// Run the test
int run (int argc, ACE_TCHAR* argv[]);
- // Run the test
// = The CosEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const CORBA::Any &event);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
private:
+ /// Keep track of the number of events received.
CORBA::ULong event_count_;
- // Keep track of the number of events received.
+ /// The orb, just a pointer because the ORB does not outlive the
+ /// run() method...
CORBA::ORB_ptr orb_;
- // The orb, just a pointer because the ORB does not outlive the
- // run() method...
};
#endif /* CONSUMER_H */
diff --git a/TAO/orbsvcs/examples/CosEC/Simple/Supplier.h b/TAO/orbsvcs/examples/CosEC/Simple/Supplier.h
index 9f26df820ed..d2846a4cabf 100644
--- a/TAO/orbsvcs/examples/CosEC/Simple/Supplier.h
+++ b/TAO/orbsvcs/examples/CosEC/Simple/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS COS Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -23,25 +19,26 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ */
class Supplier : public POA_CosEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- //
public:
+ /// Constructor
Supplier (void);
- // Constructor
+ /// Run the test
int run (int argc, ACE_TCHAR* argv[]);
- // Run the test
// = The CosEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
private:
};
diff --git a/TAO/orbsvcs/examples/Notify/Filter/Filter.h b/TAO/orbsvcs/examples/Notify/Filter/Filter.h
index 8de305adf58..927827fc028 100644
--- a/TAO/orbsvcs/examples/Notify/Filter/Filter.h
+++ b/TAO/orbsvcs/examples/Notify/Filter/Filter.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Filter.h
-//
-// = DESCRIPTION
-// Class to demo structured event filtering.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Filter.h
+ *
+ * $Id$
+ *
+ * Class to demo structured event filtering.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_FILTER_CLIENT_H
#define NOTIFY_FILTER_CLIENT_H
@@ -24,104 +24,107 @@
class Filter_StructuredPushConsumer;
class Filter_StructuredPushSupplier;
+/**
+ * @class FilterClient
+ *
+ * @brief Filter Client
+ *
+ * Client example that shows how to do Structured Event filtering
+ * in the Notification Service.
+ */
class FilterClient
{
- // = TITLE
- // Filter Client
- // = DESCRIPTION
- // Client example that shows how to do Structured Event filtering
- // in the Notification Service.
public:
// = Initialization and Termination
+ /// Constructor
FilterClient (void);
- // Constructor
+ /// Destructor
~FilterClient ();
- // Destructor
+ /// Init the Client.
void init (int argc, ACE_TCHAR *argv []);
- // Init the Client.
+ /// Run the demo.
void run (void);
- // Run the demo.
+ /// Consumer calls done, We're done.
void done (void);
- // Consumer calls done, We're done.
protected:
+ /// Initializes the ORB.
void init_ORB (int argc, ACE_TCHAR *argv []);
- // Initializes the ORB.
+ /// Try to get hold of a running naming service.
void resolve_naming_service (void);
- // Try to get hold of a running naming service.
+ /// Try to resolve the Notify factory from the Naming service.
void resolve_Notify_factory (void);
- // Try to resolve the Notify factory from the Naming service.
+ /// Create an EC.
void create_EC (void);
- // Create an EC.
+ /// Create the Supplier Admin.
void create_supplieradmin(void);
- // Create the Supplier Admin.
+ /// Create the Consumer Admin.
void create_consumeradmin (void);
- // Create the Consumer Admin.
+ /// Create and initialize the consumers.
void create_consumers (void);
- // Create and initialize the consumers.
+ /// create and initialize the suppliers.
void create_suppliers (void);
- // create and initialize the suppliers.
+ /// send the events.
void send_events (void);
- // send the events.
// = Data Members
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Handle to the name service.
CosNaming::NamingContext_var naming_context_;
- // Handle to the name service.
+ /// Channel factory.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
- // Channel factory.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The group operator between admin-proxy's.
CosNotifyChannelAdmin::InterFilterGroupOperator ifgop_;
- // The group operator between admin-proxy's.
+ /// Initial qos specified to the factory when creating the EC.
CosNotification::QoSProperties initial_qos_;
- // Initial qos specified to the factory when creating the EC.
+ /// Initial admin props specified to the factory when creating the EC.
CosNotification::AdminProperties initial_admin_;
- // Initial admin props specified to the factory when creating the EC.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer #1
Filter_StructuredPushConsumer* consumer_1;
- // Consumer #1
+ /// Consumer #2
Filter_StructuredPushConsumer* consumer_2;
- // Consumer #2
+ /// Supplier #1
Filter_StructuredPushSupplier* supplier_1;
- // Supplier #1
+ /// Supplier #2
Filter_StructuredPushSupplier* supplier_2;
- // Supplier #2
+ /// Set this flag to exit the run loop.
CORBA::Boolean done_;
- // Set this flag to exit the run loop.
};
/*****************************************************************/
@@ -137,34 +140,34 @@ class Filter_StructuredPushConsumer
public:
// = Initialization and Termination code
+ /// Constructor.
Filter_StructuredPushConsumer (FilterClient* filter, const char *my_name);
- // Constructor.
+ /// Connect the Consumer to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect the Consumer to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
virtual void disconnect (void);
- // Disconnect from the supplier.
protected:
// = Data members
+ /// The callback for <done>
FilterClient* filter_;
- // The callback for <done>
+ /// The name of this consumer.
ACE_CString my_name_;
- // The name of this consumer.
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy_supplier_;
- // The proxy that we are connected to.
+ /// The proxy_supplier id.
CosNotifyChannelAdmin::ProxyID proxy_supplier_id_;
- // The proxy_supplier id.
// = Methods
+ /// Destructor
virtual ~Filter_StructuredPushConsumer (void);
- // Destructor
// = NotifyPublish method
virtual void offer_change (
@@ -194,33 +197,33 @@ class Filter_StructuredPushSupplier
//
public:
// = Initialization and Termination code
+ /// Constructor.
Filter_StructuredPushSupplier (const char* my_name);
- // Constructor.
+ /// Connect the Supplier to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect the Supplier to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
void disconnect (void);
- // Disconnect from the supplier.
+ /// Send one event.
virtual void send_event (const CosNotification::StructuredEvent& event);
- // Send one event.
protected:
// = Data members
+ /// The name of this consumer.
ACE_CString my_name_;
- // The name of this consumer.
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushConsumer_var proxy_consumer_;
- // The proxy that we are connected to.
+ /// This supplier's id.
CosNotifyChannelAdmin::ProxyID proxy_consumer_id_;
- // This supplier's id.
// = Protected Methods
+ /// Destructor
virtual ~Filter_StructuredPushSupplier ();
- // Destructor
// = NotifySubscribe
virtual void subscription_change (
diff --git a/TAO/orbsvcs/examples/Notify/Subscribe/Subscribe.h b/TAO/orbsvcs/examples/Notify/Subscribe/Subscribe.h
index 2b07367a90e..d7d53791135 100644
--- a/TAO/orbsvcs/examples/Notify/Subscribe/Subscribe.h
+++ b/TAO/orbsvcs/examples/Notify/Subscribe/Subscribe.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Subscribe.h
-//
-// = DESCRIPTION
-// Class to demo structured event subscription.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Subscribe.h
+ *
+ * $Id$
+ *
+ * Class to demo structured event subscription.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_SUBSCRIBE_CLIENT_H
#define NOTIFY_SUBSCRIBE_CLIENT_H
@@ -23,85 +23,88 @@
class Subscribe_StructuredPushConsumer;
class Subscribe_StructuredPushSupplier;
+/**
+ * @class Subscribe
+ *
+ * @brief Subscribe
+ *
+ * Shows how consumers subscribe for events.
+ */
class Subscribe
{
- // = TITLE
- // Subscribe
- // = DESCRIPTION
- // Shows how consumers subscribe for events.
public:
// = Initialization and Termination
Subscribe (void);
~Subscribe ();
+ /// Init the Client.
void init (int argc, ACE_TCHAR *argv []);
- // Init the Client.
+ /// Run the demo.
void run (void);
- // Run the demo.
+ /// Called when all events we are waiting for have occured.
void done (void);
- // Called when all events we are waiting for have occured.
protected:
+ /// Initializes the ORB.
void init_ORB (int argc, ACE_TCHAR *argv []);
- // Initializes the ORB.
+ /// Try to get hold of a running naming service.
void resolve_naming_service (void);
- // Try to get hold of a running naming service.
+ /// Try to resolve the Notify factory from the Naming service.
void resolve_Notify_factory (void);
- // Try to resolve the Notify factory from the Naming service.
+ /// Create an EC.
void create_EC (void);
- // Create an EC.
+ /// Create the Supplier Admin.
void create_supplieradmin(void);
- // Create the Supplier Admin.
+ /// Create the Consumer Admin.
void create_consumeradmin (void);
- // Create the Consumer Admin.
+ /// Create and initialize the consumers.
void create_consumers (void);
- // Create and initialize the consumers.
+ /// create and initialize the suppliers.
void create_suppliers (void);
- // create and initialize the suppliers.
+ /// send the events.
void send_events (void);
- // send the events.
// = Data Members
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Handle to the name service.
CosNaming::NamingContext_var naming_context_;
- // Handle to the name service.
+ /// Channel factory.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
- // Channel factory.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The group operator between admin-proxy's.
CosNotifyChannelAdmin::InterFilterGroupOperator ifgop_;
- // The group operator between admin-proxy's.
+ /// Initial qos specified to the factory when creating the EC.
CosNotification::QoSProperties initial_qos_;
- // Initial qos specified to the factory when creating the EC.
+ /// Initial admin props specified to the factory when creating the EC.
CosNotification::AdminProperties initial_admin_;
- // Initial admin props specified to the factory when creating the EC.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
Subscribe_StructuredPushConsumer* consumer_1_;
Subscribe_StructuredPushConsumer* consumer_2_;
@@ -109,8 +112,8 @@ class Subscribe
Subscribe_StructuredPushSupplier* supplier_1_;
Subscribe_StructuredPushSupplier* supplier_2_;
+ /// Set this flag to exit the run loop.
CORBA::Boolean done_;
- // Set this flag to exit the run loop.
};
/*****************************************************************/
@@ -126,35 +129,35 @@ class Subscribe_StructuredPushConsumer
public:
// = Initialization and Termination code
+ /// Constructor.
Subscribe_StructuredPushConsumer (Subscribe* subscribe);
- // Constructor.
+ /// Connect the Consumer to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect the Consumer to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
virtual void disconnect (void);
- // Disconnect from the supplier.
+ /// Accessor for the Proxy that we're connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_ptr get_proxy_supplier (void);
- // Accessor for the Proxy that we're connected to.
// public data member for evaluating the results of subscription.
CosNotification::EventTypeSeq expected_subscription_;
protected:
// = Data members
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy_supplier_;
- // The proxy that we are connected to.
+ /// The proxy_supplier id.
CosNotifyChannelAdmin::ProxyID proxy_supplier_id_;
- // The proxy_supplier id.
+ /// callback <done>
Subscribe* subscribe_;
- // callback <done>
// = Methods
+ /// Destructor
virtual ~Subscribe_StructuredPushConsumer (void);
- // Destructor
// = NotifyPublish method
virtual void offer_change (
@@ -184,30 +187,30 @@ class Subscribe_StructuredPushSupplier
//
public:
// = Initialization and Termination code
+ /// Constructor.
Subscribe_StructuredPushSupplier (void);
- // Constructor.
+ /// Connect the Supplier to the EventChannel.
+ /// Creates a new proxy consumer and connects to it.
void connect (CosNotifyChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect the Supplier to the EventChannel.
- // Creates a new proxy consumer and connects to it.
+ /// Disconnect from the supplier.
void disconnect (void);
- // Disconnect from the supplier.
+ /// Send one event.
virtual void send_event (const CosNotification::StructuredEvent& event);
- // Send one event.
protected:
// = Data members
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushConsumer_var proxy_consumer_;
- // The proxy that we are connected to.
+ /// This supplier's id.
CosNotifyChannelAdmin::ProxyID proxy_consumer_id_;
- // This supplier's id.
// = Protected Methods
+ /// Destructor
virtual ~Subscribe_StructuredPushSupplier ();
- // Destructor
// = NotifySubscribe
virtual void subscription_change (
diff --git a/TAO/orbsvcs/examples/RtEC/Kokyu/Consumer.h b/TAO/orbsvcs/examples/RtEC/Kokyu/Consumer.h
index 36c247802f6..80e560cdd09 100644
--- a/TAO/orbsvcs/examples/RtEC/Kokyu/Consumer.h
+++ b/TAO/orbsvcs/examples/RtEC/Kokyu/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -23,30 +19,30 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ * It simply register for two event typesone event type
+ * The class is just a helper to simplify common tasks in EC
+ * tests, such as subscribing for a range of events, disconnecting
+ * from the EC, informing the driver of shutdown messages, etc.
+ * There are several ways to connect and disconnect this class,
+ * and it is up to the driver program to use the right one.
+ */
class Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- // It simply register for two event typesone event type
- // The class is just a helper to simplify common tasks in EC
- // tests, such as subscribing for a range of events, disconnecting
- // from the EC, informing the driver of shutdown messages, etc.
- //
- // There are several ways to connect and disconnect this class,
- // and it is up to the driver program to use the right one.
- //
public:
+ /// Constructor
Consumer (void);
- // Constructor
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
};
#endif /* CONSUMER_H */
diff --git a/TAO/orbsvcs/examples/RtEC/Kokyu/Supplier.h b/TAO/orbsvcs/examples/RtEC/Kokyu/Supplier.h
index 8222337af57..e5c13d26437 100644
--- a/TAO/orbsvcs/examples/RtEC/Kokyu/Supplier.h
+++ b/TAO/orbsvcs/examples/RtEC/Kokyu/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -24,30 +20,30 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ * It simply register for two event typesone event type
+ * The class is just a helper to simplify common tasks in EC
+ * tests, such as subscribing for a range of events, disconnecting
+ * from the EC, informing the driver of shutdown messages, etc.
+ * There are several ways to connect and disconnect this class,
+ * and it is up to the driver program to use the right one.
+ */
class Supplier : public POA_RtecEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- // It simply register for two event typesone event type
- // The class is just a helper to simplify common tasks in EC
- // tests, such as subscribing for a range of events, disconnecting
- // from the EC, informing the driver of shutdown messages, etc.
- //
- // There are several ways to connect and disconnect this class,
- // and it is up to the driver program to use the right one.
- //
public:
+ /// Constructor
Supplier (RtecEventComm::EventSourceID id,
const RtecEventChannelAdmin::ProxyPushConsumer_ptr consumer_proxy);
- // Constructor
// = The RtecEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
void timeout_occured (void);
@@ -56,25 +52,26 @@ private:
const RtecEventChannelAdmin::ProxyPushConsumer_ptr consumer_proxy_;
};
+/**
+ * @class Timeout_Consumer
+ *
+ * @brief Timer consumer object
+ *
+ * This class is a consumer of timeout events from EC.
+ * It registers for timeout event with EC and calls
+ * the
+ */
class Timeout_Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Timer consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of timeout events from EC.
- // It registers for timeout event with EC and calls
- // the
- //
public:
+ /// Constructor
Timeout_Consumer (Supplier * supplier_impl);
- // Constructor
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
private:
Supplier *supplier_impl_;
diff --git a/TAO/orbsvcs/examples/RtEC/MCast/AddrServer.h b/TAO/orbsvcs/examples/RtEC/MCast/AddrServer.h
index ce633025591..708444c2931 100644
--- a/TAO/orbsvcs/examples/RtEC/MCast/AddrServer.h
+++ b/TAO/orbsvcs/examples/RtEC/MCast/AddrServer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef ADDRSERVER_H
#define ADDRSERVER_H
@@ -20,23 +16,24 @@
#include "orbsvcs/RtecUDPAdminS.h"
+/**
+ * @class AddrServer
+ *
+ * @brief A simple AddrServer
+ *
+ * The EC is able to use multiple multicast groups to transmit its
+ * data, the is given control over the mapping between the Event
+ * (type,source) pair and the (ipaddr,port) pair using a
+ * AddrServer.
+ * This class implements a very simple server that simply maps the
+ * <type> component to the <ipaddr> and uses a fixed <port>,
+ * provided at initialization time.
+ */
class AddrServer : public POA_RtecUDPAdmin::AddrServer
{
- // = TITLE
- // A simple AddrServer
- //
- // = DESCRIPTION
- // The EC is able to use multiple multicast groups to transmit its
- // data, the is given control over the mapping between the Event
- // (type,source) pair and the (ipaddr,port) pair using a
- // AddrServer.
- // This class implements a very simple server that simply maps the
- // <type> component to the <ipaddr> and uses a fixed <port>,
- // provided at initialization time.
- //
public:
+ /// Constructor
AddrServer (const RtecUDPAdmin::UDP_Addr& addr);
- // Constructor
// = The RtecUDPAdmin::AddrServer methods
virtual void get_addr (const RtecEventComm::EventHeader& header,
@@ -46,8 +43,8 @@ public:
RtecUDPAdmin::UDP_Address_out addr);
private:
+ /// The address
RtecUDPAdmin::UDP_Addr addr_;
- // The address
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/examples/RtEC/MCast/Consumer.h b/TAO/orbsvcs/examples/RtEC/MCast/Consumer.h
index 5c4f141719d..f6efda3b957 100644
--- a/TAO/orbsvcs/examples/RtEC/MCast/Consumer.h
+++ b/TAO/orbsvcs/examples/RtEC/MCast/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -24,37 +20,38 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ * It simply subscribes to one event type.
+ */
class Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- // It simply subscribes to one event type.
- //
public:
+ /// Constructor
Consumer (void);
- // Constructor
+ /// Connect to the Event Channel
void connect (RtecEventChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect to the Event Channel
+ /// Disconnect from the event channel
void disconnect (void);
- // Disconnect from the event channel
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
private:
+ /// Keep track of the number of events received.
CORBA::ULong event_count_;
- // Keep track of the number of events received.
+ /// The proxy
RtecEventChannelAdmin::ProxyPushSupplier_var proxy_;
- // The proxy
};
#endif /* CONSUMER_H */
diff --git a/TAO/orbsvcs/examples/RtEC/MCast/Supplier.h b/TAO/orbsvcs/examples/RtEC/MCast/Supplier.h
index 6ee7f3251cd..8d26d8cf9f7 100644
--- a/TAO/orbsvcs/examples/RtEC/MCast/Supplier.h
+++ b/TAO/orbsvcs/examples/RtEC/MCast/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -24,37 +20,38 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ * It simply publishes one event type, when the perform_push()
+ * method is invoked it pushes the event through the event service
+ */
class Supplier : public POA_RtecEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- // It simply publishes one event type, when the perform_push()
- // method is invoked it pushes the event through the event service
- //
public:
+ /// Constructor
Supplier (void);
- // Constructor
+ /// Connect to the event channel
void connect (RtecEventChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect to the event channel
+ /// Disconnect from the event channel
void disconnect (void);
- // Disconnect from the event channel
+ /// Push a single event
void perform_push (void);
- // Push a single event
// = The RtecEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
private:
+ /// The proxy
RtecEventChannelAdmin::ProxyPushConsumer_var proxy_;
- // The proxy
};
#endif /* SUPPLIER_H */
diff --git a/TAO/orbsvcs/examples/RtEC/Schedule/Consumer.h b/TAO/orbsvcs/examples/RtEC/Schedule/Consumer.h
index 36c247802f6..80e560cdd09 100644
--- a/TAO/orbsvcs/examples/RtEC/Schedule/Consumer.h
+++ b/TAO/orbsvcs/examples/RtEC/Schedule/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -23,30 +19,30 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ * It simply register for two event typesone event type
+ * The class is just a helper to simplify common tasks in EC
+ * tests, such as subscribing for a range of events, disconnecting
+ * from the EC, informing the driver of shutdown messages, etc.
+ * There are several ways to connect and disconnect this class,
+ * and it is up to the driver program to use the right one.
+ */
class Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- // It simply register for two event typesone event type
- // The class is just a helper to simplify common tasks in EC
- // tests, such as subscribing for a range of events, disconnecting
- // from the EC, informing the driver of shutdown messages, etc.
- //
- // There are several ways to connect and disconnect this class,
- // and it is up to the driver program to use the right one.
- //
public:
+ /// Constructor
Consumer (void);
- // Constructor
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
};
#endif /* CONSUMER_H */
diff --git a/TAO/orbsvcs/examples/RtEC/Schedule/Supplier.h b/TAO/orbsvcs/examples/RtEC/Schedule/Supplier.h
index 8824c4b9f86..0d016307129 100644
--- a/TAO/orbsvcs/examples/RtEC/Schedule/Supplier.h
+++ b/TAO/orbsvcs/examples/RtEC/Schedule/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -23,29 +19,29 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ * It simply register for two event typesone event type
+ * The class is just a helper to simplify common tasks in EC
+ * tests, such as subscribing for a range of events, disconnecting
+ * from the EC, informing the driver of shutdown messages, etc.
+ * There are several ways to connect and disconnect this class,
+ * and it is up to the driver program to use the right one.
+ */
class Supplier : public POA_RtecEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- // It simply register for two event typesone event type
- // The class is just a helper to simplify common tasks in EC
- // tests, such as subscribing for a range of events, disconnecting
- // from the EC, informing the driver of shutdown messages, etc.
- //
- // There are several ways to connect and disconnect this class,
- // and it is up to the driver program to use the right one.
- //
public:
+ /// Constructor
Supplier (void);
- // Constructor
// = The RtecEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
private:
};
diff --git a/TAO/orbsvcs/examples/RtEC/Simple/Consumer.h b/TAO/orbsvcs/examples/RtEC/Simple/Consumer.h
index 3bff4a75d1d..58ccd3f75bf 100644
--- a/TAO/orbsvcs/examples/RtEC/Simple/Consumer.h
+++ b/TAO/orbsvcs/examples/RtEC/Simple/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -23,35 +19,36 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ * It simply registers for one event type.
+ */
class Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- // It simply registers for one event type.
- //
public:
+ /// Constructor
Consumer (void);
- // Constructor
+ /// Run the test
int run (int argc, ACE_TCHAR* argv[]);
- // Run the test
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
private:
+ /// Keep track of the number of events received.
CORBA::ULong event_count_;
- // Keep track of the number of events received.
+ /// The orb, just a pointer because the ORB does not outlive the
+ /// run() method...
CORBA::ORB_ptr orb_;
- // The orb, just a pointer because the ORB does not outlive the
- // run() method...
};
#endif /* CONSUMER_H */
diff --git a/TAO/orbsvcs/examples/RtEC/Simple/Supplier.h b/TAO/orbsvcs/examples/RtEC/Simple/Supplier.h
index f66ac71fc29..fd2a505c289 100644
--- a/TAO/orbsvcs/examples/RtEC/Simple/Supplier.h
+++ b/TAO/orbsvcs/examples/RtEC/Simple/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -23,26 +19,27 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ * It simply publishes one event type.
+ */
class Supplier : public POA_RtecEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- // It simply publishes one event type.
- //
public:
+ /// Constructor
Supplier (void);
- // Constructor
+ /// Run the test
int run (int argc, ACE_TCHAR* argv[]);
- // Run the test
// = The RtecEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
private:
};
diff --git a/TAO/orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h b/TAO/orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h
index 94a2151481d..0786ab56120 100644
--- a/TAO/orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h
+++ b/TAO/orbsvcs/examples/Security/SecurityLevel1/SLevel1_Test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// orbsvcs/examples/Security/SecurityLevel1
-//
-// = FILENAME
-// SLevel1_Test_i.h
-//
-// = AUTHOR
-// Priyanka Gontla <gontla_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file SLevel1_Test_i.h
+ *
+ * $Id$
+ *
+ * @author Priyanka Gontla <gontla_p@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_SLEVEL1_TEST_I_H
#define TAO_SLEVEL1_TEST_I_H
diff --git a/TAO/orbsvcs/examples/Security/Send_File/test_i.h b/TAO/orbsvcs/examples/Security/Send_File/test_i.h
index 729b1d933f8..c9ff4b29ab3 100644
--- a/TAO/orbsvcs/examples/Security/Send_File/test_i.h
+++ b/TAO/orbsvcs/examples/Security/Send_File/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Send_File
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_SEND_FILE_TEST_I_H
#define TAO_SEND_FILE_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 send_line (const char *line);
diff --git a/TAO/orbsvcs/orbsvcs/Trader/Constraint_l.cpp b/TAO/orbsvcs/orbsvcs/Trader/Constraint_l.cpp
index 28a91e0e0e1..66a359bd1f1 100644
--- a/TAO/orbsvcs/orbsvcs/Trader/Constraint_l.cpp
+++ b/TAO/orbsvcs/orbsvcs/Trader/Constraint_l.cpp
@@ -2,7 +2,6 @@
/* A lexical scanner generated by flex */
/* Scanner skeleton version:
- * $Id$
*/
#define FLEX_SCANNER
@@ -418,19 +417,16 @@ char *yytext;
#define INITIAL 0
TAO_END_VERSIONED_NAMESPACE_DECL
-// $Id$
-// ========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// constraint.l
-//
-// = AUTHOR
-// Seth Widoff <sbw1@cs.wustl.edu>
-//
-// ========================================================================
+//=============================================================================
+/**
+ * @file constraint.l
+ *
+ * $Id$
+ *
+ * @author Seth Widoff <sbw1@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Trader/Constraint_Interpreter.h"
#include "orbsvcs/Trader/Constraint_Nodes.h"
diff --git a/TAO/orbsvcs/orbsvcs/Trader/Constraint_y.cpp b/TAO/orbsvcs/orbsvcs/Trader/Constraint_y.cpp
index 68364873652..2298c9e9b47 100644
--- a/TAO/orbsvcs/orbsvcs/Trader/Constraint_y.cpp
+++ b/TAO/orbsvcs/orbsvcs/Trader/Constraint_y.cpp
@@ -13,19 +13,15 @@ yyrcsid[] = "$FreeBSD: src/usr.bin/yacc/skeleton.c,v 1.28 2000/01/17 02:04:06 bd
#define YYRECOVERING() (yyerrflag!=0)
#define YYPREFIX "yy"
- /* $Id$*/
-/* ========================================================================*/
+//=============================================================================
+/**
/**/
/* = LIBRARY*/
/* orbsvcs*/
/* */
-/* = FILENAME*/
-/* constraint.y*/
-/**/
-/* = AUTHOR*/
-/* Seth Widoff <sbw1@cs.wustl.edu>*/
-/**/
-/* ========================================================================*/
+ */
+//=============================================================================
+
#include "ace/OS_NS_string.h"
#include "ace/OS_NS_stdlib.h"
diff --git a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
index c0e7641448b..a4b5d883089 100644
--- a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
+++ b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
@@ -1,22 +1,19 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage
-//
-// = FILENAME
-// Connection_Manager.h
-//
-// = DESCRIPTION
-// This is a helper class that allows the senders bind to multiple
-// receivers and receivers to bind to senders. It also lets the
-// senders and receivers disconnect streams.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Connection_Manager.h
+ *
+ * $Id$
+ *
+ * This is a helper class that allows the senders bind to multiple
+ * receivers and receivers to bind to senders. It also lets the
+ * senders and receivers disconnect streams.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -30,51 +27,53 @@ class Endpoint_Addresses
ACE_CString receiver_addr;
};
+/**
+ * @class Connection_Manager
+ *
+ * @brief Defines the Connection Manager.
+ *
+ * This is a helper class that allows the senders bind to
+ * multiple receivers and receivers to bind to senders. It also
+ * lets the senders and receivers disconnect streams.
+ */
class Connection_Manager
{
- // = TITLE
- // Defines the Connection Manager.
- //
- // = DESCRIPTION
- // This is a helper class that allows the senders bind to
- // multiple receivers and receivers to bind to senders. It also
- // lets the senders and receivers disconnect streams.
public:
+ /// Constructor
Connection_Manager (void);
- // Constructor
+ /// Destructor
~Connection_Manager (void);
- // Destructor
+ /// Initialize this class.
int init (CORBA::ORB_ptr orb);
- // Initialize this class.
+ /// Method that binds the sender to the Naming Service and retreives
+ /// the references of any registered receivers.
void bind_to_receivers (const ACE_CString &sender_name,
AVStreams::MMDevice_ptr sender);
- // Method that binds the sender to the Naming Service and retreives
- // the references of any registered receivers.
+ /// Connect to the receivers that we found.
void connect_to_receivers (AVStreams::MMDevice_ptr sender);
- // Connect to the receivers that we found.
+ /// Bind receiver to the sender.
void bind_to_sender (const ACE_CString &sender_name,
const ACE_CString &receiver_name,
AVStreams::MMDevice_ptr receiver);
- // Bind receiver to the sender.
+ /// Connect to the sender that we found.
void connect_to_sender (void);
- // Connect to the sender that we found.
+ /// Destroy all streams.
void destroy (void);
- // Destroy all streams.
+ /// Destroy streams associated with <flowname>.
void destroy (const ACE_CString &flowname);
- // Destroy streams associated with <flowname>.
+ /// Add new streamctrl.
void add_streamctrl (const ACE_CString &flowname,
TAO_StreamEndPoint *endpoint);
- // Add new streamctrl.
// Map of receivers.
typedef ACE_Hash_Map_Manager<ACE_CString,
@@ -117,8 +116,8 @@ protected:
void add_to_receivers (CosNaming::BindingList &binding_list);
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
// The maps.
Receivers receivers_;
diff --git a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h
index 0c87366090b..2f175688b15 100644
--- a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h
+++ b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/distributer.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage
-//
-// = FILENAME
-// distributer.h
-//
-// = DESCRIPTION
-// Process to receive data from the sender and send it to the
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file distributer.h
+ *
+ * $Id$
+ *
+ * Process to receive data from the sender and send it to the
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Distributer_Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Distributer_Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Distributer_Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,45 +45,50 @@ public:
int handle_destroy (void);
private:
+ /// Count of the frames passing through us.
int frame_count_;
- // Count of the frames passing through us.
};
+/**
+ * @class Distributer_Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Distributer_Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Distributer_Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Distributer_Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Distributer_Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -99,58 +103,60 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_B
AV_Null_MediaCtrl>
RECEIVER_ENDPOINT_STRATEGY;
+/**
+ * @class Distributer
+ *
+ * @brief Distributer Application.
+ *
+ * The distributer is the intermediate receiver that receives
+ * data from the sender and forwards to a receiver.
+ */
class Distributer
{
- // = TITLE
- // Distributer Application.
- //
- // = DESCRIPTION
- // The distributer is the intermediate receiver that receives
- // data from the sender and forwards to a receiver.
public:
+ /// Constructor
Distributer (void);
- // Constructor
+ /// Destructor.
~Distributer (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize data components.
+ /// Parse args.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parse args.
// Flag to know when we are done.
int done (void) const;
void done (int);
+ /// Accessor to connection manager.
Connection_Manager &connection_manager (void);
- // Accessor to connection manager.
protected:
+ /// Connection manager.
Connection_Manager connection_manager_;
- // Connection manager.
+ /// The sender endpoint strategy.
SENDER_ENDPOINT_STRATEGY sender_endpoint_strategy_;
- // The sender endpoint strategy.
+ /// The receiver endpoint strategy.
RECEIVER_ENDPOINT_STRATEGY receiver_endpoint_strategy_;
- // The receiver endpoint strategy.
+ /// The distributer receiver multimedia device
TAO_MMDevice* distributer_receiver_mmdevice_;
- // The distributer receiver multimedia device
+ /// The distributer receiver multimedia device
TAO_MMDevice* distributer_sender_mmdevice_;
- // The distributer receiver multimedia device
+ /// The name of the sender to connect to.
ACE_CString sender_name_;
- // The name of the sender to connect to.
+ /// Our name.
ACE_CString distributer_name_;
- // Our name.
+ /// Flag to know when we are done.
int done_;
- // Flag to know when we are done.
ACE_TString addr_file_;
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h
index c19fc47ea40..9b0d3bca61d 100644
--- a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/receiver.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,76 +45,80 @@ public:
int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize data components.
+ /// Parse args.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parse args.
+ /// Name of the output file.
ACE_TString output_file_name (void);
- // Name of the output file.
protected:
+ /// Connection manager.
Connection_Manager connection_manager_;
- // Connection manager.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// The receiver MMDevice.
AVStreams::MMDevice_var mmdevice_obj_;
- // The receiver MMDevice.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
+ /// The sender MMDevice
AVStreams::MMDevice_var sender_mmdevice_;
- // The sender MMDevice
+ /// File name of the file into which received data is written.
ACE_TString output_file_name_;
- // File name of the file into which received data is written.
ACE_TString addr_file_;
+ /// Sender name.
ACE_CString sender_name_;
- // Sender name.
+ /// Receiver name.
ACE_CString receiver_name_;
- // Receiver name.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h
index 979a4f00fd1..9e439b9736d 100644
--- a/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h
@@ -1,46 +1,46 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -49,58 +49,60 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR **argv);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Accessor to the connection manager.
Connection_Manager &connection_manager (void);
- // Accessor to the connection manager.
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR **argv);
- // Method to parse the command line arguments.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_TString filename_;
- // File from which data is read.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// File from which data is read.
ACE_TString addr_file_;
- // File from which data is read.
+ /// Rate at which the data will be sent.
double frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Name of this sender.
ACE_TString sender_name_;
- // Name of this sender.
// Connection manager.
Connection_Manager connection_manager_;
diff --git a/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h b/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h
index 93444f3f843..bf4b9a7f835 100644
--- a/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/receiver.h
@@ -1,22 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -24,17 +21,19 @@
#include "orbsvcs/AV/Policy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -47,93 +46,97 @@ public:
int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
+ /// Set the protocol object corresponding to the transport protocol chosen.
TAO_AV_Protocol_Object * protocol_object (void);
- // Set the protocol object corresponding to the transport protocol chosen.
FILE * input_file (void);
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
+ /// Rate at which the data will be sent.
int frame_rate_;
- // Rate at which the data will be sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h b/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h
index f520f67548e..b15329a5f1d 100644
--- a/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Bidirectional_Flows/sender.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Sender_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Sender_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,28 +45,31 @@ public:
// int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
};
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
Sender_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -76,74 +78,76 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
int eof (void);
void shutdown (void);
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the sender to the receiver.
int bind_to_receiver (void);
- // Method that binds the sender to the receiver.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
TAO_StreamCtrl *streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
ACE_CString protocol_;
- // Selected protocol - default is UDP
+ /// Rate at which the data will be sent.
int frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
int eof_;
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h b/TAO/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h
index 0e0547a14b4..d4ea1ef6e15 100644
--- a/TAO/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h
+++ b/TAO/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h
@@ -1,22 +1,19 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Component_Switching
-//
-// = FILENAME
-// Connection_Manager.h
-//
-// = DESCRIPTION
-// This is a helper class that allows the senders bind to multiple
-// receivers and receivers to bind to senders. It also lets the
-// senders and receivers disconnect streams.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Connection_Manager.h
+ *
+ * $Id$
+ *
+ * This is a helper class that allows the senders bind to multiple
+ * receivers and receivers to bind to senders. It also lets the
+ * senders and receivers disconnect streams.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONNECTION_MANAGER_H
#define CONNECTION_MANAGER_H
@@ -26,57 +23,59 @@
#include "orbsvcs/AV/Protocol_Factory.h"
#include "tao/PortableServer/PortableServer.h"
+/**
+ * @class Connection_Manager
+ *
+ * @brief Defines the Connection Manager.
+ *
+ * This is a helper class that allows the senders bind to
+ * multiple receivers and receivers to bind to senders. It also
+ * lets the senders and receivers disconnect streams.
+ */
class Connection_Manager
{
- // = TITLE
- // Defines the Connection Manager.
- //
- // = DESCRIPTION
- // This is a helper class that allows the senders bind to
- // multiple receivers and receivers to bind to senders. It also
- // lets the senders and receivers disconnect streams.
public:
+ /// Constructor
Connection_Manager (void);
- // Constructor
+ /// Destructor
~Connection_Manager (void);
- // Destructor
+ /// Initialize this class.
int init (CORBA::ORB_ptr orb);
- // Initialize this class.
+ /// Method that binds the sender to the Naming Service and retreives
+ /// the references of any registered receivers.
void bind_to_receivers (const ACE_CString &sender_name,
AVStreams::MMDevice_ptr sender);
- // Method that binds the sender to the Naming Service and retreives
- // the references of any registered receivers.
+ /// Connect to the receivers that we found.
void connect_to_receivers (void);
- // Connect to the receivers that we found.
+ /// Bind receiver to the sender.
void bind_to_sender (const ACE_CString &sender_name,
const ACE_CString &receiver_name,
AVStreams::MMDevice_ptr receiver);
- // Bind receiver to the sender.
+ /// Connect to the sender that we found.
void connect_to_sender (void);
- // Connect to the sender that we found.
+ /// Destroy streams associated with <flowname>.
void destroy (const ACE_CString &flowname);
- // Destroy streams associated with <flowname>.
+ /// Unbind the sender from the Naming Service
void unbind_sender (const ACE_CString &sender_name,
AVStreams::MMDevice_ptr sender_mmdevice) ;
- // Unbind the sender from the Naming Service
+ /// Unbind the Receiver from the Naming Service
void unbind_receiver (const ACE_CString &sender_name,
const ACE_CString &receiver_name,
AVStreams::MMDevice_ptr receiver_mmdevice);
- // Unbind the Receiver from the Naming Service
+ /// Add new streamctrl.
void add_streamctrl (const ACE_CString &flowname,
TAO_StreamEndPoint *endpoint);
- // Add new streamctrl.
// Map of receivers.
typedef ACE_Hash_Map_Manager<ACE_CString,
@@ -107,8 +106,8 @@ protected:
void add_to_receivers (CosNaming::BindingList &binding_list);
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
// The maps.
Receivers receivers_;
diff --git a/TAO/orbsvcs/tests/AVStreams/Component_Switching/distributer.h b/TAO/orbsvcs/tests/AVStreams/Component_Switching/distributer.h
index 92e253a219e..42b4a0e1719 100644
--- a/TAO/orbsvcs/tests/AVStreams/Component_Switching/distributer.h
+++ b/TAO/orbsvcs/tests/AVStreams/Component_Switching/distributer.h
@@ -1,55 +1,57 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Component_Switching
-//
-// = FILENAME
-// distributer.h
-//
-// = DESCRIPTION
-// Process to receive data from the sender and send it to the
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file distributer.h
+ *
+ * $Id$
+ *
+ * Process to receive data from the sender and send it to the
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Signal_Handler
+ TITLE
+ * This class Handles the SIGINT signal through the Reactor.
+ * Useful to gracefully release the process
+ */
class Signal_Handler : public ACE_Event_Handler
{
- // TITLE
- // This class Handles the SIGINT signal through the Reactor.
- // Useful to gracefully release the process
public:
Signal_Handler (void);
+ /// Override this method to implement graceful shutdown.
int handle_signal(int signum, siginfo_t*,ucontext_t*);
- // Override this method to implement graceful shutdown.
};
+/**
+ * @class Distributer_Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Distributer_Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ //// Constructor.
Distributer_Receiver_Callback (void);
- /// Constructor.
/// Method that is called when there is data to be received from a
/// sender.
@@ -66,28 +68,30 @@ public:
void flowname (const ACE_CString &flowname);
private:
+ //// Count of the frames passing through us.
int frame_count_;
- /// Count of the frames passing through us.
+ //// Flowname of the flow.
ACE_CString flowname_;
- /// Flowname of the flow.
};
+/**
+ * @class Distributer_Sender_Callback
+ *
+ * @brief Defines a class for the distributer application callback
+ * for receiving data.
+ *
+ * This class overides the methods of the TAO_AV_Callback so the
+ * AVStreams can make upcalls to the application.
+ */
class Distributer_Sender_Callback : public TAO_AV_Callback
{
- /// = TITLE
- // Defines a class for the distributer application callback
- // for receiving data.
- //
- // = DESCRIPTION
- // This class overides the methods of the TAO_AV_Callback so the
- // AVStreams can make upcalls to the application.
public:
+ //// Called when the sender has finished reading the file and wants
+ //// to close down the connection.
int handle_destroy (void);
- /// Called when the sender has finished reading the file and wants
- /// to close down the connection.
/// Accessor methods for the flowname of the callback.
ACE_CString &flowname (void);
@@ -99,49 +103,54 @@ private:
};
+/**
+ * @class Distributer_Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Distributer_Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
/// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
+ //// Store the reference to the protocol object corresponding
+ //// to the transport
int set_protocol_object (const char *,
TAO_AV_Protocol_Object *object);
- /// Store the reference to the protocol object corresponding
- /// to the transport
+ //// Called when a sender makes a connection request.
virtual CORBA::Boolean handle_connection_requested (AVStreams::flowSpec &the_spec);
- /// Called when a sender makes a connection request.
private:
+ //// Receiver application callback.
Distributer_Receiver_Callback callback_;
- /// Receiver application callback.
};
+/**
+ * @class Distributer_Sender_StreamEndPoint
+ *
+ * @brief / Defines a sender stream endpoint.
+ */
class Distributer_Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- /// = TITLE
- /// Defines a sender stream endpoint.
public:
+ //// Create the application callback and return its handle to
+ //// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- /// Create the application callback and return its handle to
- /// AVStreams for further application callbacks.
+ //// Set protocol object corresponding to the transport protocol
+ //// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- /// Set protocol object corresponding to the transport protocol
- /// chosen.
protected:
+ //// Application callback.
Distributer_Sender_Callback callback_;
- /// Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -156,74 +165,76 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_B
AV_Null_MediaCtrl>
RECEIVER_ENDPOINT_STRATEGY;
+/**
+ * @class Distributer
+ *
+ * @brief Distributer Application.
+ *
+ * The distributer is the intermediate receiver that receives
+ * data from the sender and forwards to a receiver.
+ */
class Distributer
{
- // = TITLE
- // Distributer Application.
- //
- // = DESCRIPTION
- // The distributer is the intermediate receiver that receives
- // data from the sender and forwards to a receiver.
public:
+ //// Constructor
Distributer (void);
- /// Constructor
+ //// Destructor.
~Distributer (void);
- /// Destructor.
+ //// Initialize data components.
int init (int argc,
ACE_TCHAR **argv);
- /// Initialize data components.
+ //// Parse args.
int parse_args (int argc,
ACE_TCHAR **argv);
- /// Parse args.
/// Flag to know when we are done.
bool done (void) const;
void done (bool);
+ //// Accessor to connection manager.
Connection_Manager &connection_manager (void);
- /// Accessor to connection manager.
+ //// Called when stream created
void stream_created (void);
- /// Called when stream created
+ //// Called when stream destroyed
void stream_destroyed (void);
- /// Called when stream destroyed
+ ////Unbind the sender and receiver from the Naming Service
void shut_down (void);
- ///Unbind the sender and receiver from the Naming Service
protected:
+ //// Connection manager.
Connection_Manager connection_manager_;
- /// Connection manager.
+ //// The sender endpoint strategy.
SENDER_ENDPOINT_STRATEGY sender_endpoint_strategy_;
- /// The sender endpoint strategy.
+ //// The receiver endpoint strategy.
RECEIVER_ENDPOINT_STRATEGY receiver_endpoint_strategy_;
- /// The receiver endpoint strategy.
+ //// The distributer receiver multimedia device
TAO_MMDevice* distributer_receiver_mmdevice_;
- /// The distributer receiver multimedia device
+ //// The distributer receiver multimedia device
TAO_MMDevice* distributer_sender_mmdevice_;
- /// The distributer receiver multimedia device
+ //// The name of the sender to connect to.
ACE_CString sender_name_;
- /// The name of the sender to connect to.
+ //// Our name.
ACE_CString distributer_name_;
- /// Our name.
+ //// Flag to know when we are done.
bool done_;
- /// Flag to know when we are done.
+ //// Number of active streams. When a stream is disconnected this
+ //// count is decremented.
int stream_count_;
- /// Number of active streams. When a stream is disconnected this
- /// count is decremented.
+ //// Reference to the signal handler.
Signal_Handler signal_handler_;
- /// Reference to the signal handler.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Component_Switching/receiver.h b/TAO/orbsvcs/tests/AVStreams/Component_Switching/receiver.h
index f7bc3b61361..c911c6d4fb3 100644
--- a/TAO/orbsvcs/tests/AVStreams/Component_Switching/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Component_Switching/receiver.h
@@ -1,54 +1,56 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Component_Switching
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Signal_Handler
+ TITLE
+ * This class Handles the SIGINT signal through the Reactor.
+ * Useful to gracefully release the process
+ */
class Signal_Handler : public ACE_Event_Handler
{
- // TITLE
- // This class Handles the SIGINT signal through the Reactor.
- // Useful to gracefully release the process
public:
Signal_Handler (void);
+ /// Override this method to implement graceful shutdown.
int handle_signal(int signum, siginfo_t*,ucontext_t*);
- // Override this method to implement graceful shutdown.
};
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ //// Constructor.
Receiver_Callback (void);
- /// Constructor.
/// Method that is called when there is data to be received from a
/// sender.
@@ -63,58 +65,62 @@ public:
void flowname (const ACE_CString &flowname);
private:
+ //// Keeping a count of the incoming frames.
int frame_count_;
- /// Keeping a count of the incoming frames.
+ //// Flowname of the flow.
ACE_CString flowname_;
- /// Flowname of the flow.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
/// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
+ //// Called when a distributor tries to connect to the receiver
virtual CORBA::Boolean handle_connection_requested (AVStreams::flowSpec &the_spec);
- /// Called when a distributor tries to connect to the receiver
private:
+ //// Receiver application callback.
Receiver_Callback callback_;
- /// Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ //// Constructor
Receiver (void);
- /// Constructor
+ //// Destructor.
virtual ~Receiver (void);
- /// Destructor.
+ //// Initialize data components.
int init (int argc,
ACE_TCHAR **argv);
- /// Initialize data components.
+ //// Parse args.
int parse_args (int argc,
ACE_TCHAR **argv);
- /// Parse args.
+ //// Name of the output file.
ACE_CString output_file_name (void);
- /// Name of the output file.
ACE_CString sender_name (void);
ACE_CString receiver_name (void);
@@ -122,31 +128,31 @@ public:
void shut_down (void);
protected:
+ //// Connection manager.
Connection_Manager connection_manager_;
- /// Connection manager.
+ //// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- /// The endpoint reactive strategy.
+ //// The receiver MMDevice.
AVStreams::MMDevice_var mmdevice_obj_;
- /// The receiver MMDevice.
+ //// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- /// Receiver MMDevice.
+ //// The sender MMDevice
AVStreams::MMDevice_var sender_mmdevice_;
- /// The sender MMDevice
+ //// File name of the file into which received data is written.
ACE_CString output_file_name_;
- /// File name of the file into which received data is written.
+ //// Sender name.
ACE_CString sender_name_;
- /// Sender name.
+ //// Receiver name.
ACE_CString receiver_name_;
- /// Receiver name.
+ //// Reference to the signal handler.
Signal_Handler signal_handler_;
- /// Reference to the signal handler.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Component_Switching/sender.h b/TAO/orbsvcs/tests/AVStreams/Component_Switching/sender.h
index f5a14c6e06e..56506a621fc 100644
--- a/TAO/orbsvcs/tests/AVStreams/Component_Switching/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Component_Switching/sender.h
@@ -1,91 +1,98 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Component_Switching
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Connection_Manager.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Signal_Handler
+ TITLE
+ * This class Handles the SIGINT signal through the Reactor.
+ * Useful to gracefully release the process
+ */
class Signal_Handler : public ACE_Event_Handler
{
- // TITLE
- // This class Handles the SIGINT signal through the Reactor.
- // Useful to gracefully release the process
public:
Signal_Handler (void);
+ /// Override this method to implement graceful shutdown.
int handle_signal(int signum, siginfo_t*,ucontext_t*);
- // Override this method to implement graceful shutdown.
};
+/**
+ * @class Sender_Callback
+ *
+ * @brief Defines a class for the sender application callback.
+ *
+ * This class overides the methods of the TAO_AV_Callback so the
+ * AVStreams can make upcalls to the application.
+ */
class Sender_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Defines a class for the sender application callback.
- //
- // = DESCRIPTION
- // This class overides the methods of the TAO_AV_Callback so the
- // AVStreams can make upcalls to the application.
public:
+ /**
+ */ Called when the sender has finished reading the file and wants
+ */ to close down the connection. Also called when the distributer
+ */ tears down the connection when it switches to a new sender.
+ */
int handle_destroy (void);
- /// Called when the sender has finished reading the file and wants
- /// to close down the connection. Also called when the distributer
- /// tears down the connection when it switches to a new sender.
+ //// Accessor methods for the flowname of the callback
ACE_CString &flowname (void);
void flowname (const ACE_CString &flowname);
- /// Accessor methods for the flowname of the callback
private:
+ //// Flowname of the callback.
ACE_CString flowname_;
- /// Flowname of the callback.
};
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ //// Create the application callback and return its handle to
+ //// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- /// Create the application callback and return its handle to
- /// AVStreams for further application callbacks.
+ //// Set protocol object corresponding to the transport protocol
+ //// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- /// Set protocol object corresponding to the transport protocol
- /// chosen.
+ //// Perform application specific actions before accepting new
+ //// connections.
CORBA::Boolean handle_preconnect (AVStreams::flowSpec &flowspec);
- /// Perform application specific actions before accepting new
- /// connections.
protected:
+ //// Application callback.
Sender_Callback callback_;
- /// Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -94,64 +101,66 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- /// = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ //// Constructor
Sender (void);
- /// Constructor
+ //// Destructor
~Sender (void);
- /// Destructor
void shut_down (void);
+ //// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- /// Method to initialize the various data components.
+ //// Method to pace and send data from a file.
int pace_data (void);
- /// Method to pace and send data from a file.
+ //// Accessor to the connection manager.
Connection_Manager &connection_manager (void);
- /// Accessor to the connection manager.
private:
+ //// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- /// Method to parse the command line arguments.
+ //// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- /// The endpoint strategy used by the sender.
+ //// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- /// The sender MMDevice.
+ //// Number of frames sent.
int frame_count_;
- /// Number of frames sent.
+ //// File from which data is read.
ACE_CString filename_;
- /// File from which data is read.
+ //// File handle of the file read from.
FILE *input_file_;
- /// File handle of the file read from.
+ //// Rate at which the data will be sent.
double frame_rate_;
- /// Rate at which the data will be sent.
+ //// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- /// Message block into which data is read from a file and then sent.
+ //// Name of this sender.
ACE_CString sender_name_;
- /// Name of this sender.
+ //// Connection manager.
Connection_Manager connection_manager_;
- /// Connection manager.
+ //// Reference to the signal handler.
Signal_Handler signal_handler_;
- /// Reference to the signal handler.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Latency/ping.h b/TAO/orbsvcs/tests/AVStreams/Latency/ping.h
index 88e6fc31b97..da4a6975074 100644
--- a/TAO/orbsvcs/tests/AVStreams/Latency/ping.h
+++ b/TAO/orbsvcs/tests/AVStreams/Latency/ping.h
@@ -1,17 +1,14 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Latency
-//
-// = FILENAME
-// ping.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ping.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_PING_H
#define TAO_PING_H
@@ -43,17 +40,17 @@ public:
TAO_AV_Callback *&callback);
private:
+ /// The callback object...
Ping_Recv_Callback callback_;
- // The callback object...
};
class Pong_Send_Callback : public TAO_AV_Callback
{
public:
+ /// Ad-hoc method to send a response outside the context of a
+ /// handle_timeout.
int send_response (ACE_hrtime_t stamp);
- // Ad-hoc method to send a response outside the context of a
- // handle_timeout.
virtual int handle_timeout (void *arg);
virtual int handle_end_stream (void);
diff --git a/TAO/orbsvcs/tests/AVStreams/Latency/pong.h b/TAO/orbsvcs/tests/AVStreams/Latency/pong.h
index 92d90adaad4..7c8fd596937 100644
--- a/TAO/orbsvcs/tests/AVStreams/Latency/pong.h
+++ b/TAO/orbsvcs/tests/AVStreams/Latency/pong.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Latency
-//
-// = FILENAME
-// ping.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ping.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_PONG_H
#define TAO_PONG_H
@@ -39,8 +36,8 @@ public:
TAO_AV_Callback *&callback);
private:
+ /// The callback object...
Pong_Recv_Callback callback_;
- // The callback object...
};
class Ping_Send_Callback : public TAO_AV_Callback
@@ -54,11 +51,11 @@ public:
void *&arg);
private:
+ /// the timeout value
ACE_Time_Value timeout_;
- // the timeout value
+ /// Pre-allocate the message block to send...
ACE_Message_Block frame_;
- // Pre-allocate the message block to send...
int count_;
};
@@ -71,8 +68,8 @@ public:
TAO_AV_Callback *&callback);
private:
+ /// The callback object...
Ping_Send_Callback callback_;
- // The callback object...
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A <TAO_StreamEndPoint_A,TAO_VDev,AV_Null_MediaCtrl> Reactive_Strategy;
diff --git a/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h b/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h
index 0de06e4e856..8499a0c0b01 100644
--- a/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/receiver.h
@@ -1,22 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -24,17 +21,19 @@
#include "orbsvcs/AV/Policy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -49,89 +48,93 @@ public:
void flowname (const char*);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
ACE_CString flowname_;
+ /// File handle of the file into which received data is written.
FILE *output_file_;
- // File handle of the file into which received data is written.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
+ /// Set the protocol object corresponding to the transport protocol chosen.
TAO_AV_Protocol_Object * protocol_object (void);
- // Set the protocol object corresponding to the transport protocol chosen.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
+ /// Rate at which the data will be sent.
int frame_rate_;
- // Rate at which the data will be sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/sender.h b/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/sender.h
index eaf1e328782..9b63e818546 100644
--- a/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Multiple_Flows/sender.h
@@ -1,22 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -26,24 +23,27 @@
typedef ACE_Unbounded_Set<TAO_AV_Protocol_Object*> ProtocolObject_Set;
typedef ACE_Unbounded_Set_Iterator<TAO_AV_Protocol_Object*> ProtocolObject_SetItor;
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -52,71 +52,73 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
void shutdown (void);
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the sender to the receiver.
int bind_to_receiver (void);
- // Method that binds the sender to the receiver.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
TAO_StreamCtrl *streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
ACE_CString protocol_;
- // Selected protocol - default is UDP
+ /// Rate at which the data will be sent.
int frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
ProtocolObject_Set protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Pluggable/ftp.h b/TAO/orbsvcs/tests/AVStreams/Pluggable/ftp.h
index 50ae2bb556c..b658ce53e2f 100644
--- a/TAO/orbsvcs/tests/AVStreams/Pluggable/ftp.h
+++ b/TAO/orbsvcs/tests/AVStreams/Pluggable/ftp.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Pluggable
-//
-// = FILENAME
-// ftp.h
-//
-// = DESCRIPTION
-// Ftp client to send data
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ftp.h
+ *
+ * $Id$
+ *
+ * Ftp client to send data
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_AV_FTP_H
@@ -29,140 +26,146 @@
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class FTP_Client_Callback
+ *
+ * @brief Defines the client applcation callback.
+ *
+ * This class can override the methods of
+ * the TAO_AV_Callback to do application
+ * specific processing.
+ */
class FTP_Client_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Defines the client applcation callback.
- //
- // = DESCRIPTION
- // This class can override the methods of
- // the TAO_AV_Callback to do application
- // specific processing.
public:
+ ///Constructor
FTP_Client_Callback (void);
- //Constructor
};
+/**
+ * @class FTP_Client_StreamEndPoint
+ *
+ * @brief Defines the client stream endpoint.
+ *
+ * This class overrides the methods of TAO_ClientStreamendpoint
+ * so the application can perform its processing during post and pre
+ * connection set up.
+ */
class FTP_Client_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines the client stream endpoint.
- //
- // = DESCRIPTION
- // This class overrides the methods of TAO_ClientStreamendpoint
- // so the application can perform its processing during post and pre
- // connection set up.
public:
+ ///Contructor
FTP_Client_StreamEndPoint (void);
- //Contructor
+ /// Create the application client callback and return its handle to the
+ /// AVSTreams for further application callbacks
virtual int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application client callback and return its handle to the
- // AVSTreams for further application callbacks
+ /// Set protocol object corresponding to the transport protocol chosen.
virtual int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol chosen.
protected:
+ /// reference to the cllient application callback.
FTP_Client_Callback callback_;
- // reference to the cllient application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A <FTP_Client_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> ENDPOINT_STRATEGY;
+/**
+ * @class Client
+ *
+ * @brief Defines the Client Application
+ *
+ * The actual client program that acts as the ftp client that streams data
+ * to the ftp servers that are waiting for data.
+ */
class Client
{
- // = TITLE
- // Defines the Client Application
- //
- // = DESCRIPTION
- // The actual client program that acts as the ftp client that streams data
- // to the ftp servers that are waiting for data.
public:
+ /// Constructor
Client (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void set_protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// File handle from which data is read to be sent.
FILE *file (void);
- // File handle from which data is read to be sent.
+ /// The stream control interface that manages the stream set up
TAO_StreamCtrl* streamctrl (void);
- // The stream control interface that manages the stream set up
+ /// name of the flow set up.
char *flowname (void);
- // name of the flow set up.
+ /// The requested frame rate for sending each frame of data read from the file.
int frame_rate (void);
- // The requested frame rate for sending each frame of data read from the file.
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the ftp client to the server
int bind_to_server (void);
- // Method that binds the ftp client to the server
+ /// The reacfive strategy of the client.
ENDPOINT_STRATEGY endpoint_strategy_;
- // The reacfive strategy of the client.
+ /// The server MMDevice that the ftpo client connects to
AVStreams::MMDevice_var server_mmdevice_;
- // The server MMDevice that the ftpo client connects to
+ /// The ftp client MMDevice.
TAO_MMDevice client_mmdevice_;
- // The ftp client MMDevice.
+ /// Video stream controller
TAO_StreamCtrl streamctrl_;
- // Video stream controller
+ /// Number of frames sent.
int count_;
- // Number of frames sent.
int argc_;
ACE_TCHAR **argv_;
+ /// File from which data is read.
const char *filename_;
- // File from which data is read.
+ /// Address of the ftp client host machine or a multicast address - Default is
+ /// UDP multicast addess
const char *address_;
- // Address of the ftp client host machine or a multicast address - Default is
- // UDP multicast addess
const char *peer_addr_str_;
+ /// The Naming Service client.
TAO_Naming_Client my_naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *fp_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
char *protocol_;
- // Selected protocol - default is UDP
char *flowname_;
+ /// If set to 1 then use sfp as the flow carrier protocol.
int use_sfp_;
- // If set to 1 then use sfp as the flow carrier protocol.
int frame_rate_;
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object* protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Pluggable/server.h b/TAO/orbsvcs/tests/AVStreams/Pluggable/server.h
index bdb3544c767..aa554f1543a 100644
--- a/TAO/orbsvcs/tests/AVStreams/Pluggable/server.h
+++ b/TAO/orbsvcs/tests/AVStreams/Pluggable/server.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Pluggable
-//
-// = FILENAME
-// ftp.h
-//
-// = DESCRIPTION
-// Ftp server to receive data
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file ftp.h
+ *
+ * $Id$
+ *
+ * Ftp server to receive data
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -22,14 +19,16 @@
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class FTP_Server_Callback
+ *
+ * @brief Defines a class for the server application callback.
+ *
+ * This class overides the methods of the TAO_AV_Callback so the
+ * AVStreams can make upcalls to the application.
+ */
class FTP_Server_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Defines a class for the server application callback.
- //
- // = DESCRIPTION
- // This class overides the methods of the TAO_AV_Callback so the
- // AVStreams can make upcalls to the application.
public:
@@ -43,51 +42,55 @@ public:
int handle_destroy (void);
};
+/**
+ * @class FTP_Server_StreamEndPoint
+ *
+ * @brief Defines the aplication stream endpoint
+ *
+ * This is the class that overrides the tao_server_enpodint to handle
+ * pre and post connect processing.
+ */
class FTP_Server_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Defines the aplication stream endpoint
- //
- // = DESCRIPTION
- // This is the class that overrides the tao_server_enpodint to handle
- // pre and post connect processing.
public:
// Create the server application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// reference to the server application callback.
FTP_Server_Callback callback_;
- // reference to the server application callback.
};
+/**
+ * @class Server
+ *
+ * @brief Defines the server application class.
+ * = DESCRIPOTION
+ * The actual server progarm that acts as the ftp server that receives data
+ * sent by the ftp client.
+ */
class Server
{
- // = TITLE
- // Defines the server application class.
- //
- // = DESCRIPOTION
- // The actual server progarm that acts as the ftp server that receives data
- // sent by the ftp client.
public:
+ /// Constructor
Server (void);
- // Constructor
+ /// Deestructor.
~Server (void);
- // Deestructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client my_naming_client_;
- // The Naming Service Client.
+ /// The endpoint reacxtive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<FTP_Server_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reacxtive strategy.
+ /// The server MMDevice.
TAO_MMDevice *mmdevice_;
- // The server MMDevice.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h b/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h
index 5e813d38c08..d976fce3eef 100644
--- a/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/receiver.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,54 +45,58 @@ public:
int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h b/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h
index 687bdfec133..0eb3343f85e 100644
--- a/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Pluggable_Flow_Protocol/sender.h
@@ -1,46 +1,46 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -49,68 +49,70 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the sender to the receiver.
int bind_to_receiver (void);
- // Method that binds the sender to the receiver.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
TAO_StreamCtrl *streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
ACE_CString protocol_;
- // Selected protocol - default is UDP
+ /// Rate at which the data will be sent.
int frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h
index a403d445404..d89a33a5d12 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/distributer.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage
-//
-// = FILENAME
-// distributer.h
-//
-// = DESCRIPTION
-// Process to receive data from the sender and send it to the
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file distributer.h
+ *
+ * $Id$
+ *
+ * Process to receive data from the sender and send it to the
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Distributer_Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Distributer_Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Distributer_Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,45 +45,50 @@ public:
int handle_destroy (void);
private:
+ /// Count of the frames passing through us.
int frame_count_;
- // Count of the frames passing through us.
};
+/**
+ * @class Distributer_Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Distributer_Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Distributer_Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Distributer_Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Distributer_Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -99,71 +103,73 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_B
AV_Null_MediaCtrl>
RECEIVER_ENDPOINT_STRATEGY;
+/**
+ * @class Distributer
+ *
+ * @brief Distributer Application.
+ *
+ * The distributer is the intermediate receiver that receives
+ * data from the sender and forwards to a receiver.
+ */
class Distributer
{
- // = TITLE
- // Distributer Application.
- //
- // = DESCRIPTION
- // The distributer is the intermediate receiver that receives
- // data from the sender and forwards to a receiver.
public:
+ /// Constructor
Distributer (void);
- // Constructor
+ /// Destructor.
~Distributer (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
+ /// Resolve the reference of the mmdevice from the naming service.
void bind_to_mmdevice (AVStreams::MMDevice_ptr &mmdevice,
const ACE_CString &mmdevice_name);
- // Resolve the reference of the mmdevice from the naming service.
+ /// Get the stream control of the receiver
TAO_StreamCtrl *receiver_streamctrl (void);
- // Get the stream control of the receiver
+ /// Accessor methods to set/get our sender protocol object
int sender_protocol_object (TAO_AV_Protocol_Object *object);
TAO_AV_Protocol_Object *sender_protocol_object (void);
- // Accessor methods to set/get our sender protocol object
// Flag to know when we are done.
int done (void) const;
void done (int);
protected:
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// The sender endpoint strategy.
SENDER_ENDPOINT_STRATEGY sender_endpoint_strategy_;
- // The sender endpoint strategy.
+ /// The receiver endpoint strategy.
RECEIVER_ENDPOINT_STRATEGY receiver_endpoint_strategy_;
- // The receiver endpoint strategy.
+ /// The distributer receiver multimedia device
TAO_MMDevice* distributer_receiver_mmdevice_;
- // The distributer receiver multimedia device
+ /// The distributer receiver multimedia device
TAO_MMDevice* distributer_sender_mmdevice_;
- // The distributer receiver multimedia device
+ /// The receiver MMDevice.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice.
+ /// The sender MMDevice.
AVStreams::MMDevice_var sender_mmdevice_;
- // The sender MMDevice.
+ /// The sender protocol object
TAO_AV_Protocol_Object *sender_protocol_object_;
- // The sender protocol object
+ /// Stream controller for the receivers
TAO_StreamCtrl* receiver_streamctrl_;
- // Stream controller for the receivers
+ /// Selected protocol - default is UDP
ACE_CString protocol_;
- // Selected protocol - default is UDP
+ /// Flag to know when we are done.
int done_;
- // Flag to know when we are done.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h
index e7076f5686e..d976fce3eef 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/receiver.h
@@ -1,39 +1,38 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -46,54 +45,58 @@ public:
int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h
index 0bcd944b1e8..b0e4269dc09 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage/sender.h
@@ -1,46 +1,46 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple_Three_Stage
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -49,64 +49,66 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
void streamctrl (AVStreams::StreamCtrl_ptr streamctrl);
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
AVStreams::StreamCtrl_ptr streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Rate at which the data will be sent.
double frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h
index 3c00059838b..b5288300a36 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/receiver.h
@@ -1,22 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -24,17 +21,19 @@
#include "orbsvcs/AV/Policy.h"
#include "Receiver_Stats.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -49,61 +48,65 @@ public:
void dump_samples (const char* file);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
Receiver_Stats stats_;
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h
index a64de401230..d10071d5561 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage/sender.h
@@ -1,46 +1,46 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -49,82 +49,84 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the sender to the receiver.
int bind_to_receiver (void);
- // Method that binds the sender to the receiver.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
TAO_StreamCtrl *streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_TString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
ACE_TString protocol_;
- // Selected protocol - default is UDP
+ /// Rate at which the data will be sent.
double frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
+ /// Destination Address.
char* address_;
- // Destination Address.
+ /// Destination Address.
char* peer_address_;
- // Destination Address.
+ /// Local secondary addresses
char** local_sec_addrs_;
- // Local secondary addresses
+ /// Peer secondary addresses
char** peer_sec_addrs_;
- // Peer secondary addresses
int num_local_sec_addrs_;
int num_peer_sec_addrs_;
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h
index 3b94e1d1e42..fb5d11e2cdb 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/receiver.h
@@ -1,22 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple
-//
-// = FILENAME
-// receiver.h
-//
-// = DESCRIPTION
-// This application receives data from a AV sender and writes it to
-// a file.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file receiver.h
+ *
+ * $Id$
+ *
+ * This application receives data from a AV sender and writes it to
+ * a file.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -24,17 +21,19 @@
#include "orbsvcs/AV/Policy.h"
+/**
+ * @class Receiver_Callback
+ *
+ * @brief Application defined callback object.
+ *
+ * AVStreams calls this class when data shows up from a sender.
+ */
class Receiver_Callback : public TAO_AV_Callback
{
- // = TITLE
- // Application defined callback object.
- //
- // = DESCRIPTION
- // AVStreams calls this class when data shows up from a sender.
public:
+ /// Constructor.
Receiver_Callback (void);
- // Constructor.
// Method that is called when there is data to be received from a
// sender.
@@ -47,54 +46,58 @@ public:
int handle_destroy (void);
private:
+ /// Keeping a count of the incoming frames.
int frame_count_;
- // Keeping a count of the incoming frames.
};
+/**
+ * @class Receiver_StreamEndPoint
+ *
+ * @brief Application defined stream endpoint object.
+ *
+ * AVStreams calls this class during connection setup.
+ */
class Receiver_StreamEndPoint : public TAO_Server_StreamEndPoint
{
- // = TITLE
- // Application defined stream endpoint object.
- //
- // = DESCRIPTION
- // AVStreams calls this class during connection setup.
public:
// Create a receiver application callback.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
private:
+ /// Receiver application callback.
Receiver_Callback callback_;
- // Receiver application callback.
};
+/**
+ * @class Receiver
+ *
+ * @brief Receiver application class.
+ *
+ * This class receives data from a AV sender and writes it to
+ * a file.
+ */
class Receiver
{
- // = TITLE
- // Receiver application class.
- //
- // = DESCRIPTION
- // This class receives data from a AV sender and writes it to
- // a file.
public:
+ /// Constructor
Receiver (void);
- // Constructor
+ /// Destructor.
~Receiver (void);
- // Destructor.
+ /// Initialize data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize data components.
protected:
+ /// The Naming Service Client.
TAO_Naming_Client naming_client_;
- // The Naming Service Client.
+ /// The endpoint reactive strategy.
TAO_AV_Endpoint_Reactive_Strategy_B
<Receiver_StreamEndPoint,TAO_VDev,AV_Null_MediaCtrl> reactive_strategy_;
- // The endpoint reactive strategy.
+ /// Receiver MMDevice.
TAO_MMDevice *mmdevice_;
- // Receiver MMDevice.
};
diff --git a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h
index 49e6dffa56d..3ee93e5654f 100644
--- a/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h
+++ b/TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS/sender.h
@@ -1,49 +1,49 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Simple_Two_Stage_With_QoS
-//
-// = FILENAME
-// sender.h
-//
-// = DESCRIPTION
-// This application reads data from a file and sends it to s
-// receiver through an RSVP enabled stream.
-//
-// = AUTHOR
-// Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file sender.h
+ *
+ * $Id$
+ *
+ * This application reads data from a file and sends it to s
+ * receiver through an RSVP enabled stream.
+ *
+ *
+ * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
#include "orbsvcs/AV/Endpoint_Strategy.h"
#include "orbsvcs/AV/Protocol_Factory.h"
+/**
+ * @class Sender_StreamEndPoint
+ *
+ * @brief Defines a sender stream endpoint.
+ */
class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint
{
- // = TITLE
- // Defines a sender stream endpoint.
public:
+ /// Create the application callback and return its handle to
+ /// AVStreams for further application callbacks.
int get_callback (const char *flowname,
TAO_AV_Callback *&callback);
- // Create the application callback and return its handle to
- // AVStreams for further application callbacks.
+ /// Set protocol object corresponding to the transport protocol
+ /// chosen.
int set_protocol_object (const char *flowname,
TAO_AV_Protocol_Object *object);
- // Set protocol object corresponding to the transport protocol
- // chosen.
CORBA::Boolean modify_QoS (AVStreams::streamQoS &new_qos,
const AVStreams::flowSpec &/* the_flows */
);
protected:
+ /// Application callback.
TAO_AV_Callback callback_;
- // Application callback.
};
typedef TAO_AV_Endpoint_Reactive_Strategy_A
@@ -52,79 +52,81 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A
AV_Null_MediaCtrl>
SENDER_ENDPOINT_STRATEGY;
+/**
+ * @class Sender
+ *
+ * @brief Sender Application.
+ *
+ * Class is responsible for streaming (and pacing) data to a
+ * receiver.
+ */
class Sender
{
- // = TITLE
- // Sender Application.
- //
- // = DESCRIPTION
- // Class is responsible for streaming (and pacing) data to a
- // receiver.
public:
+ /// Constructor
Sender (void);
- // Constructor
+ /// Method to initialize the various data components.
int init (int argc,
ACE_TCHAR *argv[]);
- // Method to initialize the various data components.
+ /// Method to pace and send data from a file.
int pace_data (void);
- // Method to pace and send data from a file.
+ /// Set the protocol object corresponding to the transport protocol chosen.
void protocol_object (TAO_AV_Protocol_Object *protocol_object);
- // Set the protocol object corresponding to the transport protocol chosen.
+ /// Method to populate the required qos.
void fill_qos (AVStreams::streamQoS &);
- // Method to populate the required qos.
private:
+ /// Method to parse the command line arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Method to parse the command line arguments.
+ /// Method that binds the sender to the receiver.
int bind_to_receiver (void);
- // Method that binds the sender to the receiver.
+ /// The endpoint strategy used by the sender.
SENDER_ENDPOINT_STRATEGY endpoint_strategy_;
- // The endpoint strategy used by the sender.
+ /// The receiver MMDevice that the sender connects to.
AVStreams::MMDevice_var receiver_mmdevice_;
- // The receiver MMDevice that the sender connects to.
+ /// The sender MMDevice.
TAO_MMDevice *sender_mmdevice_;
- // The sender MMDevice.
+ /// Stream controller
TAO_StreamCtrl *streamctrl_;
- // Stream controller
+ /// Number of frames sent.
int frame_count_;
- // Number of frames sent.
+ /// File from which data is read.
ACE_CString filename_;
- // File from which data is read.
+ /// The Naming Service client.
TAO_Naming_Client naming_client_;
- // The Naming Service client.
+ /// File handle of the file read from.
FILE *input_file_;
- // File handle of the file read from.
+ /// Selected protocol - default is UDP
ACE_CString protocol_;
- // Selected protocol - default is UDP
+ /// Rate at which the data will be sent.
double frame_rate_;
- // Rate at which the data will be sent.
+ /// Message block into which data is read from a file and then sent.
ACE_Message_Block mb_;
- // Message block into which data is read from a file and then sent.
+ /// Protocol object corresponding to the transport protocol selected.
TAO_AV_Protocol_Object *protocol_object_;
- // Protocol object corresponding to the transport protocol selected.
+ /// Destination Address.
ACE_TCHAR *address_;
- // Destination Address.
+ /// Destination Address.
ACE_TCHAR *peer_addr_;
- // Destination Address.
ACE_CString flowname_;
};
diff --git a/TAO/orbsvcs/tests/Bug_2248_Regression/Client_i.h b/TAO/orbsvcs/tests/Bug_2248_Regression/Client_i.h
index e85d58ef471..402529f99c6 100644
--- a/TAO/orbsvcs/tests/Bug_2248_Regression/Client_i.h
+++ b/TAO/orbsvcs/tests/Bug_2248_Regression/Client_i.h
@@ -1,15 +1,17 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Client_i.h
-//
-// = DESCRIPTION
-// A helper class for the client
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Client_i.h
+ *
+ * $Id$
+ *
+ * A helper class for the client
+ *
+ *
+ */
+//=============================================================================
+
#ifndef BUG_2248_REGRESSION_CLIENT_I_H
#define BUG_2248_REGRESSION_CLIENT_I_H
@@ -24,11 +26,11 @@
class Client_i
{
public:
+ /// Our constructor
Client_i (CORBA::ORB_ptr orb);
- // Our constructor
+ /// Initialize the ORB etc.
int init (void);
- // Initialize the ORB etc.
private:
CORBA::ORB_var orb_;
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_client.cpp b/TAO/orbsvcs/tests/Concurrency/CC_client.cpp
index a139a8517fb..3d193102446 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_client.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/CC_client.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// CC_client.h
-//
-// = DESCRIPTION
-// This is the test class for the concurrency service. The class
-// implements a client to the concurrency service.
-// This file contains the main function for the test.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_client.h
+ *
+ * $Id$
+ *
+ * This is the test class for the concurrency service. The class
+ * implements a client to the concurrency service.
+ * This file contains the main function for the test.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CC_client.h"
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_client.h b/TAO/orbsvcs/tests/Concurrency/CC_client.h
index 870459d47e6..fa7e965546b 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_client.h
+++ b/TAO/orbsvcs/tests/Concurrency/CC_client.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_client.h
-//
-// = DESCRIPTION
-// This class implements a client used to test the CosConcurrency
-// service.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_client.h
+ *
+ * $Id$
+ *
+ * This class implements a client used to test the CosConcurrency
+ * service.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
@@ -43,100 +39,102 @@ extern FILE *ace_cc_yyin;
// end of parser stuff
+/**
+ * @class CC_Client
+ *
+ * @brief Defines a class that encapsulates the behaviour of a clien of
+ * the concurrency service.
+ *
+ * This class declares an interface to run the test client for
+ * the concurrency service.
+ */
class CC_Client
{
- // = TITLE
- // Defines a class that encapsulates the behaviour of a clien of
- // the concurrency service.
- //
- // = DESCRIPTION
- // This class declares an interface to run the test client for
- // the concurrency service.
public:
// = Initialization and termination methods.
+ /// Default constructor.
CC_Client (void);
- // Default constructor.
+ /// Destructor.
~CC_Client (void);
- // Destructor.
+ /// Run the test.
int run (void);
- // Run the test.
+ /// Initialize the test with the parameters from the command line.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the test with the parameters from the command line.
private:
+ /// Function to initialize the naming service.
int init_naming_service (void);
- // Function to initialize the naming service.
+ /// Function to parse the command line arguments.
int parse_args (void);
- // Function to parse the command line arguments.
+ /// Function to read the ior from the given file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the ior from the given file.
+ /// Runs the basic tests (on a single lock set). Returns CC_SUCCESS
+ /// upon success CC_FAIL otherwise.
int run_basic_tests (void);
- // Runs the basic tests (on a single lock set). Returns CC_SUCCESS
- // upon success CC_FAIL otherwise.
+ /// Runs the extended tests (on more lock sets). Returns CC_SUCCESS
+ /// upon success CC_FAIL otherwise.
int run_extended_tests (ACE_TCHAR *params);
- // Runs the extended tests (on more lock sets). Returns CC_SUCCESS
- // upon success CC_FAIL otherwise.
+ /// Checks the parameters given to the run_extended_tests() function.
+ /// returns -1 if an error is found.
int check_extended_test_params(ACE_TCHAR *params);
- // Checks the parameters given to the run_extended_tests() function.
- // returns -1 if an error is found.
+ /// A pointer to the naming service used for this test.
CC_naming_service *naming_service_;
- // A pointer to the naming service used for this test.
+ /// File from which to obtain the IOR.
FILE *cc_factory_ior_file_;
- // File from which to obtain the IOR.
+ /// The factory key for the lock set factory.
char *cc_factory_key_;
- // The factory key for the lock set factory.
+ /// File handle to read the IOR.
ACE_HANDLE f_handle_;
- // File handle to read the IOR.
+ /// Flag to tell server to shutdown.
int shutdown_;
- // Flag to tell server to shutdown.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
// CosConcurrencyControl::LockSetFactory_var factory_;
// factory pointer for the lock set. @@TAO maybe to be used when naming
// service is not used (for simple testing)
+ /// The number of arguments passed on the command line.
int argc_;
- // The number of arguments passed on the command line.
+ /// The arguments from the command line.
ACE_TCHAR **argv_;
- // The arguments from the command line.
+ /// Flag to tell the client whether to use the naming service or not
+ /// to find the concurrency control factory.
int use_naming_service_;
- // Flag to tell the client whether to use the naming service or not
- // to find the concurrency control factory.
+ /// flag to tell which test should be run.
int run_basic_tests_;
- // flag to tell which test should be run.
+ /// flag to tell which test should be run.
int run_extended_tests_;
- // flag to tell which test should be run.
+ /// Parameters to the extended tests. The parameters are of the
+ /// following format: <test>:<parm1>:<parm2>...
ACE_TCHAR *extended_tests_params_;
- // Parameters to the extended tests. The parameters are of the
- // following format: <test>:<parm1>:<parm2>...
+ /// Flag to tell whethter to use a script file to run the tests.
int use_script_file_;
- // Flag to tell whethter to use a script file to run the tests.
+ /// The script file to run
ACE_TCHAR *script_file_;
- // The script file to run
+ /// Prints out the options to the program.
void print_usage (void);
- // Prints out the options to the program.
};
#endif /* !defined (_CC_CLIENT_H_) */
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_command.cpp b/TAO/orbsvcs/tests/Concurrency/CC_command.cpp
index a04a418f5df..30b8c30e49d 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_command.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/CC_command.cpp
@@ -1,19 +1,16 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// CC_command.cpp
-//
-// = DESCRIPTION
-// This is the command classes for the test of the concurrency service.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file CC_command.cpp
+ *
+ * $Id$
+ *
+ * This is the command classes for the test of the concurrency service.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CC_command.h"
#include "CC_test_utils.h"
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_command.h b/TAO/orbsvcs/tests/Concurrency/CC_command.h
index dbd70e7ac12..fd0d1625147 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_command.h
+++ b/TAO/orbsvcs/tests/Concurrency/CC_command.h
@@ -1,474 +1,512 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_command.h
-//
-// = DESCRIPTION
-// This file implements the command possible to execute on the
-// concurrency service's lock set interface. The file also contains
-// an implementation of a command list used by the command parser to
-// store the commands to be executed.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_command.h
+ *
+ * $Id$
+ *
+ * This file implements the command possible to execute on the
+ * concurrency service's lock set interface. The file also contains
+ * an implementation of a command list used by the command parser to
+ * store the commands to be executed.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/CosConcurrencyControlC.h"
#ifndef _CC_COMMAND_H_
#define _CC_COMMAND_H_
+/**
+ * @class CC_Command
+ *
+ * @brief Defines an abstact class for the commands towards the lock set
+ *
+ * This class declares an interface to run a test towards one or more
+ * lock sets in the concurrency service. The class provides a virtual
+ * execute method that is common for all its subclasses. It is also the
+ * the base class for the auxillary commands start, wait, and sleep.
+ */
class CC_Command
- // = TITLE
- // Defines an abstact class for the commands towards the lock set
- //
- // = DESCRIPTION
- // This class declares an interface to run a test towards one or more
- // lock sets in the concurrency service. The class provides a virtual
- // execute method that is common for all its subclasses. It is also the
- // the base class for the auxillary commands start, wait, and sleep.
{
public:
+ /// Destructor
virtual ~CC_Command(void);
- // Destructor
+ /// Abstract execute method
virtual int execute() = 0;
- // Abstract execute method
protected:
+ /// Function to look up the lock set we are operating on, or if the
+ /// name is "" return the global lock set variable
CosConcurrencyControl::LockSet_var
GetLockSet (const char *lock_set_name);
- // Function to look up the lock set we are operating on, or if the
- // name is "" return the global lock set variable
+ /// Default constructor. We do not want instances of this class
CC_Command(void);
- // Default constructor. We do not want instances of this class
+ /**
+ * The last exception raised in one of the test commands. This variable
+ * is checked by all commands in order to determine if an exception has
+ * been raised. This is necessary because sometimes we want to check that
+ * an event caused an exception (done by the CC_Excep_Cmd command class)
+ * as part of the testing.
+ */
static CORBA::Exception *excep_;
- // The last exception raised in one of the test commands. This variable
- // is checked by all commands in order to determine if an exception has
- // been raised. This is necessary because sometimes we want to check that
- // an event caused an exception (done by the CC_Excep_Cmd command class)
- // as part of the testing.
+ /// This is the default lock set. The variable is either set by a create
+ /// command without name or by the lookup command.
static CosConcurrencyControl::LockSet_var cc_lockset_;
- // This is the default lock set. The variable is either set by a create
- // command without name or by the lookup command.
private:
};
+/**
+ * @class CC_Start_Cmd
+ *
+ * @brief Defines a class for the start command
+ *
+ * This class represents the start command. The start command is used
+ * to start a new process with another script file in order to test the
+ * aspects of the concurrency service that requires several processes
+ * running at the same time.
+ */
class CC_Start_Cmd : public CC_Command
- // = TITLE
- // Defines a class for the start command
- //
- // = DESCRIPTION
- // This class represents the start command. The start command is used
- // to start a new process with another script file in order to test the
- // aspects of the concurrency service that requires several processes
- // running at the same time.
{
public:
+ /// Constructor
CC_Start_Cmd (const char *config_file_name);
- // Constructor
+ /// Destructor
virtual ~CC_Start_Cmd();
- // Destructor
+ /// Start the child process. The current version does not wait for the
+ /// process to terminate.
virtual int execute(void);
- // Start the child process. The current version does not wait for the
- // process to terminate.
private:
+ /// The name of the script file
char *cfg_name_;
- // The name of the script file
};
+/**
+ * @class CC_CreateLockSet_Cmd
+ *
+ * @brief Defines a class for the create command on the lock set factory
+ *
+ * This class represents the create command on the lock set factory.
+ * The lock set is registered in the naming service with the provided
+ * name.
+ */
class CC_CreateLockSet_Cmd : public CC_Command
- // = TITLE
- // Defines a class for the create command on the lock set factory
- //
- // = DESCRIPTION
- // This class represents the create command on the lock set factory.
- // The lock set is registered in the naming service with the provided
- // name.
{
public:
+ /// Constructor
CC_CreateLockSet_Cmd (const char *lock_set_name);
- // Constructor
+ /// Destructor
virtual ~CC_CreateLockSet_Cmd ();
- // Destructor
+ /// Executes the command, i.e. creates the lock set and binds the name
+ /// in the naming service.
virtual int execute(void);
- // Executes the command, i.e. creates the lock set and binds the name
- // in the naming service.
private:
+ /// The name used to bind in the naming service.
char *name_;
- // The name used to bind in the naming service.
};
+/**
+ * @class CC_Lock_Cmd:public
+ *
+ * @brief Defines a class for the lock command on the lock set
+ *
+ * This class represents the lock command on the lock set. The lock set
+ * is looked up in the naming service.
+ */
class CC_Lock_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the lock command on the lock set
- //
- // = DESCRIPTION
- // This class represents the lock command on the lock set. The lock set
- // is looked up in the naming service.
{
public:
+ /// Constructor.
CC_Lock_Cmd(const char *lock_set_name,
CosConcurrencyControl::lock_mode mode);
- // Constructor.
+ /// Destructor
virtual ~CC_Lock_Cmd();
- // Destructor
+ /// Executes the command, i.e. looks up the lock set with the requested
+ /// name in the naming server and executes the lock command on that lock set.
virtual int execute(void);
- // Executes the command, i.e. looks up the lock set with the requested
- // name in the naming server and executes the lock command on that lock set.
private:
+ /// The name to look up in the naming service.
char *name_;
- // The name to look up in the naming service.
+ /// The mode of the lock.
CosConcurrencyControl::lock_mode mode_;
- // The mode of the lock.
};
+/**
+ * @class CC_UnLock_Cmd:public
+ *
+ * @brief Defines a class for the unlock command on the lock set
+ *
+ * This class represents the unlock command on the lock set. The lock set
+ * is looked up in the naming service.
+ */
class CC_UnLock_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the unlock command on the lock set
- //
- // = DESCRIPTION
- // This class represents the unlock command on the lock set. The lock set
- // is looked up in the naming service.
{
public:
+ /// Constructor.
CC_UnLock_Cmd(const char *lock_set_name,
CosConcurrencyControl::lock_mode mode);
- // Constructor.
+ /// Destructor
virtual ~CC_UnLock_Cmd();
- // Destructor
+ /**
+ * Executes the command, i.e. looks up the lock set with the requested
+ * name in the naming server and executes the unlock command on that
+ * lock set.
+ */
virtual int execute(void);
- // Executes the command, i.e. looks up the lock set with the requested
- // name in the naming server and executes the unlock command on that
- // lock set.
private:
+ /// The name to look up in the naming service.
char *name_;
- // The name to look up in the naming service.
+ /// The mode of the lock.
CosConcurrencyControl::lock_mode mode_;
- // The mode of the lock.
};
+/**
+ * @class CC_TryLock_Cmd:public
+ *
+ * @brief Defines a class for the try_lock command on the lock set
+ *
+ * This class represents the try_lock command on the lock set. The lock set
+ * is looked up in the naming service.
+ */
class CC_TryLock_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the try_lock command on the lock set
- //
- // = DESCRIPTION
- // This class represents the try_lock command on the lock set. The lock set
- // is looked up in the naming service.
{
public:
+ /// Constructor
CC_TryLock_Cmd(const char *lock_set_name,
CosConcurrencyControl::lock_mode mode);
- // Constructor
+ /// Destructor
virtual ~CC_TryLock_Cmd();
- // Destructor
+ /**
+ * Executes the command, i.e. looks up the lock set with the requested
+ * name in the naming server and executes the try_lock command on that
+ * lock set.
+ */
virtual int execute(void);
- // Executes the command, i.e. looks up the lock set with the requested
- // name in the naming server and executes the try_lock command on that
- // lock set.
private:
+ /// The name to look up in the naming service.
char *name_;
- // The name to look up in the naming service.
+ /// The mode of the lock.
CosConcurrencyControl::lock_mode mode_;
- // The mode of the lock.
};
+/**
+ * @class CC_ChangeMode_Cmd:public
+ *
+ * @brief Defines a class for the change_mode command on the lock set
+ *
+ * This class represents the change_mode command on the lock set.
+ * The lock set is looked up in the naming service.
+ */
class CC_ChangeMode_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the change_mode command on the lock set
- //
- // = DESCRIPTION
- // This class represents the change_mode command on the lock set.
- // The lock set is looked up in the naming service.
{
public:
+ /// Constructor
CC_ChangeMode_Cmd (const char *lock_set_name,
CosConcurrencyControl::lock_mode held_mode,
CosConcurrencyControl::lock_mode new_mode);
- // Constructor
+ /// Destructor
virtual ~CC_ChangeMode_Cmd();
- // Destructor
+ /**
+ * Executes the command, i.e. looks up the lock set with the requested
+ * name in the naming server and executes the change_mode command on that
+ * lock set.
+ */
virtual int execute(void);
- // Executes the command, i.e. looks up the lock set with the requested
- // name in the naming server and executes the change_mode command on that
- // lock set.
private:
+ /// The name to look up in the naming service.
char *name_;
- // The name to look up in the naming service.
+ /// The mode of the held lock
CosConcurrencyControl::lock_mode held_mode_;
- // The mode of the held lock
+ /// The new mode of the lock
CosConcurrencyControl::lock_mode new_mode_;
- // The new mode of the lock
};
+/**
+ * @class CC_Sleep_Cmd:public
+ *
+ * @brief Defines a class for the sleep command
+ *
+ * This class represents the sleep command. This command is used to make
+ * the script pause for the requested number of second, e.g. to wait for
+ * another process to start.
+ */
class CC_Sleep_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the sleep command
- //
- // = DESCRIPTION
- // This class represents the sleep command. This command is used to make
- // the script pause for the requested number of second, e.g. to wait for
- // another process to start.
{
public:
+ /// Constructor.
CC_Sleep_Cmd(int seconds);
- // Constructor.
+ /// Destructor.
virtual ~CC_Sleep_Cmd();
- // Destructor.
+ /// Executes the command.
virtual int execute(void);
- // Executes the command.
private:
+ /// The number of seconds to sleep
int time_;
- // The number of seconds to sleep
};
+/**
+ * @class CC_Repeat_Cmd:public
+ *
+ * @brief Defines a class for the repeat command
+ *
+ * This class represents the repeat command. This command is used to make
+ * the script repeat the test the requested number of times.
+ * The command is curently NOT implemented.
+ */
class CC_Repeat_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the repeat command
- //
- // = DESCRIPTION
- // This class represents the repeat command. This command is used to make
- // the script repeat the test the requested number of times.
- // The command is curently NOT implemented.
{
public:
+ /// Constructor.
CC_Repeat_Cmd(int times);
- // Constructor.
+ /// Destructor.
virtual ~CC_Repeat_Cmd();
- // Destructor.
+ /// Executes the command.
virtual int execute(void);
- // Executes the command.
private:
+ /// The number of times the commands should be repeated
int times_;
- // The number of times the commands should be repeated
};
+/**
+ * @class CC_Wait_Cmd:public
+ *
+ * @brief Defines a class for the wait command
+ *
+ * This class represents the wait command. This command is used to make
+ * the script wait for the user to press return. It is possible to print
+ * different prompts, e.g. instructions.
+ */
class CC_Wait_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the wait command
- //
- // = DESCRIPTION
- // This class represents the wait command. This command is used to make
- // the script wait for the user to press return. It is possible to print
- // different prompts, e.g. instructions.
{
public:
+ /// Constructor.
CC_Wait_Cmd (const char *prompt);
- // Constructor.
+ /// Destructor.
virtual ~CC_Wait_Cmd();
- // Destructor.
+ /// Executes the command.
virtual int execute(void);
- // Executes the command.
private:
+ /// The prompt to print on the screen
char *prompt_;
- // The prompt to print on the screen
};
+/**
+ * @class CC_Excep_Cmd
+ *
+ * @brief Defines a class for the excep command
+ *
+ * This class represents the excep command. This command is used to make
+ * the script capable of dealing with cases where an exception is raised
+ * as part of the testing.
+ */
class CC_Excep_Cmd : public CC_Command
- // = TITLE
- // Defines a class for the excep command
- //
- // = DESCRIPTION
- // This class represents the excep command. This command is used to make
- // the script capable of dealing with cases where an exception is raised
- // as part of the testing.
{
public:
+ /// Constructor.
CC_Excep_Cmd (const char *excep);
- // Constructor.
+ /// Destructor.
virtual ~CC_Excep_Cmd(void);
- // Destructor.
+ /**
+ * Executes the command. Checks to see if the excep_ class variable is set,
+ * and if that's the case check that it is of the expected type. If not the
+ * test fails.
+ */
virtual int execute(void);
- // Executes the command. Checks to see if the excep_ class variable is set,
- // and if that's the case check that it is of the expected type. If not the
- // test fails.
private:
+ /// The string representation of the expected exception
char *ex_;
- // The string representation of the expected exception
};
+/**
+ * @class CC_Dummy_Cmd:
+ *
+ * @brief Defines a class for the dummy command
+ *
+ * This class represents the dummy command. This command is used to
+ * put in a command in the chain that does nothing.
+ */
class CC_Dummy_Cmd: public CC_Command
- // = TITLE
- // Defines a class for the dummy command
- //
- // = DESCRIPTION
- // This class represents the dummy command. This command is used to
- // put in a command in the chain that does nothing.
{
public:
+ /// Constructor.
CC_Dummy_Cmd(void);
- // Constructor.
+ /// Destructor.
virtual ~CC_Dummy_Cmd(void);
- // Destructor.
+ /// Executes the command, i.e. does nothing.
virtual int execute(void);
- // Executes the command, i.e. does nothing.
private:
};
+/**
+ * @class CC_Print_Cmd:
+ *
+ * @brief Defines a class for the print command
+ *
+ * This class represents the print command. This command is used to
+ * print a message on stdout
+ */
class CC_Print_Cmd: public CC_Command
- // = TITLE
- // Defines a class for the print command
- //
- // = DESCRIPTION
- // This class represents the print command. This command is used to
- // print a message on stdout
{
public:
+ /// Constructor.
CC_Print_Cmd (const char *message);
- // Constructor.
+ /// Destructor.
virtual ~CC_Print_Cmd(void);
- // Destructor.
+ /// Executes the command.
virtual int execute(void);
- // Executes the command.
private:
+ /// Holds the message to print
char *msg_;
- // Holds the message to print
};
+/**
+ * @class CC_Lookup_Cmd:public
+ *
+ * @brief Defines a class for the lookup command.
+ *
+ * This class represents the lookup command. The lock set
+ * is looked up in the naming service and the class variable
+ * cc_lockset_ is set accordingly.
+ */
class CC_Lookup_Cmd:public CC_Command
- // = TITLE
- // Defines a class for the lookup command.
- //
- // = DESCRIPTION
- // This class represents the lookup command. The lock set
- // is looked up in the naming service and the class variable
- // cc_lockset_ is set accordingly.
{
public:
+ /// Constructor
CC_Lookup_Cmd (const char *lock_set_name);
- // Constructor
+ /// Destructor
virtual ~CC_Lookup_Cmd();
- // Destructor
+ /// Executes the command, i.e. looks up the lock set with the requested
+ /// name in the naming server and sets the cc_lockset_ variable.
virtual int execute(void);
- // Executes the command, i.e. looks up the lock set with the requested
- // name in the naming server and sets the cc_lockset_ variable.
private:
+ /// The name to look up in the naming service.
char *name_;
- // The name to look up in the naming service.
};
+/**
+ * @class CC_CommandElem
+ *
+ * @brief Defines a class for a command element
+ *
+ * This class implements a command element used in the command list
+ * below. The class is a simple tupple holding a pointer to the command
+ * and a pointer to the next element in the list.
+ */
class CC_CommandElem
- // = TITLE
- // Defines a class for a command element
- //
- // = DESCRIPTION
- // This class implements a command element used in the command list
- // below. The class is a simple tupple holding a pointer to the command
- // and a pointer to the next element in the list.
{
public:
+ /// Constructor.
CC_CommandElem (CC_Command *cmd, CC_CommandElem *next);
- // Constructor.
+ /// Destructor.
~CC_CommandElem(void);
- // Destructor.
+ /// Returns a pointer to the command in this element
CC_Command *GetCommand(void);
- // Returns a pointer to the command in this element
+ /// Returns the pointer to the next element
CC_CommandElem *GetNext(void);
- // Returns the pointer to the next element
+ /// Sets the next pointer
void SetNext(CC_CommandElem *next);
- // Sets the next pointer
private:
+ /// Pointer to the next element
CC_CommandElem *next_;
- // Pointer to the next element
+ /// Pointer to the command element
CC_Command *cmd_;
- // Pointer to the command element
};
+/**
+ * @class CC_CommandList
+ *
+ * @brief Defines a class for a command list
+ *
+ * This class implements a command list used from the script parser
+ * to store the parsed commands The class implements a simple single
+ * linked list.
+ */
class CC_CommandList
- // = TITLE
- // Defines a class for a command list
- //
- // = DESCRIPTION
- // This class implements a command list used from the script parser
- // to store the parsed commands The class implements a simple single
- // linked list.
{
public:
+ /// Constructor.
CC_CommandList(void);
- // Constructor.
+ /// Destructor.
~CC_CommandList(void);
- // Destructor.
+ /// Adds the command to the list
int add(CC_Command *cmd);
- // Adds the command to the list
+ /// Executes all the commands in the list from head to tail
int execute(void);
- // Executes all the commands in the list from head to tail
+ /// Sets the number of times to repeat the script
void setrepeat(int times);
- // Sets the number of times to repeat the script
private:
+ /// The head of the command list
CC_CommandElem *head_;
- // The head of the command list
+ /// The last inserted element
CC_CommandElem *last_;
- // The last inserted element
+ /// The number of times the script should be repeated
int times_;
- // The number of times the script should be repeated
};
#endif /* _CC_COMMAND_H_ */
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_naming_service.cpp b/TAO/orbsvcs/tests/Concurrency/CC_naming_service.cpp
index 8cacdb3c79c..a274387a7af 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_naming_service.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/CC_naming_service.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_naming_service.cpp
-//
-// = DESCRIPTION
-// This class implements the naming services necessary to test the
-// concurrency service
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_naming_service.cpp
+ *
+ * $Id$
+ *
+ * This class implements the naming services necessary to test the
+ * concurrency service
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CC_naming_service.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_naming_service.h b/TAO/orbsvcs/tests/Concurrency/CC_naming_service.h
index 9a992338ee2..b5ef3db0f05 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_naming_service.h
+++ b/TAO/orbsvcs/tests/Concurrency/CC_naming_service.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_naming_service.h
-//
-// = DESCRIPTION
-// This class implements the naming services necessary to test the
-// concurrency service.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_naming_service.h
+ *
+ * $Id$
+ *
+ * This class implements the naming services necessary to test the
+ * concurrency service.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/CosConcurrencyControlC.h"
#include "orbsvcs/CosNamingC.h"
@@ -25,60 +21,62 @@
#ifndef _CC_NAMING_SERVICE_H_
#define _CC_NAMING_SERVICE_H_
+/**
+ * @class CC_naming_service
+ *
+ * @brief Defines a class that encapsulates the necessary naming service
+ * functions for the concurrency service.
+ *
+ * This class declares an interface to the naming service for the
+ * concurrency service tests.
+ */
class CC_naming_service
{
- // = TITLE
- // Defines a class that encapsulates the necessary naming service
- // functions for the concurrency service.
- //
- // = DESCRIPTION
- // This class declares an interface to the naming service for the
- // concurrency service tests.
public:
+ /// Default constructor
CC_naming_service ();
- // Default constructor
+ /// Constructor
CC_naming_service (CORBA::ORB_var orb_);
- // Constructor
+ /// Default destructor.
~CC_naming_service (void);
- // Default destructor.
+ /// Initialization method must be called after first call of Instance()
+ /// in order to initialize the object correctly
void Init (CORBA::ORB_var orb_);
- // Initialization method must be called after first call of Instance()
- // in order to initialize the object correctly
+ /// Lookup a name in the naming service (context, name)
CORBA::Object_var get_obj_from_name (const char *c_name,
const char *name);
- // Lookup a name in the naming service (context, name)
+ /// Bind a name in the concurrency context.
void bind_name (const char *n,
CORBA::Object_ptr obj);
- // Bind a name in the concurrency context.
+ /// Gets the cc lock set factory which is common for all tests.
CosConcurrencyControl::LockSetFactory_var get_lock_set_factory (void);
- // Gets the cc lock set factory which is common for all tests.
+ /// The naming service object is a singleton
static CC_naming_service *Instance(void);
- // The naming service object is a singleton
private:
+ /// Function to initialize the naming service.
int init_naming_service (void);
- // Function to initialize the naming service.
+ /// Key of factory obj ref.
char *cc_factory_key_;
- // Key of factory obj ref.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Name service wrapper class
TAO_Naming_Client my_name_client_;
- // Name service wrapper class
+ /// factory pointer for the lock set.
CosConcurrencyControl::LockSetFactory_var factory_;
- // factory pointer for the lock set.
+ /// The instance of the naming service object
static CC_naming_service *instance_;
- // The instance of the naming service object
};
#endif /* !defined (_CC_NAMING_SERVICE_H_) */
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_test_utils.cpp b/TAO/orbsvcs/tests/Concurrency/CC_test_utils.cpp
index 420a426e7cf..fa812004497 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_test_utils.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/CC_test_utils.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// CC_test_utils.cpp
-//
-// = DESCRIPTION
-// This class provides a namespace for utility functions for the
-// concurrency service test.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file CC_test_utils.cpp
+ *
+ * $Id$
+ *
+ * This class provides a namespace for utility functions for the
+ * concurrency service test.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CC_test_utils.h"
#include "CC_naming_service.h"
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_test_utils.h b/TAO/orbsvcs/tests/Concurrency/CC_test_utils.h
index 4c1a643f863..a9964b7fd66 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_test_utils.h
+++ b/TAO/orbsvcs/tests/Concurrency/CC_test_utils.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// CC_test_utils.h
-//
-// = DESCRIPTION
-// This class provides a namespace for utility functions for the
-// concurrency service test.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file CC_test_utils.h
+ *
+ * $Id$
+ *
+ * This class provides a namespace for utility functions for the
+ * concurrency service test.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/CosConcurrencyControlC.h"
@@ -25,12 +22,12 @@
class CC_TestUtils
{
public:
+ /// Function to return a human readable string from a lock_mode enum.
static char *get_lock_mode_name (CosConcurrencyControl::lock_mode mode);
- // Function to return a human readable string from a lock_mode enum.
+ /// Creates a lock set by means of th lock set factory in the concurrency
+ /// service server.
static CosConcurrencyControl::LockSet_ptr create_lock_set (void);
- // Creates a lock set by means of th lock set factory in the concurrency
- // service server.
private:
};
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_tests.cpp b/TAO/orbsvcs/tests/Concurrency/CC_tests.cpp
index 02f73ac5907..25ebb679269 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_tests.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/CC_tests.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_tests.h
-//
-// = DESCRIPTION
-// This class implements a number of test objects to test the
-// concurrency service.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_tests.h
+ *
+ * $Id$
+ *
+ * This class implements a number of test objects to test the
+ * concurrency service.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "CC_tests.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/orbsvcs/tests/Concurrency/CC_tests.h b/TAO/orbsvcs/tests/Concurrency/CC_tests.h
index 9f0083fd2ad..94e50852ee1 100644
--- a/TAO/orbsvcs/tests/Concurrency/CC_tests.h
+++ b/TAO/orbsvcs/tests/Concurrency/CC_tests.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Concurrency
-//
-// = FILENAME
-// CC_tests.h
-//
-// = DESCRIPTION
-// This class implements a number of test objects to test the
-// concurrency service.
-//
-// = AUTHORS
-// Torben Worm <tworm@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file CC_tests.h
+ *
+ * $Id$
+ *
+ * This class implements a number of test objects to test the
+ * concurrency service.
+ *
+ *
+ * @author Torben Worm <tworm@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/CosConcurrencyControlC.h"
#include "orbsvcs/CosNamingC.h"
@@ -32,152 +28,177 @@ enum
CC_SUCCESS = 1
};
+/**
+ * @class CC_Test
+ *
+ * @brief Defines an abstract base class for a test
+ *
+ * This class declares an interface to run the test of the
+ * concurrency service.
+ */
class CC_Test
{
- // = TITLE
- // Defines an abstract base class for a test
- //
- // = DESCRIPTION
- // This class declares an interface to run the test of the
- // concurrency service.
public:
+ /// Default constructor
CC_Test (CC_naming_service *ns);
- // Default constructor
+ /// Destructor
virtual ~CC_Test (void);
- // Destructor
+ /// Run the test times_to_run number of times. Returns CC_SUCCESS on
+ /// success CC_FAIL otherwise.
virtual int run (int times_to_run = 1) = 0;
- // Run the test times_to_run number of times. Returns CC_SUCCESS on
- // success CC_FAIL otherwise.
+ /// Create a new lock set using the default global lock set factory
+ /// from the naming service.
CosConcurrencyControl::LockSet_ptr create_lock_set (void);
- // Create a new lock set using the default global lock set factory
- // from the naming service.
+ /// Returns a human readable string from the lock mode enum.
char *get_lock_mode_name (CosConcurrencyControl::lock_mode mode);
- // Returns a human readable string from the lock mode enum.
protected:
+ /// The result of the test being performed.
int result;
- // The result of the test being performed.
+ /// The naming service beeing used to register and look up locks
CC_naming_service *naming_service_;
- // The naming service beeing used to register and look up locks
};
+/**
+ * @class Test_Single_Lock_With_Mode
+ *
+ * @brief This is a simple test that checks that it is possible to set
+ * the lock in the desired mode, try it, and release it.
+ */
class Test_Single_Lock_With_Mode : public CC_Test
{
- // = TITLE
- // This is a simple test that checks that it is possible to set
- // the lock in the desired mode, try it, and release it.
public:
+ /**
+ * Default constructor. The naming service must be initialized
+ * before calling this method. The mode is the mode of the lock to
+ * be tested.
+ */
Test_Single_Lock_With_Mode (CC_naming_service *naming_service,
CosConcurrencyControl::lock_mode mode);
- // Default constructor. The naming service must be initialized
- // before calling this method. The mode is the mode of the lock to
- // be tested.
+ /// Destructor
virtual ~Test_Single_Lock_With_Mode (void);
- // Destructor
+ /// Runs the test the specified number of times.
virtual int run (int times_to_run = 1);
- // Runs the test the specified number of times.
private:
+ /// The lock mode of the lock being tested
CosConcurrencyControl::lock_mode mode_;
- // The lock mode of the lock being tested
};
+/**
+ * @class Test_Setup_LockSet
+ *
+ * @brief This class creates a read lock, registeres it with the naming
+ * service and locks it.
+ */
class Test_Setup_LockSet : public CC_Test
{
- // = TITLE
- // This class creates a read lock, registeres it with the naming
- // service and locks it.
public:
+ /**
+ * Default constructor. The naming service must be initialized
+ * before calling this method. The name is the name the lock will be
+ * registered under in the naming service.
+ */
Test_Setup_LockSet (CC_naming_service *naming_service_,
char *name);
- // Default constructor. The naming service must be initialized
- // before calling this method. The name is the name the lock will be
- // registered under in the naming service.
+ /// Destructor
virtual ~Test_Setup_LockSet (void);
- // Destructor
+ /// Runs the test the specified number of times.
virtual int run (int times_to_run = 1);
- // Runs the test the specified number of times.
private:
+ /// The name of the lock
char *my_name_;
- // The name of the lock
};
+/**
+ * @class Test_Use_Already_Created_LockSet
+ *
+ * @brief This class looks up the lock in the naming service and locks
+ * it.
+ */
class Test_Use_Already_Created_LockSet : public CC_Test
{
- // = TITLE
- // This class looks up the lock in the naming service and locks
- // it.
public:
+ /**
+ * Default constructor. The naming service must be initialized
+ * before calling this method. The name is the name the lock will be
+ * looked up under in the naming service.
+ */
Test_Use_Already_Created_LockSet (CC_naming_service *naming_service_,
char *name);
- // Default constructor. The naming service must be initialized
- // before calling this method. The name is the name the lock will be
- // looked up under in the naming service.
+ /// Destructor
virtual ~Test_Use_Already_Created_LockSet (void);
- // Destructor
+ /// Runs the test the specified number of times.
virtual int run (int times_to_run = 1);
- // Runs the test the specified number of times.
private:
+ /// The name of the lock
char *my_name_;
- // The name of the lock
};
+/**
+ * @class Test_Unlock_Already_Created_LockSet
+ *
+ * @brief This class looks up the lock in the naming service and unlocks
+ * it.
+ */
class Test_Unlock_Already_Created_LockSet : public CC_Test
{
- // = TITLE
- // This class looks up the lock in the naming service and unlocks
- // it.
public:
+ /**
+ * Default constructor. The naming service must be initialized
+ * before calling this method. The name is the name the lock will be
+ * looked up under in the naming service.
+ */
Test_Unlock_Already_Created_LockSet (CC_naming_service *naming_service_,
char *name);
- // Default constructor. The naming service must be initialized
- // before calling this method. The name is the name the lock will be
- // looked up under in the naming service.
+ /// Destructor
virtual ~Test_Unlock_Already_Created_LockSet (void);
- // Destructor
+ /// Runs the test the specified number of times.
virtual int run (int times_to_run = 1);
- // Runs the test the specified number of times.
private:
+ /// The name of the lock
char *my_name_;
- // The name of the lock
};
+/**
+ * @class Test_Release_Not_Held_Lock
+ *
+ * @brief This class tests that the LockNotHeld exception is thrown if a
+ * not held lock is released.
+ */
class Test_Release_Not_Held_Lock : public CC_Test
{
- // = TITLE
- // This class tests that the LockNotHeld exception is thrown if a
- // not held lock is released.
public:
+ /// Default constructor. The naming service must be initialized
+ /// before calling this method. The mode is the mode of the lock
Test_Release_Not_Held_Lock (CC_naming_service *naming_service_,
CosConcurrencyControl::lock_mode mode_);
- // Default constructor. The naming service must be initialized
- // before calling this method. The mode is the mode of the lock
+ /// Destructor
virtual ~Test_Release_Not_Held_Lock (void);
- // Destructor
+ /// Runs the test the specified number of times.
virtual int run (int times_to_run = 1);
- // Runs the test the specified number of times.
private:
+ /// The lock mode of the lock being tested
CosConcurrencyControl::lock_mode mode_;
- // The lock mode of the lock being tested
};
#endif /* !defined (_CC_TESTS_H_) */
diff --git a/TAO/orbsvcs/tests/Concurrency/lex.CC_command.cpp b/TAO/orbsvcs/tests/Concurrency/lex.CC_command.cpp
index b70ca157c86..3faa77a29f1 100644
--- a/TAO/orbsvcs/tests/Concurrency/lex.CC_command.cpp
+++ b/TAO/orbsvcs/tests/Concurrency/lex.CC_command.cpp
@@ -1,4 +1,3 @@
-// $Id$
/* A lexical scanner generated by flex */
/* Scanner skeleton version:
@@ -440,22 +439,18 @@ static char *ace_cc_yy_last_accepting_cpos;
#define ACE_CC_YY_RESTORE_ACE_CC_YY_MORE_OFFSET
char *ace_cc_yytext;
#define INITIAL 0
-/* $Id$
- * ============================================================================
+//=============================================================================
+/**
*
* = LIBRARY
* TAO/orbsvcs/tests
*
- * = FILENAME
- * CC_command.l
+ * This is the lex file for the concurrency service script language.
*
- * = DESCRIPTION
- * This is the lex file for the concurrency service script language.
*
- * = AUTHORS
- * Torben Worm <tworm@cs.wustl.edu>
- *
- * ============================================================================
+ */
+//=============================================================================
+
*/
#define ACE_CC_YY_NO_UNPUT 1
#define ACE_CC_YY_NO_INPUT 1
diff --git a/TAO/orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h b/TAO/orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h
index e0799f95255..6f731c8056f 100644
--- a/TAO/orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h
+++ b/TAO/orbsvcs/tests/CosEvent/Basic/MT_Disconnect.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Cos Event Channel tests
-//
-// = FILENAME
-// MT_Disconnect.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file MT_Disconnect.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CEC_MT_DISCONNECT_H
#define CEC_MT_DISCONNECT_H
@@ -27,23 +23,23 @@
class MTD_Task : public ACE_Task_Base
{
public:
+ /// Create the task...
MTD_Task (CosEventChannelAdmin::EventChannel_ptr ec,
int use_callbacks);
- // Create the task...
// = Check the ACE_Task_Base documentation.
int svc (void);
+ /// Run a single iteration of the test
void run_iteration (void);
- // Run a single iteration of the test
private:
+ /// The event channel used on the test
CosEventChannelAdmin::EventChannel_var event_channel;
- // The event channel used on the test
+ /// Does the event channel send any callback messages when a client
+ /// diconnects
int use_callbacks;
- // Does the event channel send any callback messages when a client
- // diconnects
};
#endif /* EC_DISCONNECT_H */
diff --git a/TAO/orbsvcs/tests/CosEvent/Basic/Random.h b/TAO/orbsvcs/tests/CosEvent/Basic/Random.h
index 8e67e20bdcd..9ce0d4363bf 100644
--- a/TAO/orbsvcs/tests/CosEvent/Basic/Random.h
+++ b/TAO/orbsvcs/tests/CosEvent/Basic/Random.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS COS Event Channel tests
-//
-// = FILENAME
-// Random.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Random.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_RANDOM_H
#define EC_RANDOM_H
@@ -41,8 +37,8 @@ class RND_Consumer
// = DESCRIPTION
//
public:
+ /// Constructor
RND_Consumer (RND_Driver *driver);
- // Constructor
void push (const CORBA::Any &event);
void disconnect_push_consumer (void);
@@ -51,14 +47,14 @@ public:
void disconnect (void);
protected:
+ /// The driver
RND_Driver *driver_;
- // The driver
+ /// The supplier.
CosEventChannelAdmin::ProxyPushSupplier_var proxy_;
- // The supplier.
+ /// Synch
TAO_SYNCH_MUTEX lock_;
- // Synch
};
inline
@@ -95,27 +91,27 @@ class RND_Supplier
// = DESCRIPTION
//
public:
+ /// Constructor
RND_Supplier (void);
- // Constructor
void connect (CosEventChannelAdmin::SupplierAdmin_ptr admin);
void disconnect (void);
+ /// Push a single event...
void push_new_event (void);
void push (CORBA::Any &event);
- // Push a single event...
virtual void disconnect_push_supplier (void);
+ /// Active method
virtual int svc (void);
- // Active method
private:
+ /// The supplier.
CosEventChannelAdmin::ProxyPushConsumer_var proxy_;
- // The supplier.
+ /// Synch
TAO_SYNCH_MUTEX lock_;
- // Synch
};
inline
@@ -130,37 +126,37 @@ class RND_Driver
public:
RND_Driver (void);
+ /// Run the test
int run (int argc, ACE_TCHAR *argv[]);
- // Run the test
+ /// The main timer has expired
void timer (const CORBA::Any &e);
- // The main timer has expired
+ /// One of the consumers has received an event
void event (const CORBA::Any &e);
- // One of the consumers has received an event
private:
RND_Driver (const RND_Driver &);
RND_Driver& operator= (const RND_Driver &);
private:
+ /// The supplier
RND_Supplier supplier_;
- // The supplier
+ /// Number of suppliers
int nsuppliers_;
- // Number of suppliers
+ /// The suppliers
RND_Supplier **suppliers_;
- // The suppliers
+ /// Number of consumers
int nconsumers_;
- // Number of consumers
+ /// The consumers
RND_Consumer **consumers_;
- // The consumers
+ /// Maximum recursion
int max_recursion_;
- // Maximum recursion
CosEventChannelAdmin::ConsumerAdmin_var consumer_admin_;
CosEventChannelAdmin::SupplierAdmin_var supplier_admin_;
diff --git a/TAO/orbsvcs/tests/CosEvent/lib/Counting_Consumer.h b/TAO/orbsvcs/tests/CosEvent/lib/Counting_Consumer.h
index e3d0304fc2e..491c3922606 100644
--- a/TAO/orbsvcs/tests/CosEvent/lib/Counting_Consumer.h
+++ b/TAO/orbsvcs/tests/CosEvent/lib/Counting_Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Cos Event Channel testsuite
-//
-// = FILENAME
-// Counting_Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Counting_Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CEC_COUNTING_CONSUMER_H
#define CEC_COUNTING_CONSUMER_H
@@ -27,87 +23,89 @@
#include "orbsvcs/CosEventChannelAdminC.h"
#include "ace/Task.h"
+/**
+ * @class CEC_Counting_Consumer
+ *
+ * @brief Simple consumer object to implement EC tests.
+ *
+ * This is a simple consumer that counts the events it receives.
+ */
class CEC_Test_Export CEC_Counting_Consumer : public POA_CosEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object to implement EC tests.
- //
- // = DESCRIPTION
- // This is a simple consumer that counts the events it receives.
- //
public:
+ /// Constructor
CEC_Counting_Consumer (const char* name);
- // Constructor
+ /// Simple connect/disconnect methods..
void connect (CosEventChannelAdmin::ConsumerAdmin_ptr consumer_admin);
void disconnect (void);
- // Simple connect/disconnect methods..
+ /// Print out an error message if the event count is too far from the
+ /// expected count.
void dump_results (int expected_count, int tolerance);
- // Print out an error message if the event count is too far from the
- // expected count.
// = The CosEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const CORBA::Any& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
+ /// Keep track of the number of events received.
CORBA::ULong event_count;
- // Keep track of the number of events received.
+ /// Keep track of the number of disconnect calls received.
CORBA::ULong disconnect_count;
- // Keep track of the number of disconnect calls received.
protected:
+ /// The proxy
CosEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
- // The proxy
+ /// The name
const char* name_;
- // The name
};
// ****************************************************************
+/**
+ * @class CEC_Pull_Counting_Consumer
+ *
+ * @brief Simple consumer object to implement EC tests.
+ *
+ * This is a simple consumer that counts the events it receives.
+ */
class CEC_Test_Export CEC_Pull_Counting_Consumer : public POA_CosEventComm::PullConsumer
{
- // = TITLE
- // Simple consumer object to implement EC tests.
- //
- // = DESCRIPTION
- // This is a simple consumer that counts the events it receives.
- //
public:
+ /// Constructor
CEC_Pull_Counting_Consumer (const char* name);
- // Constructor
+ /// Simple connect/disconnect methods..
void connect (CosEventChannelAdmin::ConsumerAdmin_ptr consumer_admin);
void disconnect (void);
- // Simple connect/disconnect methods..
+ /// Print out an error message if the event count is too far from the
+ /// expected count.
void dump_results (int expected_count, int tolerance);
- // Print out an error message if the event count is too far from the
- // expected count.
CORBA::Any *pull (void);
CORBA::Any *try_pull (CORBA::Boolean_out has_event);
// = The CosEventComm::PullConsumer methods
+ /// The skeleton methods.
virtual void disconnect_pull_consumer (void);
- // The skeleton methods.
+ /// Keep track of the number of events received.
CORBA::ULong event_count;
- // Keep track of the number of events received.
+ /// Keep track of the number of disconnect calls received.
CORBA::ULong disconnect_count;
- // Keep track of the number of disconnect calls received.
protected:
+ /// The proxy
CosEventChannelAdmin::ProxyPullSupplier_var supplier_proxy_;
- // The proxy
+ /// The name
const char* name_;
- // The name
};
// ****************************************************************
@@ -115,9 +113,9 @@ protected:
class CEC_Test_Export CEC_Counting_Consumer_Task : public ACE_Task_Base
{
public:
+ /// Create the task...
CEC_Counting_Consumer_Task (CEC_Pull_Counting_Consumer *consumer,
int milliseconds = 0);
- // Create the task...
// = Check the ACE_Task_Base documentation.
int svc (void);
@@ -125,22 +123,22 @@ public:
void stop (void);
CORBA::ULong pull_count (void);
+ /// Run a single iteration of the test
void run (void);
- // Run a single iteration of the test
private:
+ /// The consumer we are turning into an active object
CEC_Pull_Counting_Consumer *consumer_;
- // The consumer we are turning into an active object
+ /// Set to 1 when the test must stop
int stop_flag_;
- // Set to 1 when the test must stop
+ /// Count the number of pull() calls
CORBA::ULong pull_count_;
- // Count the number of pull() calls
+ /// If not zero then pause for <milliseconds> before sending each
+ /// event.
int milliseconds_;
- // If not zero then pause for <milliseconds> before sending each
- // event.
TAO_SYNCH_MUTEX lock_;
};
diff --git a/TAO/orbsvcs/tests/CosEvent/lib/Counting_Supplier.h b/TAO/orbsvcs/tests/CosEvent/lib/Counting_Supplier.h
index 2ff59be1e18..6de571b7409 100644
--- a/TAO/orbsvcs/tests/CosEvent/lib/Counting_Supplier.h
+++ b/TAO/orbsvcs/tests/CosEvent/lib/Counting_Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Cos Event Channel testsuite
-//
-// = FILENAME
-// Counting_Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Counting_Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CEC_COUNTING_SUPPLIER_H
#define CEC_COUNTING_SUPPLIER_H
@@ -27,47 +23,48 @@
#include "orbsvcs/CosEventChannelAdminC.h"
#include "ace/Task.h"
+/**
+ * @class CEC_Counting_Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ */
class CEC_Test_Export CEC_Counting_Supplier : public POA_CosEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- //
public:
+ /// Constructor
CEC_Counting_Supplier (void);
- // Constructor
// = The CosEventComm::PushSupplier methods
+ /// Simple connect/disconnect methods..
void connect (CosEventChannelAdmin::SupplierAdmin_ptr supplier_admin);
void disconnect (void);
- // Simple connect/disconnect methods..
+ /// Push an event.
void push (const CORBA::Any& events);
- // Push an event.
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
+ /// Count the number of events sent
CORBA::ULong event_count;
- // Count the number of events sent
+ /// Count the number of disconnect_push_supplier calls
CORBA::ULong disconnect_count;
- // Count the number of disconnect_push_supplier calls
private:
+ /// Our proxy
CosEventChannelAdmin::ProxyPushConsumer_var consumer_proxy_;
- // Our proxy
};
class CEC_Test_Export CEC_Counting_Supplier_Task : public ACE_Task_Base
{
public:
+ /// Create the task...
CEC_Counting_Supplier_Task (CEC_Counting_Supplier *supplier,
int milliseconds = 0);
- // Create the task...
// = Check the ACE_Task_Base documentation.
int svc (void);
@@ -75,60 +72,61 @@ public:
void stop (void);
CORBA::ULong push_count (void);
+ /// Run a single iteration of the test
void run (void);
- // Run a single iteration of the test
private:
+ /// The supplier we are turning into an active object
CEC_Counting_Supplier *supplier_;
- // The supplier we are turning into an active object
+ /// Set to 1 when the test must stop
int stop_flag_;
- // Set to 1 when the test must stop
+ /// Count the number of push() calls
CORBA::ULong push_count_;
- // Count the number of push() calls
+ /// If not zero then pause for <milliseconds> before sending each
+ /// event.
int milliseconds_;
- // If not zero then pause for <milliseconds> before sending each
- // event.
TAO_SYNCH_MUTEX lock_;
};
// ****************************************************************
+/**
+ * @class CEC_Pull_Counting_Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ */
class CEC_Test_Export CEC_Pull_Counting_Supplier : public POA_CosEventComm::PullSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- //
public:
+ /// Constructor
CEC_Pull_Counting_Supplier (void);
- // Constructor
// = The CosEventComm::PullSupplier methods
+ /// Simple connect/disconnect methods..
void connect (CosEventChannelAdmin::SupplierAdmin_ptr supplier_admin);
void disconnect (void);
- // Simple connect/disconnect methods..
// The PullSupplier methods.
CORBA::Any* pull (void);
CORBA::Any* try_pull (CORBA::Boolean_out has_event);
virtual void disconnect_pull_supplier (void);
+ /// Count the number of events sent
CORBA::ULong event_count;
- // Count the number of events sent
+ /// Count the number of disconnect_pull_supplier calls
CORBA::ULong disconnect_count;
- // Count the number of disconnect_pull_supplier calls
private:
+ /// Our proxy
CosEventChannelAdmin::ProxyPullConsumer_var consumer_proxy_;
- // Our proxy
};
#endif /* ECT_SUPPLIER_H */
diff --git a/TAO/orbsvcs/tests/Event/Performance/Connect.h b/TAO/orbsvcs/tests/Event/Performance/Connect.h
index 1e78e417819..98f9714a2a5 100644
--- a/TAO/orbsvcs/tests/Event/Performance/Connect.h
+++ b/TAO/orbsvcs/tests/Event/Performance/Connect.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Connect
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Connect
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_CONNECT_H
#define EC_CONNECT_H
@@ -24,35 +20,35 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_Connect
+ *
+ * @brief Test the EC connection feature
+ *
+ * The EC can be configured to allow re-connection of suppliers
+ * and consumers, this test verifies that:
+ * + The EC does *not* allow connections if the feature is
+ * disabled (the default)
+ * + The EC does allow connections if the feature is enabled
+ * and:
+ * - There are no memory leaks
+ * - Compares the time required for a connection vs a complete
+ * connect/disconnect cycle, specially as the number of
+ * suppliers and consumers increases.
+ */
class EC_Connect : public EC_Driver
{
- //
- // = TITLE
- // Test the EC connection feature
- //
- // = DESCRIPTION
- // The EC can be configured to allow re-connection of suppliers
- // and consumers, this test verifies that:
- // + The EC does *not* allow connections if the feature is
- // disabled (the default)
- // + The EC does allow connections if the feature is enabled
- // and:
- // - There are no memory leaks
- // - Compares the time required for a connection vs a complete
- // connect/disconnect cycle, specially as the number of
- // suppliers and consumers increases.
- //
public:
+ /// Constructor
EC_Connect (void);
- // Constructor
// = The EC_Driver methods
virtual int parse_args (int& argc, ACE_TCHAR* argv[]);
virtual void print_usage (void);
virtual void print_args (void) const;
+ /// Don't run the suppliers, just test connect and disconnect calls.
void execute_test (void);
- // Don't run the suppliers, just test connect and disconnect calls.
virtual void dump_results (void);
@@ -78,8 +74,8 @@ private:
ACE_Throughput_Stats consumer_disconnect_;
ACE_Throughput_Stats supplier_disconnect_;
+ /// What is connected first?
int order_;
- // What is connected first?
};
// ****************************************************************
diff --git a/TAO/orbsvcs/tests/Event/Performance/Inversion.h b/TAO/orbsvcs/tests/Event/Performance/Inversion.h
index c73eb43bbc8..cb9bced0428 100644
--- a/TAO/orbsvcs/tests/Event/Performance/Inversion.h
+++ b/TAO/orbsvcs/tests/Event/Performance/Inversion.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Inversion
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Inversion
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_INVERSION_H
#define EC_INVERSION_H
@@ -23,38 +19,42 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_Inversion
+ *
+ * @brief Measure priority inversions in the EC.
+ *
+ */
class EC_Inversion : public EC_Driver
{
- //
- // = TITLE
- // Measure priority inversions in the EC.
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
EC_Inversion (void);
- // Constructor
// = The EC_Driver methods
+ /**
+ * Parse the arguments, but override the number of consumers.
+ * The options controlling the event types are ignored, and only two
+ * consumers are created.
+ */
int parse_args (int &argc, ACE_TCHAR *argv[]);
- // Parse the arguments, but override the number of consumers.
- // The options controlling the event types are ignored, and only two
- // consumers are created.
+ /**
+ * In this test there are two consumers, the high priority consumer
+ * receives only events from a single high priority supplier. The
+ * other consumer receives events from a set of low priority
+ * suppliers.
+ */
virtual void connect_consumers (void);
virtual void connect_suppliers (void);
- // In this test there are two consumers, the high priority consumer
- // receives only events from a single high priority supplier. The
- // other consumer receives events from a set of low priority
- // suppliers.
+ /// Activate the suppliers at different priorities
virtual void activate_tasks (void);
- // Activate the suppliers at different priorities
private:
+ /// If set then both low priority and high priority suppliers
+ /// generate the same events.
int same_events_;
- // If set then both low priority and high priority suppliers
- // generate the same events.
};
#endif /* EC_INVERSION_H */
diff --git a/TAO/orbsvcs/tests/Event/Performance/Latency.h b/TAO/orbsvcs/tests/Event/Performance/Latency.h
index f09e9ad531e..0f26ddf2803 100644
--- a/TAO/orbsvcs/tests/Event/Performance/Latency.h
+++ b/TAO/orbsvcs/tests/Event/Performance/Latency.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Latency
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Latency
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_LATENCY_H
#define EC_LATENCY_H
diff --git a/TAO/orbsvcs/tests/Event/Performance/Throughput.h b/TAO/orbsvcs/tests/Event/Performance/Throughput.h
index 20b5bc63fcf..b4951f642fa 100644
--- a/TAO/orbsvcs/tests/Event/Performance/Throughput.h
+++ b/TAO/orbsvcs/tests/Event/Performance/Throughput.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Throughput
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Throughput
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_THROUGHPUT_H
#define EC_THROUGHPUT_H
@@ -23,32 +19,32 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_Throughput
+ *
+ * @brief Test the EC throughput
+ *
+ */
class EC_Throughput : public EC_Driver
{
- //
- // = TITLE
- // Test the EC throughput
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
EC_Throughput (void);
- // Constructor
// = The EC_Driver methods
+ /// add some command line args to enable/disable throughputions
virtual int parse_args (int& argc, ACE_TCHAR* argv[]);
virtual void print_args (void) const;
virtual void print_usage (void);
- // add some command line args to enable/disable throughputions
+ /// set the throughpution flags
virtual void modify_attributes (TAO_EC_Event_Channel_Attributes& attr);
- // set the throughpution flags
+ /// Don't run the suppliers, just test connect and disconnect calls.
void execute_test (void);
- // Don't run the suppliers, just test connect and disconnect calls.
+ /// Don't dump the EC_Driver results, they are meaningless.
void dump_results (void);
- // Don't dump the EC_Driver results, they are meaningless.
private:
};
diff --git a/TAO/orbsvcs/tests/Event/UDP/AddrServer.h b/TAO/orbsvcs/tests/Event/UDP/AddrServer.h
index 2df463629ac..858490055fb 100644
--- a/TAO/orbsvcs/tests/Event/UDP/AddrServer.h
+++ b/TAO/orbsvcs/tests/Event/UDP/AddrServer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef ADDRSERVER_H
#define ADDRSERVER_H
@@ -21,23 +17,24 @@
#include "orbsvcs/RtecUDPAdminS.h"
#include "ace/INET_Addr.h"
+/**
+ * @class AddrServer
+ *
+ * @brief A simple AddrServer
+ *
+ * The EC is able to use multiple multicast groups to transmit its
+ * data, the is given control over the mapping between the Event
+ * (type,source) pair and the (ipaddr,port) pair using a
+ * AddrServer.
+ * This class implements a very simple server that simply maps the
+ * <type> component to the <ipaddr> and uses a fixed <port>,
+ * provided at initialization time.
+ */
class AddrServer : public POA_RtecUDPAdmin::AddrServer
{
- // = TITLE
- // A simple AddrServer
- //
- // = DESCRIPTION
- // The EC is able to use multiple multicast groups to transmit its
- // data, the is given control over the mapping between the Event
- // (type,source) pair and the (ipaddr,port) pair using a
- // AddrServer.
- // This class implements a very simple server that simply maps the
- // <type> component to the <ipaddr> and uses a fixed <port>,
- // provided at initialization time.
- //
public:
+ /// Constructor
AddrServer (const ACE_INET_Addr& addr);
- // Constructor
// = The RtecUDPAdmin::AddrServer methods
virtual void get_addr (const RtecEventComm::EventHeader& header,
@@ -48,8 +45,8 @@ public:
private:
+ /// The address
ACE_INET_Addr addr_;
- // The address
};
#include /**/ "ace/post.h"
diff --git a/TAO/orbsvcs/tests/Event/UDP/Consumer.h b/TAO/orbsvcs/tests/Event/UDP/Consumer.h
index e805bbb8236..d6e505167d0 100644
--- a/TAO/orbsvcs/tests/Event/UDP/Consumer.h
+++ b/TAO/orbsvcs/tests/Event/UDP/Consumer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Consumer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Consumer
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef CONSUMER_H
#define CONSUMER_H
@@ -24,38 +20,39 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ * This class is a consumer of events.
+ * It simply subscribes to one event type.
+ */
class Consumer : public POA_RtecEventComm::PushConsumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- // This class is a consumer of events.
- // It simply subscribes to one event type.
- //
public:
+ /// Constructor
Consumer (bool valuetype);
- // Constructor
+ /// Connect to the Event Channel
void connect (RtecEventChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect to the Event Channel
+ /// Disconnect from the event channel
void disconnect (void);
- // Disconnect from the event channel
// = The RtecEventComm::PushConsumer methods
+ /// The skeleton methods.
virtual void push (const RtecEventComm::EventSet& events);
virtual void disconnect_push_consumer (void);
- // The skeleton methods.
CORBA::ULong event_count (void) const;
private:
+ /// Keep track of the number of events received.
CORBA::ULong event_count_;
- // Keep track of the number of events received.
+ /// The proxy
RtecEventChannelAdmin::ProxyPushSupplier_var proxy_;
- // The proxy
bool valuetype_;
};
diff --git a/TAO/orbsvcs/tests/Event/UDP/Supplier.h b/TAO/orbsvcs/tests/Event/UDP/Supplier.h
index 52c17eb22f9..a2460d8d1fc 100644
--- a/TAO/orbsvcs/tests/Event/UDP/Supplier.h
+++ b/TAO/orbsvcs/tests/Event/UDP/Supplier.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel examples
-//
-// = FILENAME
-// Supplier
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Supplier
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef SUPPLIER_H
#define SUPPLIER_H
@@ -25,39 +21,40 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Supplier
+ *
+ * @brief Simple supplier object
+ *
+ * This class is a supplier of events.
+ * It simply publishes one event type, when the perform_push()
+ * method is invoked it pushes the event through the event service
+ */
class Supplier : public POA_RtecEventComm::PushSupplier
{
- // = TITLE
- // Simple supplier object
- //
- // = DESCRIPTION
- // This class is a supplier of events.
- // It simply publishes one event type, when the perform_push()
- // method is invoked it pushes the event through the event service
- //
public:
+ /// Constructor
Supplier (bool valuetype);
- // Constructor
+ /// Connect to the event channel
void connect (RtecEventChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect to the event channel
+ /// Disconnect from the event channel
void disconnect (void);
- // Disconnect from the event channel
+ /// Push a single event
void perform_push (void);
- // Push a single event
// = The RtecEventComm::PushSupplier methods
+ /// The skeleton methods.
virtual void disconnect_push_supplier (void);
- // The skeleton methods.
private:
void insert_into_any (CORBA::Any& any, Components::EventBase* vb);
+ /// The proxy
RtecEventChannelAdmin::ProxyPushConsumer_var proxy_;
- // The proxy
bool valuetype_;
diff --git a/TAO/orbsvcs/tests/FaultTolerance/IOGR/Client_i.h b/TAO/orbsvcs/tests/FaultTolerance/IOGR/Client_i.h
index 5b95112cdf1..38db7554b84 100644
--- a/TAO/orbsvcs/tests/FaultTolerance/IOGR/Client_i.h
+++ b/TAO/orbsvcs/tests/FaultTolerance/IOGR/Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// test
-//
-// = FILENAME
-// Client_i.h
-//
-// = DESCRIPTION
-// A helper class for the client
-//
-// = AUTHOR
-// Bala Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Client_i.h
+ *
+ * $Id$
+ *
+ * A helper class for the client
+ *
+ *
+ * @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TEST_FT_IOGR_CLIENT_I_H
#define TEST_FT_IOGR_CLIENT_I_H
@@ -30,11 +27,11 @@
class Client_i
{
public:
+ /// Our constructor
Client_i (CORBA::ORB_ptr orb);
- // Our constructor
+ /// Initialize the ORB etc.
void init (void);
- // Initialize the ORB etc.
private:
CORBA::ORB_var orb_;
diff --git a/TAO/orbsvcs/tests/FaultTolerance/IOGR/Manager.h b/TAO/orbsvcs/tests/FaultTolerance/IOGR/Manager.h
index b674782986f..e46b0ad131e 100644
--- a/TAO/orbsvcs/tests/FaultTolerance/IOGR/Manager.h
+++ b/TAO/orbsvcs/tests/FaultTolerance/IOGR/Manager.h
@@ -1,22 +1,18 @@
-//$Id$
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// test
-//
-// = FILENAME
-// Manager.h
-//
-// = DESCRIPTION
-// A manager class that merger IORS and designates primary
-//
-// = AUTHOR
-// Bala Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Manager.h
+ *
+ * $Id$
+ *
+ * A manager class that merger IORS and designates primary
+ *
+ *
+ * @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TEST_FT_IOGR_MANAGER_H
#define TEST_FT_IOGR_MANAGER_H
@@ -36,29 +32,29 @@ public:
// Initialize the ORB, POA etc.
+ /// Merges the different IORS
int make_merged_iors (void);
- // Merges the different IORS
+ /// Sets the properties for the profiles
int set_properties (void);
- // Sets the properties for the profiles
+ /// Run the ORB event loop..
int run (void);
- // Run the ORB event loop..
+ /// Write the merged IOR to a file
int write_to_file (void);
- // Write the merged IOR to a file
+ /// Return the pointer to the copy of our ORB
CORBA::ORB_ptr orb (void);
- // Return the pointer to the copy of our ORB
private:
CORBA::Object_var object_primary_;
CORBA::Object_var object_secondary_;
+ /// The merged IOR set
CORBA::Object_var merged_set_;
- // The merged IOR set
+ /// Our ORB
CORBA::ORB_var orb_;
- // Our ORB
};
#endif /*TEST_FT_IOGR_MANAGER_H */
diff --git a/TAO/orbsvcs/tests/FaultTolerance/IOGR/test_i.h b/TAO/orbsvcs/tests/FaultTolerance/IOGR/test_i.h
index 47adea6b740..43c11edfb1e 100644
--- a/TAO/orbsvcs/tests/FaultTolerance/IOGR/test_i.h
+++ b/TAO/orbsvcs/tests/FaultTolerance/IOGR/test_i.h
@@ -1,37 +1,35 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/FaultTolerance/IOGR
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Bala Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_FT_IOGR_TEST_I_H
#define TAO_FT_IOGR_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
+ /// ctor
Simple_Server_i (void);
- // ctor
// = The Simple_Server methods.
void remote_call (void);
diff --git a/TAO/orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp b/TAO/orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp
index 098defd0b3d..29d8bf5eead 100644
--- a/TAO/orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp
+++ b/TAO/orbsvcs/tests/FaultTolerance/IOGRManipulation/IOGRTest.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// tests/FaultTolerance/IOGRManipulation
-//
-//
-// = FILENAME
-// IOGRTest.cpp
-//
-// = DESCRIPTION
-// This program tests the basic functionality FT IOGR implementation
-//
-// = AUTHOR
-// Bala Natarajan <bala@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file IOGRTest.cpp
+ *
+ * $Id$
+ *
+ * This program tests the basic functionality FT IOGR implementation
+ *
+ *
+ * @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "orbsvcs/FT_CORBA_ORBC.h"
diff --git a/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp b/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp
index 0921e592646..ea0980fbae4 100644
--- a/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp
+++ b/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI
-//
-// = FILENAME
-// ami_test_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the AMI Test interface.
-//
-// = AUTHOR
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>,
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ami_test_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the AMI Test interface.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ami_test_i.h"
#include "tao/debug.h"
diff --git a/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.h b/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.h
index edc62b03212..c68c30c50c8 100644
--- a/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.h
+++ b/TAO/orbsvcs/tests/HTIOP/AMI/ami_test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI
-//
-// = FILENAME
-// ami_test_i.h
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ami_test_i.h
+ *
+ * $Id$
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef TAO_AMI_TEST_I_H
#define TAO_AMI_TEST_I_H
#include "ami_testS.h"
+/**
+ * @class AMI_Test_i
+ *
+ * @brief AMI Test implementation
+ *
+ * Implements the AMI_Test interface in test.idl
+ */
class AMI_Test_i : public POA_A::AMI_Test
{
- // = TITLE
- // AMI Test implementation
- //
- // = DESCRIPTION
- // Implements the AMI_Test interface in test.idl
- //
public:
+ /// ctor
AMI_Test_i (CORBA::ORB_ptr orb);
- // ctor
// The AMI_Test methods.
CORBA::Long foo (CORBA::Long_out out_l,
diff --git a/TAO/orbsvcs/tests/HTIOP/AMI/client.cpp b/TAO/orbsvcs/tests/HTIOP/AMI/client.cpp
index e6bd072225e..5cae851dead 100644
--- a/TAO/orbsvcs/tests/HTIOP/AMI/client.cpp
+++ b/TAO/orbsvcs/tests/HTIOP/AMI/client.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// A client which uses the AMI callback model.
-//
-// = AUTHOR
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>,
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * A client which uses the AMI callback model.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/OS_NS_sys_socket.h"
#include "ace/Get_Opt.h"
@@ -68,30 +65,31 @@ parse_args (int argc, ACE_TCHAR *argv[])
return 0;
}
+/**
+ * @class Client
+ *
+ * @brief Run the client thread
+ *
+ * Use the ACE_Task_Base class to run the client threads.
+ */
class Client : public ACE_Task_Base
{
- // = TITLE
- // Run the client thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run the client threads.
- //
public:
+ /// ctor
Client (A::AMI_Test_ptr server, int niterations);
- // ctor
+ /// The thread entry point.
virtual int svc (void);
- // The thread entry point.
// private:
+ /// Var for the AMI_Test object.
A::AMI_Test_var ami_test_var_;
- // Var for the AMI_Test object.
+ /// The number of iterations on each client thread.
int niterations_;
- // The number of iterations on each client thread.
+ /// Var for AMI_AMI_Test_ReplyHandler object.
A::AMI_AMI_TestHandler_var the_handler_var_;
- // Var for AMI_AMI_Test_ReplyHandler object.
};
class Handler : public POA_A::AMI_AMI_TestHandler
diff --git a/TAO/orbsvcs/tests/HTIOP/AMI/server.cpp b/TAO/orbsvcs/tests/HTIOP/AMI/server.cpp
index ed61ac331b0..c3f615b3802 100644
--- a/TAO/orbsvcs/tests/HTIOP/AMI/server.cpp
+++ b/TAO/orbsvcs/tests/HTIOP/AMI/server.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Implementation of the server.
-//
-// = AUTHOR
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>,
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the server.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ami_test_i.h"
diff --git a/TAO/orbsvcs/tests/HTIOP/AMI/simple_client.cpp b/TAO/orbsvcs/tests/HTIOP/AMI/simple_client.cpp
index f23e01904c2..8d23e53976b 100644
--- a/TAO/orbsvcs/tests/HTIOP/AMI/simple_client.cpp
+++ b/TAO/orbsvcs/tests/HTIOP/AMI/simple_client.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI
-//
-// = FILENAME
-// simple_client.cpp
-//
-// = DESCRIPTION
-// A very simple client which uses the AMI callback model.
-//
-// = AUTHOR
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>,
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file simple_client.cpp
+ *
+ * $Id$
+ *
+ * A very simple client which uses the AMI callback model.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "../test_config.h"
@@ -72,11 +69,11 @@ parse_args (int argc, ACE_TCHAR *argv[])
class Handler : public POA_A::AMI_AMI_TestHandler
{
public:
+ /// Constructor.
Handler (void) {};
- // Constructor.
+ /// Destructor.
~Handler (void) {};
- // Destructor.
void foo (CORBA::Long ami_return_val,
CORBA::Long out_l)
diff --git a/TAO/orbsvcs/tests/HTIOP/BiDirectional/test_i.h b/TAO/orbsvcs/tests/HTIOP/BiDirectional/test_i.h
index cc4725dc141..3914ef78a3e 100644
--- a/TAO/orbsvcs/tests/HTIOP/BiDirectional/test_i.h
+++ b/TAO/orbsvcs/tests/HTIOP/BiDirectional/test_i.h
@@ -1,59 +1,58 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
#include "testS.h"
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// Safe way to shutdown
void shutdown (void);
- // Safe way to shutdown
+ /// The callback method
void callback_method (void);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @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, int no_iterations);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback);
@@ -65,17 +64,17 @@ public:
int call_client (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Callback_var callback_;
- // Callback Object
+ /// Number of times the callback needs to be called
int no_iterations_;
- // Number of times the callback needs to be called
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h b/TAO/orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h
index 16f3ebafd93..d11a20d1309 100644
--- a/TAO/orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h
+++ b/TAO/orbsvcs/tests/InterfaceRepo/IDL3_Test/idl3_client.h
@@ -1,53 +1,52 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/InterfaceRepo
-//
-// = FILENAME
-// idl3_client.h
-//
-// = DESCRIPTION
-// This class tests the IFR support for CCM-related types.
-//
-// = AUTHOR
-// Jeff Parsons <j.parsons@vanderbilt.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file idl3_client.h
+ *
+ * $Id$
+ *
+ * This class tests the IFR support for CCM-related types.
+ *
+ *
+ * @author Jeff Parsons <j.parsons@vanderbilt.edu>
+ */
+//=============================================================================
+
#ifndef IDL3_CLIENT_H
#define IDL3_CLIENT_H
#include "tao/IFR_Client/IFR_ComponentsC.h"
+/**
+ * @class IDL3_Client
+ *
+ * @brief Component-aware IFR Client Implementation
+ *
+ * Class wrapper for a client which tests the Interface Repository
+ * support for the OMG IDL3 extensions.
+ */
class IDL3_Client
{
- // = TITLE
- // Component-aware IFR Client Implementation
- //
- // = DESCRIPTION
- // Class wrapper for a client which tests the Interface Repository
- // support for the OMG IDL3 extensions.
public:
+ /// Constructor
IDL3_Client (void);
- // Constructor
+ /// Destructor
~IDL3_Client (void);
- // Destructor
+ /// Initialize the ORB and get the IFR object reference.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the ORB and get the IFR object reference.
+ /// Execute test code.
int run (void);
- // Execute test code.
private:
+ /// Process the command line arguments.
int parse_args (int argc,
ACE_TCHAR *argv[]);
- // Process the command line arguments.
int component_test (void);
int home_test (void);
@@ -104,14 +103,14 @@ private:
int home_finder_test (CORBA::ComponentIR::HomeDescription *);
private:
+ /// Flag to output detailed error messages.
bool debug_;
- // Flag to output detailed error messages.
+ /// Storage of the ORB reference.
CORBA::ORB_var orb_;
- // Storage of the ORB reference.
+ /// Storage of the IFR reference.
CORBA::Repository_var repo_;
- // Storage of the IFR reference.
};
#endif /* IDL3_CLIENT_H */
diff --git a/TAO/orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h b/TAO/orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h
index a550a1a9809..882e2ca3242 100644
--- a/TAO/orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h
+++ b/TAO/orbsvcs/tests/InterfaceRepo/IFR_Test/Admin_Client.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/InterfaceRepo
-//
-// = FILENAME
-// Admin_Client.h
-//
-// = DESCRIPTION
-// This class tests the functionality of the IFR methods by inserting
-// IR objects into the repository by hand, querying them, moving them,
-// and destroying them.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Admin_Client.h
+ *
+ * $Id$
+ *
+ * This class tests the functionality of the IFR methods by inserting
+ * IR objects into the repository by hand, querying them, moving them,
+ * and destroying them.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#if !defined (ADMIN_CLIENT_H)
#define ADMIN_CLIENT_H
@@ -27,29 +24,32 @@
const CORBA::ULong NUMBER_OF_TESTS = 11;
+/**
+ * @class Admin_Client
+ *
+ * @brief Administrating IFR Client Implementation
+ *
+ * Class wrapper for a client which puts the Interface Repository
+ * methods through their paces.
+ */
class Admin_Client
{
- // = TITLE
- // Administrating IFR Client Implementation
- //
- // = DESCRIPTION
- // Class wrapper for a client which puts the Interface Repository
- // methods through their paces.
public:
+ /// Constructor
Admin_Client (void);
- // Constructor
+ /// Destructor
~Admin_Client (void);
- // Destructor
+ /// Initialize the ORB and get the IFR object reference.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the ORB and get the IFR object reference.
+ /// Execute test code.
int run (void);
- // Execute test code.
private:
+ /// The various IFR tests.
void array_test (void);
void enum_test (void);
void alias_test (void);
@@ -61,35 +61,34 @@ private:
void interface_test (void);
void move_test (void);
void module_test (void);
- // The various IFR tests.
+ /// Process the command line arguments.
int parse_args (int argc,
ACE_TCHAR *argv[]);
- // Process the command line arguments.
+ /// Array of pointers to the test functions.
void (Admin_Client::*test_array_[NUMBER_OF_TESTS])(void);
- // Array of pointers to the test functions.
+ /// Array of test names used in selection of one test.
static const char *test_names_[];
- // Array of test names used in selection of one test.
+ /// Flag to output results of IFR queries.
CORBA::Boolean debug_;
- // Flag to output results of IFR queries.
+ /// Are we running all the tests or just one?
CORBA::Boolean all_tests_;
- // Are we running all the tests or just one?
+ /// Array index of the selected test function.
CORBA::ULong which_test_;
- // Array index of the selected test function.
+ /// # of times to run each test.
CORBA::ULong iterations_;
- // # of times to run each test.
+ /// Storage of the ORB reference.
CORBA::ORB_var orb_;
- // Storage of the ORB reference.
+ /// Storage of the IFR reference.
CORBA::Repository_var repo_;
- // Storage of the IFR reference.
};
#endif /* ADMIN_CLIENT_H */
diff --git a/TAO/orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h b/TAO/orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h
index 4e0c3bf6c4f..97c5eaa6b4e 100644
--- a/TAO/orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h
+++ b/TAO/orbsvcs/tests/InterfaceRepo/Latency_Test/Latency_Query_Client.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/InterfaceRepo
-//
-// = FILENAME
-// Latency_Query_Client.h
-//
-// = DESCRIPTION
-// This class tests the latency of queries made on the IFR.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@isis-server.isis.vanderbilt.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Latency_Query_Client.h
+ *
+ * $Id$
+ *
+ * This class tests the latency of queries made on the IFR.
+ *
+ *
+ * @author Jeff Parsons <parsons@isis-server.isis.vanderbilt.edu>
+ */
+//=============================================================================
+
#if !defined (LATENCY_QUERY_CLIENT_H)
#define LATENCY_QUERY_CLIENT_H
@@ -23,55 +20,57 @@
#include "tao/IFR_Client/IFR_BasicC.h"
#include "tao/ORB.h"
+/**
+ * @class Latency_Query_Client
+ *
+ * @brief Querying IFR Client Implementation
+ *
+ * Class wrapper for a client which queries the Interface Repository.
+ */
class Latency_Query_Client
{
- // = TITLE
- // Querying IFR Client Implementation
- //
- // = DESCRIPTION
- // Class wrapper for a client which queries the Interface Repository.
public:
+ /// Constructor
Latency_Query_Client (void);
- // Constructor
+ /// Destructor
~Latency_Query_Client (void);
- // Destructor
+ /// Initialize the ORB and get the IFR object reference.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the ORB and get the IFR object reference.
+ /// Execute test code.
int run (void);
- // Execute test code.
private:
+ /// Process the command line arguments.
int parse_args (int argc,
ACE_TCHAR *argv[]);
- // Process the command line arguments.
+ /// Put in something to query about.
int populate_ifr (void);
- // Put in something to query about.
private:
+ /// Toggle debugging output.
bool debug_;
- // Toggle debugging output.
+ /// Toggle saving of dump history.
bool do_dump_history_;
- // Toggle saving of dump history.
+ /// Number of queries in a run.
CORBA::ULong iterations_;
- // Number of queries in a run.
+ /// Storage of the ORB reference.
CORBA::ORB_var orb_;
- // Storage of the ORB reference.
+ /// Storage of the IFR reference.
CORBA::Repository_var repo_;
- // Storage of the IFR reference.
// CORBA::AliasDef_var tdef_;
// Storage of the typedef definition that we will query.
+ /// Storage of the attribute definition we will query.
CORBA::AttributeDef_var attr_;
- // Storage of the attribute definition we will query.
};
#endif /* LATENCY_QUERY_CLIENT_H */
diff --git a/TAO/orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h b/TAO/orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h
index 7c2477dbb1b..a8936af2dd0 100644
--- a/TAO/orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h
+++ b/TAO/orbsvcs/tests/InterfaceRepo/Persistence_Test/Ptest.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/InterfaceRepo
-//
-// = FILENAME
-// Ptest.h
-//
-// = DESCRIPTION
-// This code tests the persistence of the IFR by inserting
-// IR objects into the repository with one function, and querying the
-// repository with another, with a repository shutdown in between.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Ptest.h
+ *
+ * $Id$
+ *
+ * This code tests the persistence of the IFR by inserting
+ * IR objects into the repository with one function, and querying the
+ * repository with another, with a repository shutdown in between.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#if !defined (PTEST_H)
#define PTEST_H
@@ -25,50 +22,52 @@
#include "tao/IFR_Client/IFR_BasicC.h"
#include "tao/ORB.h"
+/**
+ * @class Ptest
+ *
+ * @brief IFR Persistence test Implementation
+ *
+ * Class wrapper for code which either populates or queries the
+ * Interface Repository. Designed to be used with a Perl script
+ * which can start and stop both this process and the repository
+ * process in the necessary order.
+ */
class Ptest
{
- // = TITLE
- // IFR Persistence test Implementation
- //
- // = DESCRIPTION
- // Class wrapper for code which either populates or queries the
- // Interface Repository. Designed to be used with a Perl script
- // which can start and stop both this process and the repository
- // process in the necessary order.
public:
+ /// Constructor
Ptest (void);
- // Constructor
+ /// Destructor
~Ptest (void);
- // Destructor
+ /// Initialize the ORB and get the IFR object reference.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the ORB and get the IFR object reference.
+ /// Execute test code.
int run (void);
- // Execute test code.
private:
+ /// The two IFR tests.
void populate (void);
int query (void);
- // The two IFR tests.
+ /// Process the command line arguments.
int parse_args (int argc,
ACE_TCHAR *argv[]);
- // Process the command line arguments.
+ /// Flag to output results of IFR queries.
CORBA::Boolean debug_;
- // Flag to output results of IFR queries.
+ /// Are we populating a new IFR or querying a persistent one?
CORBA::Boolean query_;
- // Are we populating a new IFR or querying a persistent one?
+ /// Storage of the ORB reference.
CORBA::ORB_var orb_;
- // Storage of the ORB reference.
+ /// Storage of the IFR reference.
CORBA::Repository_var repo_;
- // Storage of the IFR reference.
};
#endif /* PTEST_H */
diff --git a/TAO/orbsvcs/tests/Interoperable_Naming/client.cpp b/TAO/orbsvcs/tests/Interoperable_Naming/client.cpp
index b55b30aedb2..4d634bee99d 100644
--- a/TAO/orbsvcs/tests/Interoperable_Naming/client.cpp
+++ b/TAO/orbsvcs/tests/Interoperable_Naming/client.cpp
@@ -1,22 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Interoperable_Naming/
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This implements a simple CORBA client for the
-// CosNaming::NamingContextExt example
-//
-// = AUTHORS
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This implements a simple CORBA client for the
+ * CosNaming::NamingContextExt example
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "ncontextext_client_i.h"
diff --git a/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp b/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp
index e682b3a7ade..949beb9c17c 100644
--- a/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp
+++ b/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.cpp
@@ -1,23 +1,19 @@
-// $Id$
-//
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/ORBSVCS/tests/SimpleNaming
-//
-// = FILENAME
-// ncontextext_client_i.cpp
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client which
-// converts a Name to a string and viceversa, forms a IIOPNAME
-// url address and can resolve a stringified name.
-//
-// = AUTHORS
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//============================================================
+
+//=============================================================================
+/**
+ * @file ncontextext_client_i.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client which
+ * converts a Name to a string and viceversa, forms a IIOPNAME
+ * url address and can resolve a stringified name.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "ncontextext_client_i.h"
#include "tao/debug.h"
diff --git a/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h b/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h
index 7c3743c0230..b5c4c253a7e 100644
--- a/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h
+++ b/TAO/orbsvcs/tests/Interoperable_Naming/ncontextext_client_i.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/ORBSVCS/tests/SimpleNaming
-//
-// = FILENAME
-// ncontextext_client_i.h
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client which
-// converts a Name to a string and viceversa, forms a IIOPNAME
-// url address and can resolve a stringified name.
-//
-// = AUTHORS
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//============================================================
+
+//=============================================================================
+/**
+ * @file ncontextext_client_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client which
+ * converts a Name to a string and viceversa, forms a IIOPNAME
+ * url address and can resolve a stringified name.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#if !defined (NCONTEXTEXT_CLIENT_I_H)
@@ -26,55 +23,58 @@
#include "Web_ServerC.h"
#include "orbsvcs/CosNamingC.h"
+/**
+ * @class NContextExt_Client_i
+ *
+ * @brief NContextExt Client Implementation
+ *
+ */
class NContextExt_Client_i
{
- // = TITLE
- // NContextExt Client Implementation
- //
- // = DESCRIPTION
- //
public:
// = COnstructor and destructor.
NContextExt_Client_i (void);
~NContextExt_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:
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /**
+ * Prints the values of the original name, strigified name and
+ * destringified name. Also, prints the value of the address of the
+ * naming context, a name that identifies a binding in that naming
+ * context and the corresponding iioploc URL
+ * representation.
+ */
void print_values (CosNaming::Name name,
CORBA::String_var str_name,
CosNaming::Name nm,
CORBA::String_var obj_name,
CORBA::String_var url_string);
- // Prints the values of the original name, strigified name and
- // destringified name. Also, prints the value of the address of the
- // naming context, a name that identifies a binding in that naming
- // context and the corresponding iioploc URL
- // representation.
+ /// Generates a random name
char * get_name (void);
- // Generates a random name
+ /// # 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.
+ /// Naming context
CosNaming::NamingContextExt_var naming_context_;
- // Naming context
+ /// Flag to check if '-v' option is set.
CORBA::Boolean view_;
- // Flag to check if '-v' option is set.
};
diff --git a/TAO/orbsvcs/tests/Notify/Basic/AdminProperties.h b/TAO/orbsvcs/tests/Notify/Basic/AdminProperties.h
index 9a74a888f9c..d0fac5425c6 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/AdminProperties.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/AdminProperties.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// AdminProperties.h
-//
-// = DESCRIPTION
-// Test for EC Admin QoS properties.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file AdminProperties.h
+ *
+ * $Id$
+ *
+ * Test for EC Admin QoS properties.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef ADMINPROPERTIES
#define ADMINPROPERTIES
@@ -41,26 +41,27 @@ protected:
};
+/**
+ * @class AdminProperties_Task
+ *
+ * @brief Run a thread to dispatch events.
+ *
+ * Use the ACE_Task_Base class.
+ */
class AdminProperties_Task : public ACE_Task_Base
{
- // = TITLE
- // Run a thread to dispatch events.
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class.
- //
public:
+ /// Constructor.
AdminProperties_Task (void);
- // Constructor.
/// Init this object.
void init (TAO_Notify_Tests_StructuredPushSupplier *supplier, AdminProperties* client);
virtual int init (int argc, ACE_TCHAR *argv []);
+ /// The thread entry point.
virtual int svc (void);
- // The thread entry point.
private:
/// Supplier
@@ -72,18 +73,19 @@ private:
/***************************************************************************/
+/**
+ * @class AdminProperties
+ *
+ * @brief AdminProperties
+ *
+ * Test for Notify EC properties -
+ * max_queue_length
+ * max_consumers
+ * max_suppliers
+ * reject_new_events
+ */
class AdminProperties : public Notify_Test_Client
{
- // = TITLE
- // AdminProperties
- //
- // = DESCRIPTION
- // Test for Notify EC properties -
- // max_queue_length
- // max_consumers
- // max_suppliers
- // reject_new_events
- //
friend class AdminProperties_StructuredPushConsumer;
friend class AdminProperties_Task;
@@ -96,8 +98,8 @@ public:
// Initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
private:
void create_suppliers (void);
@@ -111,20 +113,20 @@ private:
void test_max_queue_length (bool reject);
// Data Members
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Values for Admin Properties supplied by user.
CORBA::Long max_queue_length_;
CORBA::Long max_consumers_;
CORBA::Long max_suppliers_;
CORBA::Boolean reject_new_events_;
- // Values for Admin Properties supplied by user.
/// Number of consumers to connect to check MaxConsumers property.
CORBA::Long consumers_;
@@ -132,8 +134,8 @@ private:
/// Number of suppliers to connect to check MaxSuppliers property.
CORBA::Long suppliers_;
+ /// Number of events to send to the channel.
CORBA::Long event_count_;
- // Number of events to send to the channel.
/// Count of consumers successfully connect to the EC.
int suppliers_connected_count_;
diff --git a/TAO/orbsvcs/tests/Notify/Basic/ConnectDisconnect.h b/TAO/orbsvcs/tests/Notify/Basic/ConnectDisconnect.h
index ecb0315ab1e..3c00ffca5d1 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/ConnectDisconnect.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/ConnectDisconnect.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// ConnectDisconnect.h
-//
-// = DESCRIPTION
-// Test connect-disconnect methods of Notify.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file ConnectDisconnect.h
+ *
+ * $Id$
+ *
+ * Test connect-disconnect methods of Notify.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_CONNECT_DISCONNECT_H
#define NOTIFY_CONNECT_DISCONNECT_H
@@ -31,9 +31,12 @@
class ConnectDisconnect;
+/**
+ * @class CD_Entity
+ The entity that connects/disconnects.
+ */
class CD_Entity
{
- // The entity that connects/disconnects.
public:
CD_Entity (ConnectDisconnect* cd, int id);
~CD_Entity ();
@@ -66,64 +69,64 @@ public:
ConnectDisconnect (void);
virtual ~ConnectDisconnect ();
+ /// Keeps track of how many objects were destroyed.
void on_entity_destroyed (void);
- // Keeps track of how many objects were destroyed.
int parse_args (int argc,
ACE_TCHAR *argv[]);
+ /// initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// End the test.
void end_test (void);
- // End the test.
+ /// Check if we got the expected results.
int check_results (void);
- // Check if we got the expected results.
protected:
+ /// Create EC.
void create_EC (void);
- // Create EC.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Arrays of Consumers.
TAO_Notify_Tests_PushConsumer** any_consumer_;
TAO_Notify_Tests_StructuredPushConsumer** structured_consumer_;
TAO_Notify_Tests_SequencePushConsumer** sequence_consumer_;
- // Arrays of Consumers.
+ /// arrays of Suppliers
TAO_Notify_Tests_PushSupplier** any_supplier_;
TAO_Notify_Tests_StructuredPushSupplier** structured_supplier_;
TAO_Notify_Tests_SequencePushSupplier** sequence_supplier_;
- // arrays of Suppliers
+ /// Count of clients destroyed. for c consumers, s suppliers and for t times.
+ /// this should be (s+c)*t.
ACE_Atomic_Op <TAO_SYNCH_MUTEX, int> result_count_;
- // Count of clients destroyed. for c consumers, s suppliers and for t times.
- // this should be (s+c)*t.
int expected_count_; // (s+c)*t
// = command line params
+ /// The number of iterations to connect disconnect.
int count_;
- // The number of iterations to connect disconnect.
+ /// The number of counsumers to create.
int consumers_;
- // The number of counsumers to create.
+ /// The number of suppliers to create.
int suppliers_;
- // The number of suppliers to create.
};
/***************************************************************************/
diff --git a/TAO/orbsvcs/tests/Notify/Basic/Events.h b/TAO/orbsvcs/tests/Notify/Basic/Events.h
index cfde51db870..1d60ed55ce0 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/Events.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/Events.h
@@ -1,18 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Events.h
-//
-// = DESCRIPTION
-// Test to check if events are received by all 3 types of consumers.
-// This is intended to be a simple test without any filters with default subscription (all events).
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Events.h
+ *
+ * $Id$
+ *
+ * Test to check if events are received by all 3 types of consumers.
+ * This is intended to be a simple test without any filters with default subscription (all events).
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TESTS_EventS_H
#define NOTIFY_TESTS_EventS_H
@@ -31,8 +31,8 @@ class Events;
class Event_StructuredPushConsumer : public TAO_Notify_Tests_StructuredPushConsumer
{
public:
+ /// Contructor.
Event_StructuredPushConsumer (Events *test_client);
- // Contructor.
// = StructuredPushSupplier methods.
virtual void push_structured_event (
@@ -48,11 +48,11 @@ protected:
class Event_StructuredPushSupplier : public TAO_Notify_Tests_StructuredPushSupplier
{
public:
+ /// Constructor.
Event_StructuredPushSupplier (Events * test_client);
- // Constructor.
+ /// Destructor.
virtual ~Event_StructuredPushSupplier (void);
- // Destructor.
protected:
Events* test_client_;
@@ -70,49 +70,49 @@ public:
int parse_args (int argc,
ACE_TCHAR *argv[]) ;
+ /// Initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // Initialization.
+ /// Called when an event is received.
void on_event_received (void);
- // Called when an event is received.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// End the test.
void end_test (void);
- // End the test.
+ /// check if we got the expected results.
int check_results (void);
- // check if we got the expected results.
protected:
+ /// Create EC
void create_EC (void);
- // Create EC
+ /// Number of events received so far.
ACE_Atomic_Op <TAO_SYNCH_MUTEX, int> result_count_;
- // Number of events received so far.
/// Use the default admins.
int use_default_admin_;
+ /// Number of events to send
int event_count_;
- // Number of events to send
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer
TAO_Notify_Tests_StructuredPushConsumer* consumer_;
- // Consumer
+ /// Supplier
TAO_Notify_Tests_StructuredPushSupplier* supplier_;
- // Supplier
private:
friend class Event_StructuredPushSupplier;
diff --git a/TAO/orbsvcs/tests/Notify/Basic/Filter.h b/TAO/orbsvcs/tests/Notify/Basic/Filter.h
index d12e786693d..bb862c1830a 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/Filter.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/Filter.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Filter.h
-//
-// = DESCRIPTION
-// Filter test any supplier to any consumer.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Filter.h
+ *
+ * $Id$
+ *
+ * Filter test any supplier to any consumer.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TESTS_FILTER_H
#define NOTIFY_TESTS_FILTER_H
@@ -34,16 +34,16 @@ public:
Filter (void);
virtual ~Filter (void);
+ /// initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
protected:
+ /// Create EC
void create_EC (void);
- // Create EC
/// Run some tests to check the filters.
void run_filter_test (CosNotifyFilter::FilterAdmin_ptr);
@@ -60,26 +60,26 @@ protected:
/// The default filter factory.
CosNotifyFilter::FilterFactory_var ffact_;
+ /// Number of events received so far.
ACE_Atomic_Op <TAO_SYNCH_MUTEX, int> result_count_;
- // Number of events received so far.
+ /// Number of events to send
int event_count_;
- // Number of events to send
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer.
TAO_Notify_Tests_PushConsumer* consumer_;
- // Consumer.
+ /// Supplier.
TAO_Notify_Tests_PushSupplier* supplier_;
- // Supplier.
};
/***************************************************************************/
diff --git a/TAO/orbsvcs/tests/Notify/Basic/IdAssignment.h b/TAO/orbsvcs/tests/Notify/Basic/IdAssignment.h
index d9e97907f28..4efd019fedf 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/IdAssignment.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/IdAssignment.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// IdAssignment.h
-//
-// = DESCRIPTION
-// Test to check if ec, admin are assigned id's correctly.
-//
-// = AUTHORS
-// Chanaka Liyanaarachchi <chanaka@ociweb.com> and Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file IdAssignment.h
+ *
+ * $Id$
+ *
+ * Test to check if ec, admin are assigned id's correctly.
+ *
+ *
+ * @author Chanaka Liyanaarachchi <chanaka@ociweb.com> and Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef IDASSIGNMENT_H
#define IDASSIGNMENT_H
@@ -53,17 +53,17 @@ private:
// = Data members.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
+ /// Number of iterations for the test.
int iter_;
- // Number of iterations for the test.
+ /// Numbers of EC's to create.
int ec_count_;
- // Numbers of EC's to create.
+ /// Number of consumer admins to create per ec.
int consumer_admin_count_;
- // Number of consumer admins to create per ec.
+ /// Number of consumer admins to create per ec.
int supplier_admin_count_;
- // Number of consumer admins to create per ec.
};
#endif /* IDASSIGNMENT_H */
diff --git a/TAO/orbsvcs/tests/Notify/Basic/LifeCycle.h b/TAO/orbsvcs/tests/Notify/Basic/LifeCycle.h
index 87150f7377c..93cbd9a134d 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/LifeCycle.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/LifeCycle.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// LifeCycle.h
-//
-// = DESCRIPTION
-// Test to check it ec and admin objects are destroyed.
-//
-// = AUTHOR
-// Chanaka Liyanaarachchi <chanaka@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file LifeCycle.h
+ *
+ * $Id$
+ *
+ * Test to check it ec and admin objects are destroyed.
+ *
+ *
+ * @author Chanaka Liyanaarachchi <chanaka@ociweb.com>
+ */
+//=============================================================================
+
#ifndef NOTIFY_LIFECYCLETST_H
#define NOTIFY_LIFECYCLETST_H
@@ -41,8 +41,8 @@ private:
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
+ /// Number of times to create destroy.
int count_;
- // Number of times to create destroy.
};
#endif /* NOTIFY_LIFECYCLETST_H */
diff --git a/TAO/orbsvcs/tests/Notify/Basic/MultiTypes.h b/TAO/orbsvcs/tests/Notify/Basic/MultiTypes.h
index 758913b46df..30b5e3c1154 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/MultiTypes.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/MultiTypes.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// MultiTypes.h
-//
-// = DESCRIPTION
-// Test connect-disconnect methods of Notify.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file MultiTypes.h
+ *
+ * $Id$
+ *
+ * Test connect-disconnect methods of Notify.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_MULTI_TYPES_H
#define NOTIFY_MULTI_TYPES_H
@@ -92,44 +92,44 @@ public:
int parse_args (int argc,
ACE_TCHAR *argv[]);
+ /// initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// End the test.
void end_test (void);
- // End the test.
+ /// Check if we got the expected results.
int check_results (void);
- // Check if we got the expected results.
protected:
// Wait to receive events.
void wait_for_all_consumers (int expected_count_per_consumer);
+ /// Create EC.
void create_EC (void);
- // Create EC.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumers.
TAO_Notify_Tests_PushConsumer* any_consumer_;
TAO_Notify_Tests_StructuredPushConsumer* structured_consumer_;
TAO_Notify_Tests_SequencePushConsumer* sequence_consumer_;
- // Consumers.
+ /// Suppliers
TAO_Notify_Tests_PushSupplier* any_supplier_;
TAO_Notify_Tests_StructuredPushSupplier* structured_supplier_;
TAO_Notify_Tests_SequencePushSupplier* sequence_supplier_;
- // Suppliers
// Count of Any events received;
ACE_Atomic_Op <TAO_SYNCH_MUTEX, int> any_event_count_;
diff --git a/TAO/orbsvcs/tests/Notify/Basic/Sequence.h b/TAO/orbsvcs/tests/Notify/Basic/Sequence.h
index 1a049c46c81..6f6845116e2 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/Sequence.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/Sequence.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Events.h
-//
-// = DESCRIPTION
-// Test Sequence support in Notification.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Events.h
+ *
+ * $Id$
+ *
+ * Test Sequence support in Notification.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TESTS_SEQUENCE_H
#define NOTIFY_TESTS_SEQUENCE_H
@@ -47,11 +47,11 @@ protected:
class SequencePushSupplier : public TAO_Notify_Tests_SequencePushSupplier
{
public:
+ /// Constructor.
SequencePushSupplier (Sequence * test_client);
- // Constructor.
+ /// Destructor.
virtual ~SequencePushSupplier (void);
- // Destructor.
protected:
Sequence* test_client_;
@@ -69,28 +69,28 @@ public:
int parse_args (int argc,
ACE_TCHAR *argv[]) ;
+ /// Initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // Initialization.
+ /// Called when an event is received.
void on_event_received (void);
- // Called when an event is received.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// End the test.
void end_test (void);
- // End the test.
+ /// check if we got the expected results.
int check_results (void);
- // check if we got the expected results.
protected:
+ /// Create EC
void create_EC (void);
- // Create EC
+ /// Number of events to send
int event_count_;
- // Number of events to send
/// Batch size send by supplier.
CORBA::ULong supplier_batch_size_;
@@ -107,20 +107,20 @@ protected:
ACE_Time_Value consumer_delay_;
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer
TAO_Notify_Tests_SequencePushConsumer* consumer_;
- // Consumer
+ /// Supplier
TAO_Notify_Tests_SequencePushSupplier* supplier_;
- // Supplier
private:
friend class SequencePushSupplier;
diff --git a/TAO/orbsvcs/tests/Notify/Basic/Simple.h b/TAO/orbsvcs/tests/Notify/Basic/Simple.h
index 697b0762258..934c51e3882 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/Simple.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/Simple.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Simple_Test.h
-//
-// = DESCRIPTION
-// Simple test any supplier to any consumer.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Simple_Test.h
+ *
+ * $Id$
+ *
+ * Simple test any supplier to any consumer.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TESTS_SIMPLE_H
#define NOTIFY_TESTS_SIMPLE_H
@@ -32,8 +32,8 @@ class Simple_Test;
class Event_AnyPushConsumer : public TAO_Notify_Tests_PushConsumer
{
public:
+ /// Contructor.
Event_AnyPushConsumer (Simple_Test *test_client);
- // Contructor.
// = PushSupplier methods
virtual void push (
@@ -49,11 +49,11 @@ protected:
class Event_AnyPushSupplier : public TAO_Notify_Tests_PushSupplier
{
public:
+ /// Constructor.
Event_AnyPushSupplier (Simple_Test * test_client);
- // Constructor.
+ /// Destructor.
virtual ~Event_AnyPushSupplier (void);
- // Destructor.
protected:
Simple_Test* test_client_;
@@ -71,46 +71,46 @@ public:
int parse_args (int argc,
ACE_TCHAR *argv[]) ;
+ /// initialization.
int init (int argc,
ACE_TCHAR *argv []);
- // initialization.
+ /// Called when an event is received.
void on_event_received (void);
- // Called when an event is received.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// End the test.
void end_test (void);
- // End the test.
+ /// check if we got the expected results.
int check_results (void);
- // check if we got the expected results.
protected:
+ /// Create EC
void create_EC (void);
- // Create EC
+ /// Number of events received so far.
ACE_Atomic_Op <TAO_SYNCH_MUTEX, int> result_count_;
- // Number of events received so far.
+ /// Number of events to send
int event_count_;
- // Number of events to send
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer.
TAO_Notify_Tests_PushConsumer* consumer_;
- // Consumer.
+ /// Supplier.
TAO_Notify_Tests_PushSupplier* supplier_;
- // Supplier.
private:
friend class Event_AnyPushSupplier;
diff --git a/TAO/orbsvcs/tests/Notify/Basic/Updates.h b/TAO/orbsvcs/tests/Notify/Basic/Updates.h
index 8dc9988396c..238a4d22a6c 100644
--- a/TAO/orbsvcs/tests/Notify/Basic/Updates.h
+++ b/TAO/orbsvcs/tests/Notify/Basic/Updates.h
@@ -1,18 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Updates.h
-//
-// = DESCRIPTION
-// Test to check if <offer_change> and <subscription_change> messages are
-// received correctly.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Updates.h
+ *
+ * $Id$
+ *
+ * Test to check if <offer_change> and <subscription_change> messages are
+ * received correctly.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TESTS_UPDATES_H
#define NOTIFY_TESTS_UPDATES_H
@@ -31,12 +31,12 @@ class Updates;
class Updates_StructuredPushConsumer : public TAO_Notify_Tests_StructuredPushConsumer
{
public:
+ /// Contructor.
Updates_StructuredPushConsumer (Updates *test_client);
- // Contructor.
+ /// Offer change is conveyed here.
virtual void offer_change (const CosNotification::EventTypeSeq & added,
const CosNotification::EventTypeSeq & removed);
- // Offer change is conveyed here.
protected:
Updates * test_client_;
@@ -47,17 +47,17 @@ protected:
class Updates_StructuredPushSupplier : public TAO_Notify_Tests_StructuredPushSupplier
{
public:
+ /// Constructor.
Updates_StructuredPushSupplier (Updates * test_client);
- // Constructor.
+ /// Destructor.
virtual ~Updates_StructuredPushSupplier ();
- // Destructor.
+ /// Subscription change is conveyed here.
virtual void subscription_change (
const CosNotification::EventTypeSeq & added,
const CosNotification::EventTypeSeq & removed
);
- // Subscription change is conveyed here.
protected:
Updates* test_client_;
@@ -72,11 +72,11 @@ public:
Updates (void);
virtual ~Updates ();
+ /// initialization.
int init (int argc, ACE_TCHAR *argv []);
- // initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
/// print_event_types
void print_event_types (const CosNotification::EventTypeSeq &types);
@@ -88,8 +88,8 @@ public:
void wait_for_updates (int expected_added, int expected_removed);
protected:
+ /// Create EC
void create_EC (void);
- // Create EC
/// Helper to add types.
void add_type (CosNotification::EventTypeSeq& type_seq, const char* type);
@@ -110,23 +110,23 @@ protected:
int added_count_;
/// Count of removed updates received
+ /// Check if these are equal to <update_count_> at the end of the test.
int removed_count_;
- // Check if these are equal to <update_count_> at the end of the test.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer
TAO_Notify_Tests_StructuredPushConsumer* consumer_;
- // Consumer
+ /// Supplier
TAO_Notify_Tests_StructuredPushSupplier* supplier_;
- // Supplier
private:
friend class Updates_StructuredPushSupplier;
diff --git a/TAO/orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h
index afc3eff9095..4a57491090c 100644
--- a/TAO/orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Blocking/Notify_Structured_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Structured_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Structured_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
#define TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h
index 0599cf07acc..418a73fd358 100644
--- a/TAO/orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Bug_2415_Regression/Notify_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Push_Consumer.h
-//
-// = DESCRIPTION
-// A push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_PUSH_CONSUMER_H
#define TAO_NOTIFY_PUSH_CONSUMER_H
#include "Notify_StructuredPushConsumer.h"
diff --git a/TAO/orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h
index c4a675b8f94..00158ec1f23 100644
--- a/TAO/orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Bug_2561_Regression/Notify_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_PUSH_CONSUMER_H
#define TAO_NOTIFY_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h
index e19763cb7e5..1e23933c853 100644
--- a/TAO/orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Discarding/Notify_Sequence_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Sequence_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Sequence_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
#define TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h
index bd58ab5e9f8..21bd72f89b8 100644
--- a/TAO/orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Discarding/Notify_Structured_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Structured_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Structured_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
#define TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h
index 9f3e4ed57f4..bf647535a2d 100644
--- a/TAO/orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/MT_Dispatching/Notify_Structured_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Structured_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Structured_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
#define TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h
index 8468813f787..0e63e08d773 100644
--- a/TAO/orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Ordering/Notify_Sequence_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Ordering
-//
-// = FILENAME
-// Notify_Sequence_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Sequence_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
#define TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h
index 0d948b295a2..f669d12c7b5 100644
--- a/TAO/orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Ordering/Notify_Structured_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Ordering
-//
-// = FILENAME
-// Notify_Structured_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Structured_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
#define TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Persistent_Filter/Filter.h b/TAO/orbsvcs/tests/Notify/Persistent_Filter/Filter.h
index d85dc6edabb..665038d7cd4 100644
--- a/TAO/orbsvcs/tests/Notify/Persistent_Filter/Filter.h
+++ b/TAO/orbsvcs/tests/Notify/Persistent_Filter/Filter.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Filter.h
-//
-// = DESCRIPTION
-// Class to demo structured event filtering.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Filter.h
+ *
+ * $Id$
+ *
+ * Class to demo structured event filtering.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_FILTER_CLIENT_H
#define NOTIFY_FILTER_CLIENT_H
@@ -29,67 +29,70 @@
class Filter_StructuredPushConsumer;
class Filter_StructuredPushSupplier;
+/**
+ * @class FilterClient
+ *
+ * @brief Filter Client
+ *
+ * Client example that shows how to do Structured Event filtering
+ * in the Notification Service.
+ */
class FilterClient
{
- // = TITLE
- // Filter Client
- // = DESCRIPTION
- // Client example that shows how to do Structured Event filtering
- // in the Notification Service.
public:
// = Initialization and Termination
+ /// Constructor
FilterClient (void);
- // Constructor
+ /// Destructor
~FilterClient ();
- // Destructor
+ /// Init the Client.
void init_supplier (int argc, ACE_TCHAR *argv []);
void init_consumer (int argc, ACE_TCHAR *argv []);
- // Init the Client.
+ /// Run the demo.
void run_supplier ();
void run_consumer ();
- // Run the demo.
+ /// Consumer calls done, We're done.
void done (void);
- // Consumer calls done, We're done.
protected:
int parse_args (int argc,
ACE_TCHAR *argv[]);
+ /// Initializes the ORB.
void init_ORB (int& argc, ACE_TCHAR **& argv);
- // Initializes the ORB.
+ /// Try to get hold of a running naming service.
void resolve_naming_service ();
- // Try to get hold of a running naming service.
+ /// Try to resolve the Notify factory from the Naming service.
void resolve_Notify_factory ();
- // Try to resolve the Notify factory from the Naming service.
+ /// Create an EC.
void create_EC ();
void get_EC ();
- // Create an EC.
+ /// Create the Supplier Admin.
void create_supplieradmin();
- // Create the Supplier Admin.
void get_supplieradmin();
+ /// Create the Consumer Admin.
void create_consumeradmin ();
- // Create the Consumer Admin.
void get_consumeradmin ();
+ /// Create and initialize the consumers.
void create_consumers ();
- // Create and initialize the consumers.
+ /// create and initialize the suppliers.
void create_suppliers ();
- // create and initialize the suppliers.
+ /// send the events.
void send_events ();
- // send the events.
void wait_ready ();
@@ -100,48 +103,48 @@ class FilterClient
const char* mod_constraint_expr);
// = Data Members
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Handle to the name service.
CosNaming::NamingContext_var naming_context_;
- // Handle to the name service.
+ /// Channel factory.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
- // Channel factory.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The group operator between admin-proxy's.
CosNotifyChannelAdmin::InterFilterGroupOperator ifgop_;
- // The group operator between admin-proxy's.
+ /// Initial qos specified to the factory when creating the EC.
CosNotification::QoSProperties initial_qos_;
- // Initial qos specified to the factory when creating the EC.
+ /// Initial admin props specified to the factory when creating the EC.
CosNotification::AdminProperties initial_admin_;
- // Initial admin props specified to the factory when creating the EC.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_1_;
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_2_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumer #1
Filter_StructuredPushConsumer* consumer_1;
- // Consumer #1
+ /// Consumer #2
Filter_StructuredPushConsumer* consumer_2;
- // Consumer #2
+ /// Supplier #1
Filter_StructuredPushSupplier* supplier_1;
- // Supplier #1
+ /// Supplier #2
Filter_StructuredPushSupplier* supplier_2;
- // Supplier #2
CosNotifyChannelAdmin::AdminID adminid_1_id_;
CosNotifyChannelAdmin::AdminID adminid_2_id_;
@@ -157,45 +160,46 @@ class FilterClient
};
/*****************************************************************/
+/**
+ * @class Filter_StructuredPushConsumer
+ *
+ * @brief Filter_StructuredPushConsumer
+ *
+ * Consumer for the Filter example.
+ */
class Filter_StructuredPushConsumer : public POA_CosNotifyComm::StructuredPushConsumer
{
- // = TITLE
- // Filter_StructuredPushConsumer
- //
- // = DESCRIPTION
- // Consumer for the Filter example.
- //
public:
// = Initialization and Termination code
+ /// Constructor.
Filter_StructuredPushConsumer (FilterClient* filter, const char *my_name);
- // Constructor.
+ /// Connect the Consumer to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect the Consumer to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
virtual void disconnect ();
- // Disconnect from the supplier.
protected:
// = Data members
+ /// The callback for <done>
FilterClient* filter_;
- // The callback for <done>
+ /// The name of this consumer.
ACE_CString my_name_;
- // The name of this consumer.
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy_supplier_;
- // The proxy that we are connected to.
+ /// The proxy_supplier id.
CosNotifyChannelAdmin::ProxyID proxy_supplier_id_;
- // The proxy_supplier id.
// = Methods
+ /// Destructor
virtual ~Filter_StructuredPushConsumer (void);
- // Destructor
// = NotifyPublish method
virtual void offer_change (
@@ -213,43 +217,44 @@ protected:
/*****************************************************************/
+ /**
+ * @class Filter_StructuredPushSupplier
+ *
+ * @brief Filter_StructuredPushSupplier
+ *
+ * Supplier for the filter example.
+ */
class Filter_StructuredPushSupplier : public POA_CosNotifyComm::StructuredPushSupplier
{
- // = TITLE
- // Filter_StructuredPushSupplier
- //
- // = DESCRIPTION
- // Supplier for the filter example.
- //
public:
// = Initialization and Termination code
+ /// Constructor.
Filter_StructuredPushSupplier (const char* my_name);
- // Constructor.
+ /// Connect the Supplier to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect the Supplier to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
void disconnect ();
- // Disconnect from the supplier.
+ /// Send one event.
virtual void send_event (const CosNotification::StructuredEvent& event);
- // Send one event.
protected:
// = Data members
+ /// The name of this consumer.
ACE_CString my_name_;
- // The name of this consumer.
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushConsumer_var proxy_consumer_;
- // The proxy that we are connected to.
+ /// This supplier's id.
CosNotifyChannelAdmin::ProxyID proxy_consumer_id_;
- // This supplier's id.
// = Protected Methods
+ /// Destructor
virtual ~Filter_StructuredPushSupplier ();
- // Destructor
// = NotifySubscribe
virtual void subscription_change (
diff --git a/TAO/orbsvcs/tests/Notify/Reconnecting/Consumer.h b/TAO/orbsvcs/tests/Notify/Reconnecting/Consumer.h
index 358c29600c6..7ddaef1a363 100644
--- a/TAO/orbsvcs/tests/Notify/Reconnecting/Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Reconnecting/Consumer.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Consumer.h
-//
-// = DESCRIPTION
-// Test Consumer reconnect to existing channel/admin/proxy Notification Service
-//
-// = AUTHOR
-// Dale Wilson <wilson_d@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Consumer.h
+ *
+ * $Id$
+ *
+ * Test Consumer reconnect to existing channel/admin/proxy Notification Service
+ *
+ *
+ * @author Dale Wilson <wilson_d@ociweb.com>
+ */
+//=============================================================================
+
#ifndef RECONNECTNG_CONSUMER_H
#define RECONNECTNG_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Reconnecting/Supplier.h b/TAO/orbsvcs/tests/Notify/Reconnecting/Supplier.h
index 6d998403a03..746bf190a4d 100644
--- a/TAO/orbsvcs/tests/Notify/Reconnecting/Supplier.h
+++ b/TAO/orbsvcs/tests/Notify/Reconnecting/Supplier.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Supplier.h
-//
-// = DESCRIPTION
-// Test Supplier reconnect to existing channel/admin/proxy Notification Service
-//
-// = AUTHOR
-// Dale Wilson <wilson_d@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Supplier.h
+ *
+ * $Id$
+ *
+ * Test Supplier reconnect to existing channel/admin/proxy Notification Service
+ *
+ *
+ * @author Dale Wilson <wilson_d@ociweb.com>
+ */
+//=============================================================================
+
#ifndef RECONNECTNG_SUPPLIER_H
#define RECONNECTNG_SUPPLIER_H
diff --git a/TAO/orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h
index cdb1c927dc9..a0fcac7d195 100644
--- a/TAO/orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Sequence_Multi_ETCL_Filter/Notify_Sequence_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Sequence_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Sequence_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
#define TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h
index d6fc3520099..42105aae12e 100644
--- a/TAO/orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Sequence_Multi_Filter/Notify_Sequence_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Sequence_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Sequence_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
#define TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h
index 3649d2d46a9..0a7047a000a 100644
--- a/TAO/orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Structured_Filter/Notify_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Structured_Filter
-//
-// = FILENAME
-// Notify_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chip Jones <jones_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chip Jones <jones_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef NOTIFY_PUSH_CONSUMER_H
#define NOTIFY_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h
index 2d17ace210b..28aba1c7f4d 100644
--- a/TAO/orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/Structured_Multi_Filter/Notify_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Structured_Filter
-//
-// = FILENAME
-// Notify_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chip Jones <jones_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chip Jones <jones_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef NOTIFY_PUSH_CONSUMER_H
#define NOTIFY_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_PushConsumer.h b/TAO/orbsvcs/tests/Notify/lib/Notify_PushConsumer.h
index 0a66baa40e3..274e3ca068b 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_PushConsumer.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_PushConsumer.h
@@ -1,28 +1,25 @@
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// Notify_PushConsumer.h
-//
-// = DESCRIPTION
-// This is a utility class is to be used by clients of the Notification
-// Service to implement the servant for CosNotifyComm::PushConsumer
-//
-// = HOW-TO
-// 1. Derive from Notify_ProxyConsumer and implement <push>.
-// 2. Create the servant on the heap.(refcounted servant).
-// 3. Initialize the object, provide a POA.
-// 4. To connect, call <connect>, this will activate the object in the POA.
-// You must provide a ConsumerAdmin to <connect>.
-// 5. To disconnect, call <disconnect> this will also deactivate the object.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_PushConsumer.h
+ *
+ * $Id$
+ *
+ * This is a utility class is to be used by clients of the Notification
+ * Service to implement the servant for CosNotifyComm::PushConsumer
+ *
+ * = HOW-TO
+ * 1. Derive from Notify_ProxyConsumer and implement <push>.
+ * 2. Create the servant on the heap.(refcounted servant).
+ * 3. Initialize the object, provide a POA.
+ * 4. To connect, call <connect>, this will activate the object in the POA.
+ * You must provide a ConsumerAdmin to <connect>.
+ * 5. To disconnect, call <disconnect> this will also deactivate the object.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_PUSHCONSUMER_H
#define TAO_NOTIFY_PUSHCONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h b/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h
index 453abae9d5a..7f3485a5b43 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushConsumer.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// Notify_SequencePushConsumer.h
-//
-// = DESCRIPTION
-// This is a utility class is to be used by clients of the Notification
-// Service to implement the servant for CosNotifyComm::SequencePushConsumer
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_SequencePushConsumer.h
+ *
+ * $Id$
+ *
+ * This is a utility class is to be used by clients of the Notification
+ * Service to implement the servant for CosNotifyComm::SequencePushConsumer
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_SEQUENCEPUSHCONSUMER_H
#define NOTIFY_SEQUENCEPUSHCONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h b/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h
index 74fd09d4498..c12e61cbdfd 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_SequencePushSupplier.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// Notify_SequencePushSupplier
-//
-// = DESCRIPTION
-// This class is to be used by clients of the Notification Service
-// to implement Sequence Push Suppliers.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_SequencePushSupplier
+ *
+ * $Id$
+ *
+ * This class is to be used by clients of the Notification Service
+ * to implement Sequence Push Suppliers.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCEPUSHSUPPLIER_H
#define TAO_NOTIFY_SEQUENCEPUSHSUPPLIER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h b/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h
index 8364a0394b3..292b6a7c595 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushConsumer.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// Notify_StructuredPushConsumer.h
-//
-// = DESCRIPTION
-// This is a utility class is to be used by clients of the Notification
-// Service to implement the servant for CosNotifyComm::PushConsumer
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_StructuredPushConsumer.h
+ *
+ * $Id$
+ *
+ * This is a utility class is to be used by clients of the Notification
+ * Service to implement the servant for CosNotifyComm::PushConsumer
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_STRUCTUREDPUSHCONSUMER_H
#define NOTIFY_STRUCTUREDPUSHCONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h b/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h
index ecc804ae3aa..fa927b96e5a 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_StructuredPushSupplier.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// orbsvcs
-//
-// = FILENAME
-// Notify_StructuredPushSupplier
-//
-// = DESCRIPTION
-// This class is to be used by clients of the Notification Service
-// to implement Structured Push Suppliers.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_StructuredPushSupplier
+ *
+ * $Id$
+ *
+ * This class is to be used by clients of the Notification Service
+ * to implement Structured Push Suppliers.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTUREDPUSHSUPPLIER_H
#define TAO_NOTIFY_STRUCTUREDPUSHSUPPLIER_H
diff --git a/TAO/orbsvcs/tests/Notify/lib/Notify_Test_Client.h b/TAO/orbsvcs/tests/Notify/lib/Notify_Test_Client.h
index 8df3e0f673f..07baebcd5e4 100644
--- a/TAO/orbsvcs/tests/Notify/lib/Notify_Test_Client.h
+++ b/TAO/orbsvcs/tests/Notify/lib/Notify_Test_Client.h
@@ -1,17 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Notify_Test_Client.h
-//
-// = DESCRIPTION
-// Prototype Test Driver for all the Notify tests.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Test_Client.h
+ *
+ * $Id$
+ *
+ * Prototype Test Driver for all the Notify tests.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_TEST_CLIENT_H
#define NOTIFY_TEST_CLIENT_H
@@ -25,87 +25,90 @@
class TAO_Notify_Tests_Peer;
+/**
+ * @class Notify_Test_Client
+ *
+ * @brief Notify_Test_Client
+ *
+ * Shows how consumers Notify_Test_Client for events.
+ */
class TAO_NOTIFY_TEST_Export Notify_Test_Client
{
- // = TITLE
- // Notify_Test_Client
- // = DESCRIPTION
- // Shows how consumers Notify_Test_Client for events.
public:
// = Initialization and Termination
Notify_Test_Client (void);
virtual ~Notify_Test_Client ();
+ /// starts the orb and resolves the notify factory via a naming service.
virtual int init (int argc, ACE_TCHAR *argv []);
- // starts the orb and resolves the notify factory via a naming service.
+ /// Allow the user to override this empty method
virtual int parse_args (int argc, ACE_TCHAR* argv[]);
- // Allow the user to override this empty method
+ /// Call ORB::run to accept requests.
int ORB_run (void);
int ORB_run (ACE_Time_Value& tv);
- // Call ORB::run to accept requests.
+ /// How many clients will call consumer_done.
void consumer_start (TAO_Notify_Tests_Peer*);
- // How many clients will call consumer_done.
+ /// Callback for clients to unregister themselves.
void consumer_done (TAO_Notify_Tests_Peer*);
- // Callback for clients to unregister themselves.
+ /// Access the done boolean.
bool is_done (void) const;
- // Access the done boolean.
+ /// Access the ORB. This class retains ownership.
CORBA::ORB_ptr orb (void);
- // Access the ORB. This class retains ownership.
+ /// Access the Root POA. This class retains ownership.
PortableServer::POA_ptr root_poa (void);
- // Access the Root POA. This class retains ownership.
+ /// Access the Naming Context. This class retains ownership.
CosNaming::NamingContext_ptr naming_context (void);
- // Access the Naming Context. This class retains ownership.
+ /// Access the Notify Factory. This class retains ownership.
CosNotifyChannelAdmin::EventChannelFactory_ptr notify_factory (void);
- // Access the Notify Factory. This class retains ownership.
+ /// Create an Event Channel. Ownership is passed to the caller.
CosNotifyChannelAdmin::EventChannel_ptr create_event_channel (
const char* name,
bool resolve
);
- // Create an Event Channel. Ownership is passed to the caller.
protected:
+ /// Initializes the ORB.
int init_ORB (int argc,
ACE_TCHAR *argv []);
- // Initializes the ORB.
+ /// Try to get hold of a running naming service.
void resolve_naming_service (void);
- // Try to get hold of a running naming service.
+ /// Try to resolve the Notify factory from the Naming service.
void resolve_Notify_factory (void);
- // Try to resolve the Notify factory from the Naming service.
// = Data Members
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Handle to the name service.
CosNaming::NamingContext_var naming_context_;
- // Handle to the name service.
+ /// Channel factory.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
- // Channel factory.
+ /// The group operator between admin-proxy's.
CosNotifyChannelAdmin::InterFilterGroupOperator ifgop_;
- // The group operator between admin-proxy's.
+ /// Initial qos specified to the factory when creating the EC.
CosNotification::QoSProperties initial_qos_;
- // Initial qos specified to the factory when creating the EC.
+ /// Initial admin props specified to the factory when creating the EC.
CosNotification::AdminProperties initial_admin_;
- // Initial admin props specified to the factory when creating the EC.
private:
ACE_Atomic_Op< TAO_SYNCH_MUTEX, int > num_clients_;
diff --git a/TAO/orbsvcs/tests/Notify/lib/common.h b/TAO/orbsvcs/tests/Notify/lib/common.h
index 7704baa6a25..fa0a5fb4b7d 100644
--- a/TAO/orbsvcs/tests/Notify/lib/common.h
+++ b/TAO/orbsvcs/tests/Notify/lib/common.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/lib
-//
-// = FILENAME
-// common.h
-//
-// = DESCRIPTION
-// A couple of useful functions
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file common.h
+ *
+ * $Id$
+ *
+ * A couple of useful functions
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_COMMON_H
#define TAO_COMMON_H
diff --git a/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h
index ac3e9d44568..1b3e96fd666 100644
--- a/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Sequence_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Sequence_Push_Consumer.h
-//
-// = DESCRIPTION
-// A sequence push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Sequence_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A sequence push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
#define TAO_NOTIFY_SEQUENCE_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h b/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h
index 9d7d0cdd158..a9413e7f69b 100644
--- a/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h
+++ b/TAO/orbsvcs/tests/Notify/performance-tests/Filter/Notify_Structured_Push_Consumer.h
@@ -1,20 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Notify/Discarding
-//
-// = FILENAME
-// Notify_Structured_Push_Consumer.h
-//
-// = DESCRIPTION
-// A structured push consumer implementation.
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Notify_Structured_Push_Consumer.h
+ *
+ * $Id$
+ *
+ * A structured push consumer implementation.
+ *
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
#define TAO_NOTIFY_STRUCTURED_PUSH_CONSUMER_H
diff --git a/TAO/orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h b/TAO/orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h
index 2eeae43842c..720939e4b2c 100644
--- a/TAO/orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h
+++ b/TAO/orbsvcs/tests/Notify/performance-tests/RedGreen/RedGreen_Test.h
@@ -1,18 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// RedGreen_Test.h
-//
-// = DESCRIPTION
-// Performance test to show improvement in Notify performance by picking the
-// correcting configuration.
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file RedGreen_Test.h
+ *
+ * $Id$
+ *
+ * Performance test to show improvement in Notify performance by picking the
+ * correcting configuration.
+ *
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_RedGreen_Test_CLIENT_H
#define NOTIFY_RedGreen_Test_CLIENT_H
@@ -34,37 +34,41 @@
class RedGreen_Test_StructuredPushConsumer;
class RedGreen_Test_StructuredPushSupplier;
+/**
+ * @class Worker
+ *
+ * @brief Run a server thread
+ *
+ * Use the ACE_Task_Base class to run server threads
+ */
class Worker : public ACE_Task_Base
{
- // = TITLE
- // Run a server thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run server threads
- //
public:
+ /// Constructor.
Worker (void);
- // Constructor.
void orb (CORBA::ORB_ptr orb);
+ /// The thread entry point.
virtual int svc (void);
- // The thread entry point.
// Shutdown ORB
void done (void);
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @class RedGreen_Test
+ *
+ * @brief RedGreen_Test
+ *
+ * Shows how consumers RedGreen_Test for events.
+ */
class RedGreen_Test
{
- // = TITLE
- // RedGreen_Test
- // = DESCRIPTION
- // Shows how consumers RedGreen_Test for events.
public:
// = Initialization
@@ -75,82 +79,82 @@ class RedGreen_Test
void dump_results (void);
+ /// Initialize the Client.
void init (int argc,
ACE_TCHAR *argv []);
- // Initialize the Client.
+ /// Run the demo.
void run (void);
- // Run the demo.
+ /// Called when all events we are waiting for have occured.
void done (void);
- // Called when all events we are waiting for have occured.
+ /// Destroy from the EC
void destroy_ec (void);
- // Destroy from the EC
int burst_size_;
Worker worker_;
int nthreads_;
protected:
+ /// Initializes the ORB.
void init_ORB (int argc,
ACE_TCHAR *argv []);
- // Initializes the ORB.
+ /// Try to get hold of a running naming service.
void resolve_naming_service (void);
- // Try to get hold of a running naming service.
+ /// Try to resolve the Notify factory from the Naming service.
void resolve_Notify_factory (void);
- // Try to resolve the Notify factory from the Naming service.
+ /// Create an EC.
void create_EC (void);
- // Create an EC.
+ /// Create the Supplier Admin.
void create_supplieradmin(void);
- // Create the Supplier Admin.
+ /// Create the Consumer Admin.
void create_consumeradmin (void);
- // Create the Consumer Admin.
+ /// Create and initialize the consumers.
void create_consumers (void);
- // Create and initialize the consumers.
+ /// create and initialize the suppliers.
void create_suppliers (void);
- // create and initialize the suppliers.
+ /// send the events.
void send_events (void);
- // send the events.
// = Data Members.
+ /// Reference to the root poa.
PortableServer::POA_var root_poa_;
- // Reference to the root poa.
+ /// The ORB that we use.
CORBA::ORB_var orb_;
- // The ORB that we use.
+ /// Handle to the name service.
CosNaming::NamingContext_var naming_context_;
- // Handle to the name service.
+ /// Channel factory.
CosNotifyChannelAdmin::EventChannelFactory_var notify_factory_;
- // Channel factory.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The group operator between admin-proxy's.
CosNotifyChannelAdmin::InterFilterGroupOperator ifgop_;
- // The group operator between admin-proxy's.
+ /// Initial qos specified to the factory when creating the EC.
CosNotification::QoSProperties initial_qos_;
- // Initial qos specified to the factory when creating the EC.
+ /// Initial admin props specified to the factory when creating the EC.
CosNotification::AdminProperties initial_admin_;
- // Initial admin props specified to the factory when creating the EC.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
RedGreen_Test_StructuredPushConsumer* normal_consumer_;
RedGreen_Test_StructuredPushConsumer* slow_consumer_;
@@ -171,49 +175,49 @@ class RedGreen_Test_StructuredPushConsumer
public:
// = Initialization and Termination code
+ /// Constructor.
RedGreen_Test_StructuredPushConsumer (RedGreen_Test* RedGreen_Test);
- // Constructor.
+ /// Connect the Consumer to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::ConsumerAdmin_ptr consumer_admin);
- // Connect the Consumer to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
virtual void disconnect (void);
- // Disconnect from the supplier.
+ /// Accessor for the Proxy that we're connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_ptr get_proxy_supplier (
void
);
- // Accessor for the Proxy that we're connected to.
+ /// Accumulate the throughput statistics into <throughput>
void accumulate_into (ACE_Throughput_Stats &throughput) const;
- // Accumulate the throughput statistics into <throughput>
+ /// Accumulate the throughput statistics into <throughput>
void dump_stats (const ACE_TCHAR* msg, ACE_UINT32 gsf);
- // Accumulate the throughput statistics into <throughput>
protected:
// = Data members
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy_supplier_;
- // The proxy that we are connected to.
+ /// The proxy_supplier id.
CosNotifyChannelAdmin::ProxyID proxy_supplier_id_;
- // The proxy_supplier id.
+ /// callback <done>
RedGreen_Test* RedGreen_Test_;
- // callback <done>
+ /// Protect internal state
TAO_SYNCH_MUTEX lock_;
- // Protect internal state
int push_count_;
+ /// Used for reporting stats
ACE_Throughput_Stats throughput_;
- // Used for reporting stats
// = Methods
+ /// Destructor
virtual ~RedGreen_Test_StructuredPushConsumer (void);
- // Destructor
// = NotifyPublish method
virtual void offer_change (
@@ -255,39 +259,39 @@ class RedGreen_Test_StructuredPushSupplier
//
public:
// = Initialization and Termination code
+ /// Constructor.
RedGreen_Test_StructuredPushSupplier (void);
- // Constructor.
+ /// Connect the Supplier to the EventChannel.
+ /// Creates a new proxy supplier and connects to it.
void connect (CosNotifyChannelAdmin::SupplierAdmin_ptr supplier_admin);
- // Connect the Supplier to the EventChannel.
- // Creates a new proxy supplier and connects to it.
+ /// Disconnect from the supplier.
void disconnect (void);
- // Disconnect from the supplier.
+ /// Send one event.
virtual void send_event (CosNotification::StructuredEvent& event);
- // Send one event.
+ /// Accumulate the throughput statistics into <throughput>
void accumulate_into (ACE_Throughput_Stats &throughput) const;
- // Accumulate the throughput statistics into <throughput>
+ /// Accumulate the throughput statistics into <throughput>
void dump_stats (const ACE_TCHAR* msg, ACE_UINT32 gsf);
- // Accumulate the throughput statistics into <throughput>
protected:
// = Data members
+ /// The proxy that we are connected to.
CosNotifyChannelAdmin::StructuredProxyPushConsumer_var proxy_consumer_;
- // The proxy that we are connected to.
+ /// This supplier's id.
CosNotifyChannelAdmin::ProxyID proxy_consumer_id_;
- // This supplier's id.
+ /// Measure the elapsed time spent while sending the events.
ACE_Throughput_Stats throughput_;
- // Measure the elapsed time spent while sending the events.
// = Protected Methods
+ /// Destructor
virtual ~RedGreen_Test_StructuredPushSupplier ();
- // Destructor
// = NotifyRedGreen_Test
virtual void subscription_change (
diff --git a/TAO/orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h b/TAO/orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h
index 1132a4e8631..9be6538b0d0 100644
--- a/TAO/orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h
+++ b/TAO/orbsvcs/tests/Notify/performance-tests/Throughput/Throughput.h
@@ -1,16 +1,16 @@
/* -*- C++ -*- */
-// $Id$
-// ==========================================================================
-//
-// = FILENAME
-// Throughput.h
-//
-// = DESCRIPTION
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// ==========================================================================
+//=============================================================================
+/**
+ * @file Throughput.h
+ *
+ * $Id$
+ *
+ * @brief
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef NOTIFY_Throughput_H
#define NOTIFY_Throughput_H
@@ -29,28 +29,29 @@
#pragma warning(disable:4250)
#endif /* _MSC_VER */
+/**
+ * @class Worker
+ *
+ * @brief Run a server thread
+ *
+ * Use the ACE_Task_Base class to run server threads
+ */
class Worker : public ACE_Task_Base
{
- // = TITLE
- // Run a server thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run server threads
- //
public:
+ /// ctor
Worker (void);
- // ctor
void orb (CORBA::ORB_ptr orb);
+ /// The thread entry point.
virtual int svc (void);
- // The thread entry point.
int done_;
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
/***************************************************************************/
@@ -61,34 +62,34 @@ class Throughput_StructuredPushConsumer
: public TAO_Notify_Tests_StructuredPushConsumer
{
public:
+ /// Contructor.
Throughput_StructuredPushConsumer (Notify_Throughput *test_client);
- // Contructor.
// = StructuredPushSupplier methods
virtual void push_structured_event (
const CosNotification::StructuredEvent & notification
);
+ /// Accumulate the throughput statistics into <throughput>
void accumulate_into (ACE_Throughput_Stats &throughput) const;
- // Accumulate the throughput statistics into <throughput>
+ /// Accumulate the throughput statistics into <throughput>
void dump_stats (const ACE_TCHAR* msg, ACE_UINT32 gsf);
- // Accumulate the throughput statistics into <throughput>
protected:
Notify_Throughput * test_client_;
+ /// Protect internal state
TAO_SYNCH_MUTEX lock_;
- // Protect internal state
+ /// The timestamp for the first message received
ACE_hrtime_t throughput_start_;
- // The timestamp for the first message received
+ /// Used for reporting stats
ACE_Throughput_Stats throughput_;
- // Used for reporting stats
+ /// The number of push() calls
int push_count_;
- // The number of push() calls
};
/***************************************************************************/
@@ -98,32 +99,32 @@ class Throughput_StructuredPushSupplier
public ACE_Task_Base
{
public:
+ /// Constructor.
Throughput_StructuredPushSupplier (Notify_Throughput * test_client);
- // Constructor.
+ /// Destructor.
virtual ~Throughput_StructuredPushSupplier ();
- // Destructor.
// = The ACE_Task_Base methods....
virtual int svc (void);
+ /// Accumulate the throughput statistics into <throughput>
void accumulate_into (ACE_Throughput_Stats &throughput) const;
- // Accumulate the throughput statistics into <throughput>
+ /// Accumulate the throughput statistics into <throughput>
void dump_stats (const ACE_TCHAR* msg, ACE_UINT32 gsf);
- // Accumulate the throughput statistics into <throughput>
protected:
Notify_Throughput* test_client_;
+ /// Count the number of push() calls
int push_count_;
- // Count the number of push() calls
+ /// The time for the first event sent
ACE_hrtime_t throughput_start_;
- // The time for the first event sent
+ /// Measure the elapsed time spent while sending the events.
ACE_Throughput_Stats throughput_;
- // Measure the elapsed time spent while sending the events.
};
/***************************************************************************/
@@ -137,79 +138,79 @@ public:
int parse_args(int argc, ACE_TCHAR *argv[]) ;
+ /// initialization.
int init (int argc, ACE_TCHAR *argv []);
- // initialization.
+ /// Run the test.
void run_test (void);
- // Run the test.
+ /// Peers call this when done.
void peer_done (void);
- // Peers call this when done.
+ /// check if we got the expected results.
void dump_results (void);
- // check if we got the expected results.
Worker worker_;
protected:
+ /// Create participants.
void create_EC (void);
- // Create participants.
+ /// is the ec collocated.
CORBA::Boolean collocated_ec_;
- // is the ec collocated.
+ /// How many bursts we will send from each supplier.
int burst_count_;
- // How many bursts we will send from each supplier.
+ /// The time between each event burst, in microseconds.
int burst_pause_;
- // The time between each event burst, in microseconds.
+ /// Number of events to send per supplier in every burst
int burst_size_;
- // Number of events to send per supplier in every burst
+ /// data size to transmit.
int payload_size_;
- // data size to transmit.
+ /// the payload.
char *payload_;
- // the payload.
+ /// Consumer count
int consumer_count_;
- // Consumer count
+ /// Supplier count
int supplier_count_;
- // Supplier count
+ /// Number of events received that each consumer expects to see.
int perconsumer_count_;
- // Number of events received that each consumer expects to see.
+ /// The name of the EC to resolve.
ACE_CString ec_name_;
- // The name of the EC to resolve.
+ /// The one channel that we create using the factory.
CosNotifyChannelAdmin::EventChannel_var ec_;
- // The one channel that we create using the factory.
+ /// The consumer admin used by consumers.
CosNotifyChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // The consumer admin used by consumers.
+ /// The supplier admin used by suppliers.
CosNotifyChannelAdmin::SupplierAdmin_var supplier_admin_;
- // The supplier admin used by suppliers.
+ /// Consumers
Throughput_StructuredPushConsumer** consumers_;
- // Consumers
+ /// Suppliers
Throughput_StructuredPushSupplier** suppliers_;
- // Suppliers
int nthreads_;
// = Helpers to signal done.
+ /// how many peers are done.
int peer_done_count_;
- // how many peers are done.
+ /// The lock to serialize access to members.
TAO_SYNCH_MUTEX lock_;
- // The lock to serialize access to members.
+ /// exit wait condition
TAO_SYNCH_CONDITION condition_;
- // exit wait condition
private:
friend class Throughput_StructuredPushSupplier;
friend class Throughput_StructuredPushConsumer;
diff --git a/TAO/orbsvcs/tests/Property/client.cpp b/TAO/orbsvcs/tests/Property/client.cpp
index 54280501069..c5dbbbe2a28 100644
--- a/TAO/orbsvcs/tests/Property/client.cpp
+++ b/TAO/orbsvcs/tests/Property/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Property
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// Test client for the Property Service.
-//
-// = AUTHORS
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * Test client for the Property Service.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "client.h"
#include "tao/debug.h"
diff --git a/TAO/orbsvcs/tests/Property/client.h b/TAO/orbsvcs/tests/Property/client.h
index 9ab696bd6c1..db212a0b0bb 100644
--- a/TAO/orbsvcs/tests/Property/client.h
+++ b/TAO/orbsvcs/tests/Property/client.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Property
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// Test client for the Property Service.
-//
-// = AUTHORS
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * Test client for the Property Service.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PROPERTY_CLIENT_H
#define PROPERTY_CLIENT_H
@@ -33,72 +30,74 @@
#include "orbsvcs/Property/CosPropertyService_i.h"
#include "orbsvcs/Naming/Naming_Client.h"
+/**
+ * @class Client
+ *
+ * @brief Client for A/V Streams demo.
+ *
+ * Encapsulates client functionality.
+ */
class Client
{
- // = TITLE
- // Client for A/V Streams demo.
- //
- // = DESCRIPTION
- // Encapsulates client functionality.
public:
+ /// Constructor.
Client (void);
- // Constructor.
+ /// Initialize the ORB etc, and bind the MMDevices.
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the ORB etc, and bind the MMDevices.
+ /// Run the client. This will call StreamCtrl::bind_devs.
int run (void);
- // Run the client. This will call StreamCtrl::bind_devs.
+ /// Testing the property service methods.
int property_tester (void);
- // Testing the property service methods.
protected:
+ /// Bind to the remote MMDevice.
int bind_to_remote_mmdevice (int argc,
ACE_TCHAR *argv[]);
- // Bind to the remote MMDevice.
// = Property Testing.
+ /// Testing the define property method.
int test_define_property (void);
- // Testing the define property method.
+ /// Testing the number of properties, currently in the Property Set.
int test_get_number_of_properties (void);
- // Testing the number of properties, currently in the Property Set.
+ ///Testing get_all_property_names.
int test_get_all_property_names (void);
- //Testing get_all_property_names.
+ /// Testing get_property_value.
int test_get_property_value (void);
- // Testing get_property_value.
+ ///Testing get_properties. Give the names and get their properties.
int test_get_properties (void);
- //Testing get_properties. Give the names and get their properties.
+ /// Testing get_all_properties.
int test_get_all_properties (void);
- // Testing get_all_properties.
+ /// Testing delete_property.
int test_delete_property (const char *property_name);
- // Testing delete_property.
+ /// Testing delete_properties.
int test_delete_properties (void);
- // Testing delete_properties.
+ /// Defining a sequence of properties.
int test_define_properties (void);
- // Defining a sequence of properties.
+ /// Defines properties with various modes.
int test_define_property_with_mode (void);
- // Defines properties with various modes.
+ /// The ORB manager, handles ORB initialization etc.
TAO_ORB_Manager manager_;
- // The ORB manager, handles ORB initialization etc.
+ /// The Naming Client handles Naming Service work
TAO_Naming_Client my_name_client_;
- // The Naming Client handles Naming Service work
+ /// To test propertySetDef interface.
CosPropertyService::PropertySetDef_var propsetdef_;
- // To test propertySetDef interface.
};
#endif /* COSPROPERTYSERVICE_CLIENT_H */
diff --git a/TAO/orbsvcs/tests/Property/server.cpp b/TAO/orbsvcs/tests/Property/server.cpp
index c1a60066209..165bf7e98de 100644
--- a/TAO/orbsvcs/tests/Property/server.cpp
+++ b/TAO/orbsvcs/tests/Property/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/CosPropertyService
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Test server for the CosPropertyService
-//
-// = AUTHORS
-// Alexander Babu Arulanthu <alex@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Test server for the CosPropertyService
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "server.h"
diff --git a/TAO/orbsvcs/tests/Property/server.h b/TAO/orbsvcs/tests/Property/server.h
index fde9aab4489..4c9fd930d7a 100644
--- a/TAO/orbsvcs/tests/Property/server.h
+++ b/TAO/orbsvcs/tests/Property/server.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/CosPropertyService
-//
-// = FILENAME
-// server.h
-//
-// = DESCRIPTION
-// Test server for the CosPropertyService.
-//
-// = AUTHORS
-// Alexander Babu Arulanthu <alex.cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * Test server for the CosPropertyService.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex.cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef COSPROPERTYSERVICE_SERVER_H
#define COSPROPERTYSERVICE_SERVER_H
diff --git a/TAO/orbsvcs/tests/Security/BiDirectional/test_i.h b/TAO/orbsvcs/tests/Security/BiDirectional/test_i.h
index cc4725dc141..3914ef78a3e 100644
--- a/TAO/orbsvcs/tests/Security/BiDirectional/test_i.h
+++ b/TAO/orbsvcs/tests/Security/BiDirectional/test_i.h
@@ -1,59 +1,58 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
#include "testS.h"
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// Safe way to shutdown
void shutdown (void);
- // Safe way to shutdown
+ /// The callback method
void callback_method (void);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @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, int no_iterations);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback);
@@ -65,17 +64,17 @@ public:
int call_client (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Callback_var callback_;
- // Callback Object
+ /// Number of times the callback needs to be called
int no_iterations_;
- // Number of times the callback needs to be called
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/orbsvcs/tests/Security/Crash_Test/test_i.h b/TAO/orbsvcs/tests/Security/Crash_Test/test_i.h
index 729b1d933f8..c9ff4b29ab3 100644
--- a/TAO/orbsvcs/tests/Security/Crash_Test/test_i.h
+++ b/TAO/orbsvcs/tests/Security/Crash_Test/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Send_File
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_SEND_FILE_TEST_I_H
#define TAO_SEND_FILE_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 send_line (const char *line);
diff --git a/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h b/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h
index 85099621dfa..c7b0f235f7b 100644
--- a/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h
+++ b/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/Client_Worker.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ===========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Security/MT_SSLIOP
-//
-// = FILENAME
-// Client_Worker.h
-//
-// = AUTHOR
-// Anand Krishnan
-//
-// ===========================================================================
+
+//=============================================================================
+/**
+ * @file Client_Worker.h
+ *
+ * $Id$
+ *
+ * @author Anand Krishnan
+ */
+//=============================================================================
+
#ifndef MT_SSLIOP_CLIENT_WORKER_H
#define MT_SSLIOP_CLIENT_WORKER_H
@@ -26,32 +23,33 @@
#include "testC.h"
+/**
+ * @class Client_Worker
+ *
+ * @brief Run the Client_Worker Thread
+ *
+ * Use the ACE_Task_Base class to run the client threads
+ */
class Client_Worker : public ACE_Task_Base
{
- // = TITLE
- // Run the Client_Worker Thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run the client threads
- //
public:
+ /// ctor
Client_Worker (Simple_Server_ptr server, int niterations);
- // ctor
+ /// thread entry point
virtual int svc (void);
- // thread entry point
private:
+ /// Validate the connection
void validate_connection (void);
- // Validate the connection
private:
+ /// The server.
Simple_Server_var server_;
- // The server.
+ /// The number of iterations on each client thread.
int niterations_;
- // The number of iterations on each client thread.
};
#if defined(_MSC_VER)
diff --git a/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h b/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h
index 61eb06ce0b5..c7ec4e6a1c2 100644
--- a/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h
+++ b/TAO/orbsvcs/tests/Security/MT_IIOP_SSL/test_i.h
@@ -1,34 +1,32 @@
-// $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
#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 ping (void);
diff --git a/TAO/orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h b/TAO/orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h
index 1d56173a596..68683c2c101 100644
--- a/TAO/orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h
+++ b/TAO/orbsvcs/tests/Security/MT_SSLIOP/Client_Worker.h
@@ -1,17 +1,14 @@
-// $Id$
-// ===========================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/Security/MT_SSLIOP
-//
-// = FILENAME
-// Client_Worker.h
-//
-// = AUTHOR
-// Anand Krishnan
-//
-// ===========================================================================
+//=============================================================================
+/**
+ * @file Client_Worker.h
+ *
+ * $Id$
+ *
+ * @author Anand Krishnan
+ */
+//=============================================================================
+
#ifndef MT_SSLIOP_CLIENT_WORKER_H
#define MT_SSLIOP_CLIENT_WORKER_H
@@ -26,37 +23,38 @@
#include "testC.h"
+/**
+ * @class Client_Worker
+ *
+ * @brief Run the Client_Worker Thread
+ *
+ * Use the ACE_Task_Base class to run the client threads
+ */
class Client_Worker : public ACE_Task_Base
{
- // = TITLE
- // Run the Client_Worker Thread
- //
- // = DESCRIPTION
- // Use the ACE_Task_Base class to run the client threads
- //
public:
+ /// ctor
Client_Worker (Simple_Server_ptr server,
Another_One_ptr another,
int niterations);
- // ctor
+ /// thread entry point
virtual int svc (void);
- // thread entry point
private:
+ /// Validate the connection
void validate_connection (void);
- // Validate the connection
private:
+ /// The server.
Simple_Server_var server_;
- // The server.
+ /// Another object served by the same server as server_.
Another_One_var another_;
- // Another object served by the same server as server_.
+ /// The number of iterations on each client thread.
int niterations_;
- // The number of iterations on each client thread.
};
#if defined(_MSC_VER)
diff --git a/TAO/orbsvcs/tests/Security/MT_SSLIOP/test_i.h b/TAO/orbsvcs/tests/Security/MT_SSLIOP/test_i.h
index 28dafc13474..0ec089a3b61 100644
--- a/TAO/orbsvcs/tests/Security/MT_SSLIOP/test_i.h
+++ b/TAO/orbsvcs/tests/Security/MT_SSLIOP/test_i.h
@@ -1,34 +1,32 @@
-// $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
#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.
CORBA::Long test_method (CORBA::Long x);
@@ -36,29 +34,30 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
+/**
+ * @class Another_One_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Another_One_i : public POA_Another_One
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Another_One_i (CORBA::ORB_ptr orb);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Long x);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.cpp b/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.cpp
index 83fb42dfe08..7c4c5c250b8 100644
--- a/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.cpp
+++ b/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.cpp
@@ -1,22 +1,20 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Naming_Service/
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client for the CosNaming
-// example using stubs generated by the TAO ORB IDL compiler.
-//
-// = AUTHORS
-// Sergio Flores-Gaitan <sergio@cs.wustl.edu>,
-// Marina Spivak <marina@cs.wustl.edu>, and
-// Douglas C. Schmidt <schmidt@cs.wustl.edu>
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client for the CosNaming
+ * example using stubs generated by the TAO ORB IDL compiler.
+ *
+ *
+ * @author Sergio Flores-Gaitan <sergio@cs.wustl.edu>
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ * @author and Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "client.h"
#include "tao/debug.h"
@@ -33,19 +31,19 @@ class My_Test_Object :
{
public:
// = Initialization and termination methods.
+ /// Constructor.
My_Test_Object (CORBA::Short id = 0);
- // Constructor.
+ /// Destructor.
~My_Test_Object (void);
- // Destructor.
// = Interface implementation accessor methods.
+ /// Sets id.
void id (CORBA::Short id);
- // Sets id.
+ /// Gets id.
CORBA::Short id (void);
- // Gets id.
private:
short id_;
diff --git a/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.h b/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.h
index dffdf271fd1..faf0c8ea0fe 100644
--- a/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.h
+++ b/TAO/orbsvcs/tests/Security/ssliop_corbaloc/client.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// This class tests the facilities to connect to the naming service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * This class tests the facilities to connect to the naming service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "test_objectS.h"
#include "orbsvcs/CosNamingC.h"
@@ -23,149 +20,163 @@
#include "tao/Utils/ORB_Manager.h"
#include "ace/Task.h"
+/**
+ * @class Naming_Test
+ *
+ * @brief This is an abstract class which is subclassed
+ * to create different Naming Service tests.
+ *
+ * This is a basic example of the "Strategy" pattern. This class
+ * provides a common interface for different tests (or
+ * "strategies"), so that a specific test to be used can be
+ * chosen at runtime.
+ */
class Naming_Test
{
- // = TITLE
- // This is an abstract class which is subclassed
- // to create different Naming Service tests.
- //
- // = DESCRIPTION
- // This is a basic example of the "Strategy" pattern. This class
- // provides a common interface for different tests (or
- // "strategies"), so that a specific test to be used can be
- // chosen at runtime.
public:
+ /// Execute the test code. <root_context> is the context to assume
+ /// as the root for all tests operations.
virtual ~Naming_Test (void) {}
virtual int execute (TAO_Naming_Client &root_context) = 0;
- // Execute the test code. <root_context> is the context to assume
- // as the root for all tests operations.
};
+/**
+ * @class Simple_Test
+ *
+ * @brief This class implements a simple Naming Service test.
+ *
+ * The test binds(), resolves(), and unbinds() an object
+ * reference from the given Naming Context.
+ */
class Simple_Test : public Naming_Test
{
- // = TITLE
- // This class implements a simple Naming Service test.
- //
- // = DESCRIPTION
- // The test binds(), resolves(), and unbinds() an object
- // reference from the given Naming Context.
public:
+ /// Execute the simple test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the simple test code.
};
+/**
+ * @class MT_Test
+ *
+ * @brief This class implements a simple Multithreaded (multiclient) Naming Service test.
+ *
+ * The test spawns multiple threads: each attempts to
+ * bind(), resolve(), and unbind() an object
+ * reference using the same name, and the same Naming Context.
+ */
class MT_Test : public Naming_Test, public ACE_Task_Base
{
- // = TITLE
- // This class implements a simple Multithreaded (multiclient) Naming Service test.
- //
- // = DESCRIPTION
- // The test spawns multiple threads: each attempts to
- // bind(), resolve(), and unbind() an object
- // reference using the same name, and the same Naming Context.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer and number of threads to spawn.
MT_Test (CORBA::ORB_ptr orb,
int size = 10);
- // Constructor. Takes in an orb pointer and number of threads to spawn.
+ /// Execute the MT test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the MT test code.
+ /// This code is executed by each thread.
virtual int svc (void);
- // This code is executed by each thread.
private:
+ /// Number of threads to spawn. By default is set to 10.
int size_;
- // Number of threads to spawn. By default is set to 10.
+ /// A pointer to our ORB.
CORBA::ORB_var orb_;
- // A pointer to our ORB.
+ /**
+ * IOR in the string format for Naming Service we are to deal with.
+ * Each thread will use string_to_object() and this IOR to create
+ * its own NamingContext stub for invoking operations on the
+ * Naming Service. If all threads try to use the same stub, bad things
+ * happen...
+ */
char* name_service_ior_;
- // IOR in the string format for Naming Service we are to deal with.
- // Each thread will use string_to_object() and this IOR to create
- // its own NamingContext stub for invoking operations on the
- // Naming Service. If all threads try to use the same stub, bad things
- // happen...
// This can be replaced with CORBA::String_var when <string_to_object>
// is fixed - this will clean up the memory properly.
+ /// Holds name used for registering the object with Naming Service.
CosNaming::Name test_name_;
- // Holds name used for registering the object with Naming Service.
+ /// Holds object to be registered with the Naming Service by each thread.
Test_Object_var test_ref_;
- // Holds object to be registered with the Naming Service by each thread.
};
+/**
+ * @class Tree_Test
+ *
+ * @brief This class implements a test of all Naming Service functions
+ * on a tree of Naming Contexts.
+ *
+ * Bind_context() under the root context with the name level1.
+ * Create_new_context(), bind() foo object into it, and
+ * bind the context into root/level1 under the name level2.
+ * Resolve (root/level1/level2/foo).
+ * Unbind (root/level1/level2/foo).
+ * Bind (root/level1/level2/foo, obj)
+ * Create_new_context()
+ * and invoke rebind_context() to substitute it for the current
+ * level2 context.
+ * Bind (root/level1/level2/foo, obj)
+ * Resolve (root/level1/level2/foo).
+ * Rebind() to have a different object under the name bar.
+ * Resolve (root/level1/level2/foo) to make sure correct reference is returned.
+ */
class Tree_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of all Naming Service functions
- // on a tree of Naming Contexts.
- //
- // = DESCRIPTION
- // Bind_context() under the root context with the name level1.
- // Create_new_context(), bind() foo object into it, and
- // bind the context into root/level1 under the name level2.
- // Resolve (root/level1/level2/foo).
- // Unbind (root/level1/level2/foo).
- // Bind (root/level1/level2/foo, obj)
- // Create_new_context()
- // and invoke rebind_context() to substitute it for the current
- // level2 context.
- // Bind (root/level1/level2/foo, obj)
- // Resolve (root/level1/level2/foo).
- // Rebind() to have a different object under the name bar.
- // Resolve (root/level1/level2/foo) to make sure correct reference is returned.
public:
+ /// Execute the tree test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the tree test code.
};
+/**
+ * @class Iterator_Test
+ *
+ * @brief This class implements a test of Naming Service functions
+ * which involve BindingIterator.
+ *
+ * The test binds foo1, foo2, foo3, and foo4 objects to the
+ * Naming Context. It lists() one binding and receives
+ * BindingIterator to iterate over the rest of the bindings. It
+ * then invokes next_one(), next_n(2), next_one(), and destroy()
+ * on the iterator.
+ */
class Iterator_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of Naming Service functions
- // which involve BindingIterator.
- //
- // = DESCRIPTION
- // The test binds foo1, foo2, foo3, and foo4 objects to the
- // Naming Context. It lists() one binding and receives
- // BindingIterator to iterate over the rest of the bindings. It
- // then invokes next_one(), next_n(2), next_one(), and destroy()
- // on the iterator.
public:
+ /// Execute the iterator test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the iterator test code.
};
+/**
+ * @class Exceptions_Test
+ *
+ * @brief This class implements a test of exceptions in the Naming Service.
+ *
+ * Makes sure that Naming Service throws exceptions as expected, and
+ * data inside exceptions is set correctly. The test creates a tree of
+ * of Naming Contexts: root context -> level1 -> level2. It then binds() an
+ * object with the name foo to each of Naming Contexts in the tree.
+ * Invoke resolve() with a Name of length 0 - make sure we get InvalidName exception.
+ * Invoke bind( foo, obj) on root context - make sure we get AlreadyBound exception.
+ * Invoke bind( level1/foo, obj) on root context - make sure we get AlreadyBound exc.
+ * Invoke unbind( level1/level2/bar) on root context - make sure we get NotFound exc.
+ * with why = not_object, rest_of_name = bar.
+ * Invoke unbind( level1/level3/foo) on root context - make sure we get NotFound exc.
+ * with why = missing_node, rest_of_name = level3/foo.
+ * Invoke unbind( level1/foo/foo) on root context - make sure we get NotFound exc.
+ * with why = not_context, rest_of_name = foo/foo.
+ */
class Exceptions_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of exceptions in the Naming Service.
- //
- // = DESCRIPTION
- // Makes sure that Naming Service throws exceptions as expected, and
- // data inside exceptions is set correctly. The test creates a tree of
- // of Naming Contexts: root context -> level1 -> level2. It then binds() an
- // object with the name foo to each of Naming Contexts in the tree.
- // Invoke resolve() with a Name of length 0 - make sure we get InvalidName exception.
- // Invoke bind( foo, obj) on root context - make sure we get AlreadyBound exception.
- // Invoke bind( level1/foo, obj) on root context - make sure we get AlreadyBound exc.
- // Invoke unbind( level1/level2/bar) on root context - make sure we get NotFound exc.
- // with why = not_object, rest_of_name = bar.
- // Invoke unbind( level1/level3/foo) on root context - make sure we get NotFound exc.
- // with why = missing_node, rest_of_name = level3/foo.
- // Invoke unbind( level1/foo/foo) on root context - make sure we get NotFound exc.
- // with why = not_context, rest_of_name = foo/foo.
public:
+ /// Execute the exceptions test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the exceptions test code.
private:
// the following functions isolate specific tests due to the
@@ -179,23 +190,23 @@ private:
void not_found_test3 (TAO_Naming_Client &root_context);
};
+/**
+ * @class Destroy_Test
+ *
+ * @brief This class implements a test of destroy() function
+ * in the Naming Service.
+ *
+ * Create a context and bind an object under it.
+ * Attempt to destroy the context - NotEmpty exception should be raised.
+ * Unbind the object and call destroy on the context.
+ * Attempt to call destroy on the object again - OBJECT_NOT_EXIST
+ * exception should be raised.
+ */
class Destroy_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of destroy() function
- // in the Naming Service.
- //
- // = DESCRIPTION
- // Create a context and bind an object under it.
- // Attempt to destroy the context - NotEmpty exception should be raised.
- //
- // Unbind the object and call destroy on the context.
- // Attempt to call destroy on the object again - OBJECT_NOT_EXIST
- // exception should be raised.
- //
public:
+ /// Execute the destroy test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the destroy test code.
private:
// = The following functions isolate specific tests.
@@ -203,100 +214,106 @@ private:
void not_exist_test (CosNaming::NamingContext_var &ref);
};
+/**
+ * @class Persistent_Test_Begin
+ *
+ * @brief This class implements the first part of the Persistent Naming
+ * Service test.
+ *
+ * This test creates the Naming Context hierarchy:
+ * root -> level1_context -> level2_context,
+ * and prints out the ior of the <level1_context>.
+ */
class Persistent_Test_Begin : public Naming_Test
{
- // = TITLE
- // This class implements the first part of the Persistent Naming
- // Service test.
- //
- // = DESCRIPTION
- // This test creates the Naming Context hierarchy:
- // root -> level1_context -> level2_context,
- // and prints out the ior of the <level1_context>.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer.
Persistent_Test_Begin (CORBA::ORB_ptr orb,
FILE * ior_output_file);
- // Constructor. Takes in an orb pointer.
+ /// Destructor.
virtual ~Persistent_Test_Begin (void);
- // Destructor.
+ /// Execute the persistent test (part 1) code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the persistent test (part 1) code.
private:
+ /// A pointer to our ORB (needed for object/string conversion).
CORBA::ORB_var orb_;
- // A pointer to our ORB (needed for object/string conversion).
+ /// File where we output the ior for use by part 2 of persistent test.
FILE *file_;
- // File where we output the ior for use by part 2 of persistent test.
};
+/**
+ * @class Persistent_Test_End
+ *
+ * @brief This class implements the second part of the Persistent Naming
+ * Service test.
+ *
+ * This test attempts to resolve <level2_context> both through the
+ * <root> Naming Context, which it gets from <resolve_initial_references>, and
+ * through <level1_context> stringified ior, which it gets from part 1 of
+ * the persistent test. The results of both methods are then
+ * compared for equality.
+ */
class Persistent_Test_End : public Naming_Test
{
- // = TITLE
- // This class implements the second part of the Persistent Naming
- // Service test.
- //
- // = DESCRIPTION
- // This test attempts to resolve <level2_context> both through the
- // <root> Naming Context, which it gets from <resolve_initial_references>, and
- // through <level1_context> stringified ior, which it gets from part 1 of
- // the persistent test. The results of both methods are then
- // compared for equality.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer and the ior received from
+ /// <Persistent_Test_Begin>.
Persistent_Test_End (CORBA::ORB_ptr orb,
const ACE_TCHAR * ior);
- // Constructor. Takes in an orb pointer and the ior received from
- // <Persistent_Test_Begin>.
+ /// Destructor.
virtual ~Persistent_Test_End (void);
- // Destructor.
+ /// Execute the persistent test (part 2).
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the persistent test (part 2).
private:
+ /// A pointer to our ORB (used for string/object conversion).
CORBA::ORB_var orb_;
- // A pointer to our ORB (used for string/object conversion).
+ /// IOR of <level1_context> recorded during the run of part 1 of
+ /// persistent test.
const ACE_TCHAR* ior_;
- // IOR of <level1_context> recorded during the run of part 1 of
- // persistent test.
};
+/**
+ * @class CosNaming_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of the CosNaming
+ * 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
+ * CosNaming CORBA server. All the complexity for initializing
+ * the server is hidden in the class. Just the <run> interface
+ * is needed.
+ */
class CosNaming_Client
{
- // = TITLE,
- // Defines a class that encapsulates behaviour of the CosNaming
- // 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
- // CosNaming 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.
CosNaming_Client (void);
- // Constructor.
+ /// Destructor.
~CosNaming_Client (void);
- // Destructor.
+ /// 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.
// = Symbolic ids.
enum OBJ_ID
@@ -306,22 +323,22 @@ public:
};
private:
+ /// 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.
+ /// A pointer to the specific Naming Service test a client will
+ /// execute.
Naming_Test *test_;
- // A pointer to the specific Naming Service test a client will
- // execute.
+ /// Our ORB manager helper class.
TAO_ORB_Manager orbmgr_;
- // Our ORB manager helper class.
+ /// Our naming client helper class.
TAO_Naming_Client naming_client_;
- // Our naming client helper class.
};
diff --git a/TAO/orbsvcs/tests/Simple_Naming/client.cpp b/TAO/orbsvcs/tests/Simple_Naming/client.cpp
index 601f2cac7bd..d8996e15ceb 100644
--- a/TAO/orbsvcs/tests/Simple_Naming/client.cpp
+++ b/TAO/orbsvcs/tests/Simple_Naming/client.cpp
@@ -1,22 +1,20 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Naming_Service/
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client for the CosNaming
-// example using stubs generated by the TAO ORB IDL compiler.
-//
-// = AUTHORS
-// Sergio Flores-Gaitan <sergio@cs.wustl.edu>,
-// Marina Spivak <marina@cs.wustl.edu>, and
-// Douglas C. Schmidt <schmidt@cs.wustl.edu>
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client for the CosNaming
+ * example using stubs generated by the TAO ORB IDL compiler.
+ *
+ *
+ * @author Sergio Flores-Gaitan <sergio@cs.wustl.edu>
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ * @author and Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "client.h"
#include "tao/debug.h"
@@ -33,19 +31,19 @@ class My_Test_Object :
{
public:
// = Initialization and termination methods.
+ /// Constructor.
My_Test_Object (CORBA::Short id = 0);
- // Constructor.
+ /// Destructor.
~My_Test_Object (void);
- // Destructor.
// = Interface implementation accessor methods.
+ /// Sets id.
void id (CORBA::Short id);
- // Sets id.
+ /// Gets id.
CORBA::Short id (void);
- // Gets id.
private:
short id_;
diff --git a/TAO/orbsvcs/tests/Simple_Naming/client.h b/TAO/orbsvcs/tests/Simple_Naming/client.h
index 81a3daa428b..ad381cd66bd 100644
--- a/TAO/orbsvcs/tests/Simple_Naming/client.h
+++ b/TAO/orbsvcs/tests/Simple_Naming/client.h
@@ -1,21 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// This class tests the facilities to connect to the naming service.
-//
-// = AUTHORS
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * This class tests the facilities to connect to the naming service.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "test_objectS.h"
#include "orbsvcs/CosNamingC.h"
@@ -23,23 +20,25 @@
#include "tao/Utils/ORB_Manager.h"
#include "ace/Task.h"
+/**
+ * @class Naming_Test
+ *
+ * @brief This is an abstract class which is subclassed
+ * to create different Naming Service tests.
+ *
+ * This is a basic example of the "Strategy" pattern. This class
+ * provides a common interface for different tests (or
+ * "strategies"), so that a specific test to be used can be
+ * chosen at runtime.
+ */
class Naming_Test
{
- // = TITLE
- // This is an abstract class which is subclassed
- // to create different Naming Service tests.
- //
- // = DESCRIPTION
- // This is a basic example of the "Strategy" pattern. This class
- // provides a common interface for different tests (or
- // "strategies"), so that a specific test to be used can be
- // chosen at runtime.
public:
+ /// Execute the test code. <root_context> is the context to assume
+ /// as the root for all tests operations.
virtual ~Naming_Test (void);
virtual int execute (TAO_Naming_Client &root_context) = 0;
- // Execute the test code. <root_context> is the context to assume
- // as the root for all tests operations.
protected:
Naming_Test (PortableServer::POA_ptr poa);
@@ -47,136 +46,148 @@ protected:
PortableServer::POA_var poa_;
};
+/**
+ * @class Simple_Test
+ *
+ * @brief This class implements a simple Naming Service test.
+ *
+ * The test binds(), resolves(), and unbinds() an object
+ * reference from the given Naming Context.
+ */
class Simple_Test : public Naming_Test
{
- // = TITLE
- // This class implements a simple Naming Service test.
- //
- // = DESCRIPTION
- // The test binds(), resolves(), and unbinds() an object
- // reference from the given Naming Context.
public:
Simple_Test (PortableServer::POA_ptr poa);
+ /// Execute the simple test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the simple test code.
};
+/**
+ * @class MT_Test
+ *
+ * @brief This class implements a simple Multithreaded (multiclient) Naming Service test.
+ *
+ * The test spawns multiple threads: each attempts to
+ * bind(), resolve(), and unbind() an object
+ * reference using the same name, and the same Naming Context.
+ */
class MT_Test : public Naming_Test, public ACE_Task_Base
{
- // = TITLE
- // This class implements a simple Multithreaded (multiclient) Naming Service test.
- //
- // = DESCRIPTION
- // The test spawns multiple threads: each attempts to
- // bind(), resolve(), and unbind() an object
- // reference using the same name, and the same Naming Context.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer and number of threads to spawn.
MT_Test (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa,
int size = 10);
- // Constructor. Takes in an orb pointer and number of threads to spawn.
+ /// Execute the MT test code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the MT test code.
+ /// This code is executed by each thread.
virtual int svc (void);
- // This code is executed by each thread.
private:
+ /// Number of threads to spawn. By default is set to 10.
int size_;
- // Number of threads to spawn. By default is set to 10.
+ /// A pointer to our ORB.
CORBA::ORB_var orb_;
- // A pointer to our ORB.
+ /**
+ * IOR in the string format for Naming Service we are to deal with.
+ * Each thread will use string_to_object() and this IOR to create
+ * its own NamingContext stub for invoking operations on the
+ * Naming Service. If all threads try to use the same stub, bad things
+ * happen...
+ */
CORBA::String_var name_service_ior_;
- // IOR in the string format for Naming Service we are to deal with.
- // Each thread will use string_to_object() and this IOR to create
- // its own NamingContext stub for invoking operations on the
- // Naming Service. If all threads try to use the same stub, bad things
- // happen...
// This can be replaced with CORBA::String_var when <string_to_object>
// is fixed - this will clean up the memory properly.
+ /// Holds name used for registering the object with Naming Service.
CosNaming::Name test_name_;
- // Holds name used for registering the object with Naming Service.
+ /// Holds object to be registered with the Naming Service by each thread.
Test_Object_var test_ref_;
- // Holds object to be registered with the Naming Service by each thread.
};
+/**
+ * @class Tree_Test
+ *
+ * @brief This class implements a test of all Naming Service functions
+ * on a tree of Naming Contexts.
+ *
+ * Bind_context() under the root context with the name level1.
+ * Create_new_context(), bind() foo object into it, and
+ * bind the context into root/level1 under the name level2.
+ * Resolve (root/level1/level2/foo).
+ * Unbind (root/level1/level2/foo).
+ * Bind (root/level1/level2/foo, obj)
+ * Create_new_context()
+ * and invoke rebind_context() to substitute it for the current
+ * level2 context.
+ * Bind (root/level1/level2/foo, obj)
+ * Resolve (root/level1/level2/foo).
+ * Rebind() to have a different object under the name bar.
+ * Resolve (root/level1/level2/foo) to make sure correct reference is returned.
+ */
class Tree_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of all Naming Service functions
- // on a tree of Naming Contexts.
- //
- // = DESCRIPTION
- // Bind_context() under the root context with the name level1.
- // Create_new_context(), bind() foo object into it, and
- // bind the context into root/level1 under the name level2.
- // Resolve (root/level1/level2/foo).
- // Unbind (root/level1/level2/foo).
- // Bind (root/level1/level2/foo, obj)
- // Create_new_context()
- // and invoke rebind_context() to substitute it for the current
- // level2 context.
- // Bind (root/level1/level2/foo, obj)
- // Resolve (root/level1/level2/foo).
- // Rebind() to have a different object under the name bar.
- // Resolve (root/level1/level2/foo) to make sure correct reference is returned.
public:
+ /// Execute the tree test code.
Tree_Test (PortableServer::POA_ptr poa);
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the tree test code.
};
+/**
+ * @class Iterator_Test
+ *
+ * @brief This class implements a test of Naming Service functions
+ * which involve BindingIterator.
+ *
+ * The test binds foo1, foo2, foo3, and foo4 objects to the
+ * Naming Context. It lists() one binding and receives
+ * BindingIterator to iterate over the rest of the bindings. It
+ * then invokes next_one(), next_n(2), next_one(), and destroy()
+ * on the iterator.
+ */
class Iterator_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of Naming Service functions
- // which involve BindingIterator.
- //
- // = DESCRIPTION
- // The test binds foo1, foo2, foo3, and foo4 objects to the
- // Naming Context. It lists() one binding and receives
- // BindingIterator to iterate over the rest of the bindings. It
- // then invokes next_one(), next_n(2), next_one(), and destroy()
- // on the iterator.
public:
+ /// Execute the iterator test code.
Iterator_Test (PortableServer::POA_ptr poa);
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the iterator test code.
};
+/**
+ * @class Exceptions_Test
+ *
+ * @brief This class implements a test of exceptions in the Naming Service.
+ *
+ * Makes sure that Naming Service throws exceptions as expected, and
+ * data inside exceptions is set correctly. The test creates a tree of
+ * of Naming Contexts: root context -> level1 -> level2. It then binds() an
+ * object with the name foo to each of Naming Contexts in the tree.
+ * Invoke resolve() with a Name of length 0 - make sure we get InvalidName exception.
+ * Invoke bind( foo, obj) on root context - make sure we get AlreadyBound exception.
+ * Invoke bind( level1/foo, obj) on root context - make sure we get AlreadyBound exc.
+ * Invoke unbind( level1/level2/bar) on root context - make sure we get NotFound exc.
+ * with why = not_object, rest_of_name = bar.
+ * Invoke unbind( level1/level3/foo) on root context - make sure we get NotFound exc.
+ * with why = missing_node, rest_of_name = level3/foo.
+ * Invoke unbind( level1/foo/foo) on root context - make sure we get NotFound exc.
+ * with why = not_context, rest_of_name = foo/foo.
+ */
class Exceptions_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of exceptions in the Naming Service.
- //
- // = DESCRIPTION
- // Makes sure that Naming Service throws exceptions as expected, and
- // data inside exceptions is set correctly. The test creates a tree of
- // of Naming Contexts: root context -> level1 -> level2. It then binds() an
- // object with the name foo to each of Naming Contexts in the tree.
- // Invoke resolve() with a Name of length 0 - make sure we get InvalidName exception.
- // Invoke bind( foo, obj) on root context - make sure we get AlreadyBound exception.
- // Invoke bind( level1/foo, obj) on root context - make sure we get AlreadyBound exc.
- // Invoke unbind( level1/level2/bar) on root context - make sure we get NotFound exc.
- // with why = not_object, rest_of_name = bar.
- // Invoke unbind( level1/level3/foo) on root context - make sure we get NotFound exc.
- // with why = missing_node, rest_of_name = level3/foo.
- // Invoke unbind( level1/foo/foo) on root context - make sure we get NotFound exc.
- // with why = not_context, rest_of_name = foo/foo.
public:
+ /// Execute the exceptions test code.
Exceptions_Test (PortableServer::POA_ptr poa);
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the exceptions test code.
private:
// the following functions isolate specific tests due to the
@@ -190,24 +201,24 @@ private:
void not_found_test3 (TAO_Naming_Client &root_context);
};
+/**
+ * @class Destroy_Test
+ *
+ * @brief This class implements a test of destroy() function
+ * in the Naming Service.
+ *
+ * Create a context and bind an object under it.
+ * Attempt to destroy the context - NotEmpty exception should be raised.
+ * Unbind the object and call destroy on the context.
+ * Attempt to call destroy on the object again - OBJECT_NOT_EXIST
+ * exception should be raised.
+ */
class Destroy_Test : public Naming_Test
{
- // = TITLE
- // This class implements a test of destroy() function
- // in the Naming Service.
- //
- // = DESCRIPTION
- // Create a context and bind an object under it.
- // Attempt to destroy the context - NotEmpty exception should be raised.
- //
- // Unbind the object and call destroy on the context.
- // Attempt to call destroy on the object again - OBJECT_NOT_EXIST
- // exception should be raised.
- //
public:
+ /// Execute the destroy test code.
Destroy_Test (PortableServer::POA_ptr poa);
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the destroy test code.
private:
// = The following functions isolate specific tests.
@@ -215,130 +226,138 @@ private:
void not_exist_test (CosNaming::NamingContext_var &ref);
};
+/**
+ * @class Persistent_Test_Begin
+ *
+ * @brief This class implements the first part of the Persistent Naming
+ * Service test.
+ *
+ * This test creates the Naming Context hierarchy:
+ * root -> level1_context -> level2_context,
+ * and prints out the ior of the <level1_context>.
+ */
class Persistent_Test_Begin : public Naming_Test
{
- // = TITLE
- // This class implements the first part of the Persistent Naming
- // Service test.
- //
- // = DESCRIPTION
- // This test creates the Naming Context hierarchy:
- // root -> level1_context -> level2_context,
- // and prints out the ior of the <level1_context>.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer.
Persistent_Test_Begin (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa,
FILE * ior_output_file);
- // Constructor. Takes in an orb pointer.
+ /// Destructor.
virtual ~Persistent_Test_Begin (void);
- // Destructor.
+ /// Execute the persistent test (part 1) code.
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the persistent test (part 1) code.
private:
+ /// A pointer to our ORB (needed for object/string conversion).
CORBA::ORB_var orb_;
- // A pointer to our ORB (needed for object/string conversion).
+ /// File where we output the ior for use by part 2 of persistent test.
FILE *file_;
- // File where we output the ior for use by part 2 of persistent test.
};
+/**
+ * @class Persistent_Test_End
+ *
+ * @brief This class implements the second part of the Persistent Naming
+ * Service test.
+ *
+ * This test attempts to resolve <level2_context> both through the
+ * <root> Naming Context, which it gets from <resolve_initial_references>, and
+ * through <level1_context> stringified ior, which it gets from part 1 of
+ * the persistent test. The results of both methods are then
+ * compared for equality.
+ */
class Persistent_Test_End : public Naming_Test
{
- // = TITLE
- // This class implements the second part of the Persistent Naming
- // Service test.
- //
- // = DESCRIPTION
- // This test attempts to resolve <level2_context> both through the
- // <root> Naming Context, which it gets from <resolve_initial_references>, and
- // through <level1_context> stringified ior, which it gets from part 1 of
- // the persistent test. The results of both methods are then
- // compared for equality.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer and the ior received from
+ /// <Persistent_Test_Begin>.
Persistent_Test_End (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa,
const ACE_TCHAR * ior);
- // Constructor. Takes in an orb pointer and the ior received from
- // <Persistent_Test_Begin>.
+ /// Destructor.
virtual ~Persistent_Test_End (void);
- // Destructor.
+ /// Execute the persistent test (part 2).
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the persistent test (part 2).
private:
+ /// A pointer to our ORB (used for string/object conversion).
CORBA::ORB_var orb_;
- // A pointer to our ORB (used for string/object conversion).
+ /// IOR of <level1_context> recorded during the run of part 1 of
+ /// persistent test.
const ACE_TCHAR* ior_;
- // IOR of <level1_context> recorded during the run of part 1 of
- // persistent test.
};
+/**
+ * @class Persistent_List_Test
+ *
+ * @brief This class implements the third part of the Persistent Naming
+ * Service test.
+ *
+ * This test attempts to invoke various list() methods on different
+ * known contexts.
+ */
class Persistent_List_Test : public Naming_Test
{
- // = TITLE
- // This class implements the third part of the Persistent Naming
- // Service test.
- //
- // = DESCRIPTION
- // This test attempts to invoke various list() methods on different
- // known contexts.
public:
// = Initialization and termination methods.
+ /// Constructor. Takes in an orb pointer.
Persistent_List_Test (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor. Takes in an orb pointer.
+ /// Destructor.
virtual ~Persistent_List_Test (void);
- // Destructor.
+ /// Execute the persistent test (part 3).
virtual int execute (TAO_Naming_Client &root_context);
- // Execute the persistent test (part 3).
private:
+ /// A pointer to our ORB (used for string/object conversion).
CORBA::ORB_var orb_;
- // A pointer to our ORB (used for string/object conversion).
};
+/**
+ * @class CosNaming_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of the CosNaming
+ * 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
+ * CosNaming CORBA server. All the complexity for initializing
+ * the server is hidden in the class. Just the <run> interface
+ * is needed.
+ */
class CosNaming_Client
{
- // = TITLE,
- // Defines a class that encapsulates behaviour of the CosNaming
- // 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
- // CosNaming 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.
CosNaming_Client (void);
- // Constructor.
+ /// Destructor.
~CosNaming_Client (void);
- // Destructor.
+ /// 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.
// = Symbolic ids.
enum OBJ_ID
@@ -348,22 +367,22 @@ public:
};
private:
+ /// 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.
+ /// A pointer to the specific Naming Service test a client will
+ /// execute.
Naming_Test *test_;
- // A pointer to the specific Naming Service test a client will
- // execute.
+ /// Our ORB manager helper class.
TAO_ORB_Manager orbmgr_;
- // Our ORB manager helper class.
+ /// Our naming client helper class.
TAO_Naming_Client naming_client_;
- // Our naming client helper class.
};
diff --git a/TAO/orbsvcs/tests/Time/Client_i.h b/TAO/orbsvcs/tests/Time/Client_i.h
index 7bc002f65bd..e49a5b5a7f7 100644
--- a/TAO/orbsvcs/tests/Time/Client_i.h
+++ b/TAO/orbsvcs/tests/Time/Client_i.h
@@ -1,99 +1,100 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/Time_Service
-//
-// = FILENAME
-// Client_i.h
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client that accesses a Time Service
-// server.
-//
-// = AUTHORS
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client that accesses a Time Service
+ * server.
+ *
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "orbsvcs/TimeServiceC.h"
#include "orbsvcs/Naming/Naming_Client.h"
+/**
+ * @class Client_i
+ *
+ * @brief Client implementation to access the Time Service server.
+ *
+ * Class wrapper for a client that gets the IOR of the clerk
+ * running on its machine and uses it to get the globally
+ * synchronized time
+ */
class Client_i
{
- // = TITLE
- // Client implementation to access the Time Service server.
- //
- // = DESCRIPTION
- // Class wrapper for a client that gets the IOR of the clerk
- // running on its machine and uses it to get the globally
- // synchronized time
public:
// = Initialization and termination methods.
+ /// Constructor.
Client_i (void);
- // Constructor.
+ /// Destructor.
~Client_i (void);
- // Destructor.
+ /// 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.
+ /**
+ * This test throws an exception that the operation
+ * <secure_universal_time> has not been currently implemented in the
+ * given server.
+ */
void test_for_secure_universal_time (void);
- // This test throws an exception that the operation
- // <secure_universal_time> has not been currently implemented in the
- // given server.
+ /// Tests if the server returns a valid time.
void test_for_universal_time (void);
- // Tests if the server returns a valid time.
+ /// Tests if the server returns a new UTO filled with the given time.
void test_for_new_universal_time (void);
- // Tests if the server returns a new UTO filled with the given time.
+ /// Tests if the returned UTO has the same value as the given UTC.
void test_for_uto_from_utc (void);
- // Tests if the returned UTO has the same value as the given UTC.
+ /// Tests if a new TIO is created according to the given bounds.
void test_for_new_interval (void);
- // Tests if a new TIO is created according to the given bounds.
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.
+ /// To initialize the naming service and get a clerk IOR.
int obtain_initial_references (void);
- // To initialize the naming service and get a clerk IOR.
+ /// # 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.
+ /// Number of times to invoke the <time> operation.
u_int loop_count_;
- // Number of times to invoke the <time> operation.
+ /// Flag for server shutdown.
int shutdown_;
- // Flag for server shutdown.
+ /// Time Service Server object ptr.
CosTime::TimeService_var clerk_;
- // Time Service Server object ptr.
+ /// An instance of the name client used for resolving the Time
+ /// Service object.
TAO_Naming_Client my_name_client_;
- // An instance of the name client used for resolving the Time
- // Service object.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
};
diff --git a/TAO/orbsvcs/tests/ior_corbaname/client.cpp b/TAO/orbsvcs/tests/ior_corbaname/client.cpp
index ebd1dbce9dc..38bc49a4ee9 100644
--- a/TAO/orbsvcs/tests/ior_corbaname/client.cpp
+++ b/TAO/orbsvcs/tests/ior_corbaname/client.cpp
@@ -1,23 +1,18 @@
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaname/
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This implements a simple CORBA client for the
-// corbaname: style IOR parser
-//
-// = AUTHOR
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This implements a simple CORBA client for the
+ * corbaname: style IOR parser
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "ior_corbaname_client_i.h"
diff --git a/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp b/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp
index 901bed185e4..00e39c3e1c6 100644
--- a/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp
+++ b/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.cpp
@@ -1,23 +1,19 @@
-// $Id$
-//
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaname/
-//
-// = FILENAME
-// ior_corbaname_client_i.cpp
-//
-// = DESCRIPTION
-// This example implements a simple client which sends a corbaname:
-// 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_corbaname_client_i.cpp
+ *
+ * $Id$
+ *
+ * This example implements a simple client which sends a corbaname:
+ * 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_corbaname_client_i.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h b/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h
index 18ab287ea32..01b69e8bbfc 100644
--- a/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h
+++ b/TAO/orbsvcs/tests/ior_corbaname/ior_corbaname_client_i.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ===========================================================
-//
-// = LIBRARY
-// TAO/tests/ior_corbaname/
-//
-// = FILENAME
-// ior_corbaname_client_i.h
-//
-// = DESCRIPTION
-// This class implements a simple client which sends a corbaname:
-// 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_corbaname_client_i.h
+ *
+ * $Id$
+ *
+ * This class implements a simple client which sends a corbaname:
+ * 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_CORBANAME_CLIENT_I_H)
#define IOR_CORBANAME_CLIENT_I_H
@@ -25,38 +22,39 @@
#include "corbanameC.h"
#include "orbsvcs/CosNamingC.h"
+/**
+ * @class IOR_corbaname_Client_i
+ *
+ * @brief NContextExt Client Implementation
+ *
+ */
class IOR_corbaname_Client_i
{
- // = TITLE
- // NContextExt Client Implementation
- //
- // = DESCRIPTION
- //
public:
// = Constructor and destructor.
IOR_corbaname_Client_i (void);
~IOR_corbaname_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:
+ /// # 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.
+ /// ORB
CORBA::ORB_var orb_;
- // ORB
+ /// Naming context
CosNaming::NamingContextExt_var naming_context_;
- // Naming context
};
#endif /* IOR_CORBANAME_CLIENT_I_H */
diff --git a/TAO/orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp b/TAO/orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp
index 6240aaf0ada..db355c8d2d4 100644
--- a/TAO/orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp
+++ b/TAO/orbsvcs/tests/tests_svc_loader/tests_svc_loader.cpp
@@ -1,26 +1,23 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// orbsvcs/tests/tests_svc_loader
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This directory contains a client that checks if a given object
-// reference points to an existing object or not and prints a debug
-// statement to reflect the same. This client is to be used in
-// conjunction with testing the dynamically loadable services. If
-// the service is loaded successfully, the object reference from the
-// server would be a valid one and the corresponding debug statement
-// is printed out. Or viceversa.
-//
-// = AUTHOR
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This directory contains a client that checks if a given object
+ * reference points to an existing object or not and prints a debug
+ * statement to reflect the same. This client is to be used in
+ * conjunction with testing the dynamically loadable services. If
+ * the service is loaded successfully, the object reference from the
+ * server would be a valid one and the corresponding debug statement
+ * is printed out. Or viceversa.
+ *
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/Object.h"
diff --git a/TAO/performance-tests/Anyop/anyop.cpp b/TAO/performance-tests/Anyop/anyop.cpp
index 1dd81d9d307..fd82626063f 100644
--- a/TAO/performance-tests/Anyop/anyop.cpp
+++ b/TAO/performance-tests/Anyop/anyop.cpp
@@ -1,22 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Anyop
-//
-// = FILENAME
-// anyop.cpp
-//
-// = DESCRIPTION
-// Modified from anyop.cpp in Param_Test to benchmark Any insertion and
-// extraction operators for various IDL types.
-//
-// = AUTHORS
-// Carlos O'Ryan
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file anyop.cpp
+ *
+ * $Id$
+ *
+ * Modified from anyop.cpp in Param_Test to benchmark Any insertion and
+ * extraction operators for various IDL types.
+ *
+ *
+ * @author Carlos O'RyanJeff Parsons
+ */
+//=============================================================================
+
#include "testC.h"
#include "tao/debug.h"
diff --git a/TAO/performance-tests/Cubit/TAO/DII_Cubit/client.cpp b/TAO/performance-tests/Cubit/TAO/DII_Cubit/client.cpp
index 4ef6e8bf124..1320adc03b8 100644
--- a/TAO/performance-tests/Cubit/TAO/DII_Cubit/client.cpp
+++ b/TAO/performance-tests/Cubit/TAO/DII_Cubit/client.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Cubit/TAO/DII_Cubit
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This class implements a simple CORBA client of the Cubit
-// interface using DII functionality.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple CORBA client of the Cubit
+ * interface using DII functionality.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "tao/DynamicInterface/Request.h"
#include "tao/debug.h"
@@ -40,44 +37,46 @@ const int SMALL_LONG_SEQ_LENGTH = 4;
const int LARGE_LONG_SEQ_LENGTH = 1024;
const int NUMBER_OF_TESTS = 10;
+/**
+ * @class DII_Cubit_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of a Cubit client
+ * that makes requests using DII rather than stubs.
+ *
+ * This class declares an interface to run an example client for
+ * a Cubit CORBA server. All the complexity for initializing the
+ * client is hidden in the class. Just the run() interface is
+ * needed.
+ */
class DII_Cubit_Client
{
- // = TITLE
- // Defines a class that encapsulates behaviour of a Cubit client
- // that makes requests using DII rather than stubs.
- //
- // = DESCRIPTION
- // This class declares an interface to run an example client for
- // a Cubit CORBA server. All the complexity for initializing the
- // client is hidden in the class. Just the run() interface is
- // needed.
public:
// = Constructor and destructor.
+ /// Constructor.
DII_Cubit_Client (void);
- // Constructor.
+ /// Destructor.
~DII_Cubit_Client (void);
- // Destructor.
+ /// Initialize the ORB and gets the Cubit objref.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the ORB and gets the Cubit objref.
+ /// Execute client example code.
int run (void);
- // Execute client example code.
private:
+ /// Gets objref through naming service.
int init_naming_service (void);
- // Gets objref through naming service.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Function to read the cubit factory IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the cubit factory IOR from a file.
+ /// Prints the timing stats.
void print_stats (const char *call_name,
ACE_Profile_Timer::ACE_Elapsed_Time &elapsed_time);
- // Prints the timing stats.
// = DII versions of Cubit operations:
@@ -91,54 +90,54 @@ private:
// = Wrappers for cubing small and large sequences w/o args:
+ /// Wrapper for the mixin call, just to be neat.
void cube_small_long_seq (void);
void cube_large_long_seq (void);
void cube_small_octet_seq (void);
void cube_large_octet_seq (void);
void cube_mixin (void);
- // Wrapper for the mixin call, just to be neat.
+ /// Array of pointers to the operation functions.
void (DII_Cubit_Client::*op_array_[NUMBER_OF_TESTS])(void);
- // Array of pointers to the operation functions.
+ /// Array of labels for passing to print_stats.
static const char *stats_messages_[];
- // Array of labels for passing to print_stats.
+ /// # 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.
+ /// # of calls in test loop.
CORBA::ULong loop_count_;
- // # of calls in test loop.
+ /// Flag to tell server to exit.
int shutdown_;
- // Flag to tell server to exit.
+ /// Storage of the ORB reference.
CORBA::ORB_var orb_var_;
- // Storage of the ORB reference.
+ /// Storage of the Cubit_factory objref
CORBA::Object_var factory_var_;
- // Storage of the Cubit_factory objref
+ /// Storage of the Cubit objref.
CORBA::Object_var obj_var_;
- // Storage of the Cubit objref.
+ /// # of calls made to functions.
CORBA::ULong call_count_;
- // # of calls made to functions.
+ /// # of errors incurred in the lifetime of the application.
CORBA::ULong error_count_;
- // # of errors incurred in the lifetime of the application.
+ /// IOR of the factory used to make a Cubit object.
ACE_CString factory_IOR_;
- // IOR of the factory used to make a Cubit object.
+ /// File from which to obtain the IOR.
FILE *cubit_factory_ior_file_;
- // File from which to obtain the IOR.
+ /// File handle to read the IOR.
ACE_HANDLE f_handle_;
- // File handle to read the IOR.
};
// Constructor
diff --git a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h
index 39696deb2a4..8f5cebe215a 100644
--- a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h
+++ b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Client.h
@@ -1,22 +1,20 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Cubit
-//
-// = FILENAME
-// Cubit_Client.h
-//
-// = DESCRIPTION
-// This class implements a simple "cube" CORBA client for the Cubit
-// example using stubs generated by the TAO ORB IDL compiler.
-//
-// = AUTHORS
-// Aniruddha Gokhale, Sumedh Mungee, and Sergio Flores-Gaitan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Cubit_Client.h
+ *
+ * $Id$
+ *
+ * This class implements a simple "cube" CORBA client for the Cubit
+ * example using stubs generated by the TAO ORB IDL compiler.
+ *
+ *
+ * @author Aniruddha Gokhale
+ * @author Sumedh Mungee
+ * @author and Sergio Flores-Gaitan
+ */
+//=============================================================================
+
#ifndef _CUBIT_CLIENT_H
#define _CUBIT_CLIENT_H
@@ -31,147 +29,149 @@
#include "tao/ORB_Constants.h"
#include "cubitC.h"
+/**
+ * @class Cubit_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of the Cubit 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
+ * Cubit CORBA server. All the complexity for initializing the
+ * server is hidden in the class. Just the run() interface is needed.
+ */
class Cubit_Client
{
- // = TITLE
- // Defines a class that encapsulates behaviour of the Cubit 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
- // Cubit CORBA server. All the complexity for initializing the
- // server is hidden in the class. Just the run() interface is needed.
public:
// = Constructor and destructor.
Cubit_Client (int shutdown = 0);
~Cubit_Client (void);
+ /// Execute client example code.
int run ();
- // Execute client example code.
+ /// Initialize the client communication endpoint with server.
+ /// <collocation_test_ior> is used to pass in the ior file name.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the client communication endpoint with server.
- // <collocation_test_ior> is used to pass in the ior file name.
private:
+ /// Simple function that returns the subtraction of 117 from the
+ /// parameter.
int func (u_int i);
- // Simple function that returns the subtraction of 117 from the
- // parameter.
+ /// Function to read the cubit factory ior from a file.
int read_ior (const ACE_TCHAR *filename);
- // Function to read the cubit factory ior from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Obtain the bit mask representation of the specified test
u_int opt_to_mask (const ACE_TCHAR *opt);
- // Obtain the bit mask representation of the specified test
+ /// Enable the specified test.
void enable_test (u_int mask);
- // Enable the specified test.
+ /// Disable the specified test.
void disable_test (u_int mask);
- // Disable the specified test.
+ /// Check if the specified test has been enabled.
int check_enabled (u_int mask) const;
- // Check if the specified test has been enabled.
+ /// Prints the time stats.
void print_stats (const char *call_name,
ACE_Profile_Timer::ACE_Elapsed_Time &elapsed_time);
- // Prints the time stats.
+ /// Exercise the union. Cube a union.
void cube_union (void);
- // Exercise the union. Cube a union.
+ /// calculate the cube from a struct.
void cube_struct (int i);
- // calculate the cube from a struct.
+ /// calculate the cube from a long.
void cube_long (int i);
- // calculate the cube from a long.
+ /// Oneway operation test.
void cube_oneway (int i);
- // Oneway operation test.
+ /// Twoway operation test.
void cube_void (int i);
- // Twoway operation test.
+ /// Cube an octet.
void cube_octet (int i);
- // Cube an octet.
+ /// Cube a short.
void cube_short (int i);
- // Cube a short.
+ /// Cube a sequence <l> is the length of the sequence.
void cube_long_sequence (int i, int l);
- // Cube a sequence <l> is the length of the sequence.
+ /// Cube a sequence of octets, <l> is the length of the sequence.
void cube_octet_sequence (int i, int l);
- // Cube a sequence of octets, <l> is the length of the sequence.
+ /// Cube a sequence of manys, <l> is the length of the sequence.
void cube_many_sequence (int i, int l);
- // Cube a sequence of manys, <l> is the length of the sequence.
+ /// Cube a sequence <l> is the length of the sequence.
void cube_rti_data (int i, int numUpdates, int numAttrs);
- // Cube a sequence <l> is the length of the sequence.
+ /// calculate the cube from a struct in an any.
void cube_any_struct (int i);
- // calculate the cube from a struct in an any.
+ /// calculate the cube from a long in an any.
void cube_any (int i);
- // calculate the cube from a long in an any.
+ /// Invoke the method with <do_shutdown> != 0 to shutdown the server.
int shutdown_server (int do_shutdown);
- // Invoke the method with <do_shutdown> != 0 to shutdown the server.
+ /// # 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.
ACE_TCHAR *cubit_factory_key_;
- // Key of factory obj ref.
+ /// Number of times to do the cube operations.
u_int loop_count_;
- // Number of times to do the cube operations.
+ /// Flag to tell server to shutdown.
int shutdown_;
- // Flag to tell server to shutdown.
+ /// If set the test goes into quiet mode
int quiet_;
- // If set the test goes into quiet mode
+ /// Remember our orb, must show up before the other objects to
+ /// shutdown in the proper order.
CORBA::ORB_var orb_;
- // Remember our orb, must show up before the other objects to
- // shutdown in the proper order.
+ /// factory pointer for cubit.
Cubit_Factory_var factory_;
- // factory pointer for cubit.
+ /// Cubit obj ref.
Cubit_var cubit_;
- // Cubit obj ref.
+ /// # of calls made to functions.
u_int call_count_;
- // # of calls made to functions.
+ /// # of errors incurred in the lifetime of the application.
u_int error_count_;
- // # of errors incurred in the lifetime of the application.
+ /// File from which to obtain the IOR.
FILE *cubit_factory_ior_file_;
- // File from which to obtain the IOR.
+ /// File handle to read the IOR.
ACE_HANDLE f_handle_;
- // File handle to read the IOR.
+ /// The number of bytes to send in the octet sequence test.
u_int bytes_in_octet_sequence_;
- // The number of bytes to send in the octet sequence test.
+ /// Bitset that determines which tests get run.
u_int test_enable_bitset_;
- // Bitset that determines which tests get run.
+ /// Bitset that determines which tests do not get run.
u_int test_disable_bitset_;
- // Bitset that determines which tests do not get run.
};
#endif /* _CUBIT_CLIENT_H */
diff --git a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h
index 692283a8cea..37459496aef 100644
--- a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h
+++ b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_Server.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Cubit
-//
-// = FILENAME
-// Cubit_Server.h
-//
-// = DESCRIPTION
-// This class implements a simple "cube" CORBA server for the Cubit
-// example using skeletons generated by the TAO ORB IDL compiler.
-//
-// = AUTHORS
-// Nagarajan Surendran (naga@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Cubit_Server.h
+ *
+ * $Id$
+ *
+ * This class implements a simple "cube" CORBA server for the Cubit
+ * example using skeletons generated by the TAO ORB IDL compiler.
+ *
+ *
+ * @author Nagarajan Surendran (naga@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef _CUBIT_SERVER_H
#define _CUBIT_SERVER_H
@@ -32,52 +28,54 @@
#include "Cubit_Client.h"
#include "Cubit_i.h"
+/**
+ * @class Cubit_Server
+ *
+ * @brief Defines a Cubit 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 cubit_server's state and then call run
+ * to run the orb.
+ */
class Cubit_Server
{
- // = TITLE
- // Defines a Cubit 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 cubit_server's state and then call run
- // to run the orb.
public:
// = Initialization and termination methods.
+ /// Default constructor
Cubit_Server (void);
- // Default constructor
+ /// Destructor
~Cubit_Server (void);
- // Destructor
+ /// Initialize the Cubit_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the Cubit_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// File to output the cubit factory IOR.
FILE* ior_output_file_;
- // File to output the cubit factory IOR.
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// Implementation object of the cubit factory.
Cubit_Factory_i *factory_impl_;
- // Implementation object of the cubit factory.
+ /// Id of the factory.
CORBA::String_var factory_id_;
- // Id of the factory.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
};
#endif /* _CUBIT_SERVER_H */
diff --git a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp
index 67712e47077..37acb7c6821 100644
--- a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp
+++ b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.cpp
@@ -1,17 +1,15 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Cubit
-//
-// = FILENAME
-// Cubit_i.cpp
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee and Sergio Flores-Gaitan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Cubit_i.cpp
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee and Sergio Flores-Gaitan
+ */
+//=============================================================================
+
#include "Cubit_Client.h"
#include "Cubit_i.h"
diff --git a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h
index 4de76ae2b4d..54631d26bdf 100644
--- a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h
+++ b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/Cubit_i.h
@@ -1,17 +1,15 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Cubit
-//
-// = FILENAME
-// Cubit_Client.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee and Sergio Flores-Gaitan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Cubit_Client.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee and Sergio Flores-Gaitan
+ */
+//=============================================================================
+
#ifndef _CUBIT_I_H
#define _CUBIT_I_H
@@ -21,67 +19,69 @@
// Forward declarations.
class Cubit_i;
+/**
+ * @class Cubit_i
+ *
+ * @brief Illustrates how to integrate a servant with the generated
+ * skeleton.
+ *
+ * Implementation of the cubit example at the servant side.
+ * Cubes an octet, short, long, struct and union.
+ */
class Cubit_i : public POA_Cubit
{
- // = TITLE
- // Illustrates how to integrate a servant with the generated
- // skeleton.
- //
- // = DESCRIPTION
- // Implementation of the cubit example at the servant side.
- // Cubes an octet, short, long, struct and union.
public:
+ /// Constructor
Cubit_i (CORBA::ORB_ptr orb);
- // Constructor
+ /// Destructor
~Cubit_i (void);
- // Destructor
+ /// Returns the default POA for this servant.
virtual PortableServer::POA_ptr _default_POA (void);
- // Returns the default POA for this servant.
+ /// Test a oneway call.
virtual void cube_oneway (void);
- // Test a oneway call.
+ /// Test a twoway call.
virtual void cube_void (void);
- // Test a twoway call.
+ /// Cube an octet
virtual CORBA::Octet cube_octet (CORBA::Octet o);
- // Cube an octet
+ /// Cube a short
virtual CORBA::Short cube_short (CORBA::Short s);
- // Cube a short
+ /// Cube a long
virtual CORBA::Long cube_long (CORBA::Long l);
- // Cube a long
+ /// Cube a struct.
virtual Cubit::Many cube_struct (const Cubit::Many &values);
- // Cube a struct.
+ /// Cube a union.
virtual Cubit::oneof cube_union (const Cubit::oneof &values);
- // Cube a union.
+ /// Cube a sequence.
virtual void cube_long_sequence (const Cubit::long_seq &input,
Cubit::long_seq_out output);
- // Cube a sequence.
+ /// Cube an octet sequence.
virtual void cube_octet_sequence (const Cubit::octet_seq &input,
Cubit::octet_seq_out output);
- // Cube an octet sequence.
+ /// Cube an Many sequence.
virtual void cube_many_sequence (const Cubit::many_seq & input,
Cubit::many_seq_out output);
- // Cube an Many sequence.
+ /// Cube a sequence.
virtual void cube_rti_data (const Cubit::RtiPacket &input,
Cubit::RtiPacket_out output);
- // Cube a sequence.
+ /// Cube a long in an any
virtual CORBA::Any * cube_any (const CORBA::Any & any);
- // Cube a long in an any
+ /// Cube a struct in an any
virtual CORBA::Any * cube_any_struct (const CORBA::Any & any);
- // Cube a struct in an any
/// Shutdown routine.
virtual void shutdown (void);
@@ -91,32 +91,34 @@ public:
virtual void ping (void);
+ /// Set default poa.
void set_default_poa (PortableServer::POA_ptr poa);
- // Set default poa.
protected:
PortableServer::POA_var poa_;
+ /// Keep a pointer to the ORB so we can shut it down.
CORBA::ORB_var orb_;
- // Keep a pointer to the ORB so we can shut it down.
};
+/**
+ * @class Cubit_Factory_i:
+ *
+ * @brief Cubit_Factory_i
+ *
+ * Factory object returning the cubit objrefs
+ */
class Cubit_Factory_i: public POA_Cubit_Factory
{
- // = TITLE
- // Cubit_Factory_i
- //
- // = DESCRIPTION
- // Factory object returning the cubit objrefs
public:
+ /// Constructor.
Cubit_Factory_i (CORBA::ORB_ptr orb);
- // Constructor.
+ /// Destructor.
~Cubit_Factory_i (void);
- // Destructor.
+ /// Make a cubit object.
virtual Cubit_ptr make_cubit (void);
- // Make a cubit object.
void set_default_poa (PortableServer::POA_ptr poa);
diff --git a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h
index 31b2ca800f0..f35a834746a 100644
--- a/TAO/performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h
+++ b/TAO/performance-tests/Cubit/TAO/IDL_Cubit/RTI_IO.h
@@ -1,17 +1,14 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Cubit
-//
-// = FILENAME
-// RTI_IO.h
-//
-// = AUTHOR
-// Dave Meyer <dmeyer@std.saic.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file RTI_IO.h
+ *
+ * $Id$
+ *
+ * @author Dave Meyer <dmeyer@std.saic.com>
+ */
+//=============================================================================
+
#ifndef _RTIFUNCS_H
#define _RTIFUNCS_H
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h
index 88ca93c90a5..60e75e00e3a 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Cubit_Task.h
@@ -1,18 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// Cubit_Task.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee,Sergio Flores-Gaitan and Nagarajan Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Cubit_Task.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef MT_CUBIT_TASK_H
#define MT_CUBIT_TASK_H
@@ -28,61 +27,64 @@
#include "cubit_i.h"
#include "Globals.h"
+/**
+ * @class Cubit_Task
+ *
+ * @brief Encapsulates an ORB for the Cubit application.
+ */
class Cubit_Task : public ACE_Task<ACE_SYNCH>
{
- // = TITLE
- // Encapsulates an ORB for the Cubit application.
public:
+ /// Constructor.
Cubit_Task (const ACE_TCHAR *args,
const char* orbname,
u_int num_of_objs,
ACE_Thread_Manager *thr_mgr,
u_int task_id);
- // Constructor.
+ /// Active Object entry point.
virtual int svc (void);
- // Active Object entry point.
+ /// Gets the ior of the cubit servant in this task.
char* get_servant_ior (u_int index);
- // Gets the ior of the cubit servant in this task.
protected:
+ /// No-op constructor.
Cubit_Task (void);
- // No-op constructor.
private:
+ /// Initialize the ORB, and POA.
int initialize_orb (void);
- // Initialize the ORB, and POA.
+ /// Create the servants.
int create_servants (void);
- // Create the servants.
+ /// All cubit objects will have this as prefix to its key.
const char *key_;
- // All cubit objects will have this as prefix to its key.
+ /// Name of the ORB.
const char *orbname_;
- // Name of the ORB.
+ /// ORB arguments.
const ACE_TCHAR *orbargs_;
- // ORB arguments.
+ /// Number of objects we're managing.
u_int num_of_objs_;
- // Number of objects we're managing.
+ /// Pointer to the ORB
CORBA::ORB_var orb_;
- // Pointer to the ORB
+ /// Array to hold the servants.
Cubit_i **servants_;
- // Array to hold the servants.
+ /// IOR strings of the servants.
char **servants_iors_;
- // IOR strings of the servants.
+ /// ID used for naming service object name.
u_int task_id_;
- // ID used for naming service object name.
+ /// The TAO ORB Manager.
TAO_ORB_Manager orb_manager_;
- // The TAO ORB Manager.
};
#endif /* MT_CUBIT_TASK_H */
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Globals.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Globals.h
index fd18a5d03d7..21b99dcb31e 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Globals.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Globals.h
@@ -1,25 +1,22 @@
// -*- C++ -*-
-// $Id$
#ifndef GLOBALS_H
#define GLOBALS_H
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// Globals.h
-//
-// = DESCRIPTION
-// All the globally defined classes, functions, types, and #defines
-// are centralized here.
-//
-// = AUTHOR
-// Nagarajan Surendran <naga@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Globals.h
+ *
+ * $Id$
+ *
+ * All the globally defined classes, functions, types, and #defines
+ * are centralized here.
+ *
+ *
+ * @author Nagarajan Surendran <naga@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/config-all.h"
@@ -99,112 +96,120 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Barrier;
ACE_END_VERSIONED_NAMESPACE_DECL
+/**
+ * @class Globals
+ *
+ * @brief Globals class to be used as a singleton.
+ *
+ * This is used both by the server and client.
+ */
class Globals
{
- // = TITLE
- // Globals class to be used as a singleton.
- //
- // = DESCRIPTION
- // This is used both by the server and client.
public:
+ /// default constructor.
Globals (void);
- // default constructor.
+ /// parse the arguments.
int parse_args (int argc, ACE_TCHAR **argv);
- // parse the arguments.
+ /**
+ * Enables fifo scheduling eg., RT scheduling class on solaris.
+ * Returns 0 on success, 1 if insufficient permission, or -1
+ * for other failure. As a side effect, sets thr_create_flags
+ * appropriately.
+ */
static int sched_fifo_init (void);
- // Enables fifo scheduling eg., RT scheduling class on solaris.
- // Returns 0 on success, 1 if insufficient permission, or -1
- // for other failure. As a side effect, sets thr_create_flags
- // appropriately.
+ /// Thread creation flags. Must call sched_fifo_init () before
+ /// accessing.
long thr_create_flags;
- // Thread creation flags. Must call sched_fifo_init () before
- // accessing.
+ /// Default thread priority, used for the high thread priority.
+ /// Must call sched_fifo_init () before accessing.
int default_priority;
- // Default thread priority, used for the high thread priority.
- // Must call sched_fifo_init () before accessing.
+ /// endpoint to be used for ORB_init.
ACE_TCHAR endpoint[BUFSIZ];
- // endpoint to be used for ORB_init.
+ /// file name to read/write the iors of the servants.
ACE_TCHAR *ior_file;
- // file name to read/write the iors of the servants.
+ /// number of objects per servant thread.
u_int num_of_objs;
- // number of objects per servant thread.
+ /// thread_per_rate test flag.
u_int thread_per_rate;
- // thread_per_rate test flag.
+ /// flag to use multiple priorities for the low priority servants
+ /// instead of one priority.
u_int use_multiple_priority;
- // flag to use multiple priorities for the low priority servants
- // instead of one priority.
+ /// ready flag used by the high priority thread to wake up the low
+ /// priority threads after it's parsed the arguments.
int ready_;
- // ready flag used by the high priority thread to wake up the low
- // priority threads after it's parsed the arguments.
+ /// mutex for the condition variable.
TAO_SYNCH_MUTEX ready_mtx_;
- // mutex for the condition variable.
+ /// condition variable for the low priority threads to wait
+ ///until the high priority thread is done with the arguments parsing.
TAO_SYNCH_CONDITION ready_cnd_;
- // condition variable for the low priority threads to wait
- //until the high priority thread is done with the arguments parsing.
+ /// Barrier for the multiple servants to synchronize after binding to
+ /// the orb.
ACE_Barrier *barrier_;
- // Barrier for the multiple servants to synchronize after binding to
- // the orb.
};
// Make the globals a Singleton.
typedef ACE_Singleton<Globals,ACE_Null_Mutex> GLOBALS;
+/**
+ * @class MT_Priority
+ *
+ * @brief Helper class to find high and low priorities for the
+ * MT_Cubit application over multiple platforms.
+ *
+ * This class has 2 methods, one for the high priority and the
+ * other for low priority.If the flag use_multiple_priority is
+ * passed then multiple priorities are used for the low priority
+ * threads.
+ */
class MT_Priority
{
- // = TITLE
- // Helper class to find high and low priorities for the
- // MT_Cubit application over multiple platforms.
- //
- // = DESCRIPTION
- // This class has 2 methods, one for the high priority and the
- // other for low priority.If the flag use_multiple_priority is
- // passed then multiple priorities are used for the low priority
- // threads.
public:
+ /// constructor.
MT_Priority (void);
- // constructor.
/// Destructor.
virtual ~MT_Priority (void);
+ /// Sets the priority of the high priority thread.
virtual ACE_Sched_Priority get_high_priority (void);
- // Sets the priority of the high priority thread.
+ /// Sets the priority to be used for the low priority thread.
virtual ACE_Sched_Priority get_low_priority
(u_int num_low_priority,
ACE_Sched_Priority prev_priority,
u_int use_multiple_priority);
- // Sets the priority to be used for the low priority thread.
+ /// Accessor for num_priorities_.
u_int number_of_priorities (void);
- // Accessor for num_priorities_.
+ /// Accessor for grain_.
u_int grain (void);
- // Accessor for grain_.
protected:
+ /// Number of priorities used.
u_int num_priorities_;
- // Number of priorities used.
+ /**
+ * Granularity of the assignment of the priorities. Some OSs have
+ * fewer levels of priorities than we have threads in our test, so
+ * with this mechanism we assign priorities to groups of threads
+ * when there are more threads than priorities.
+ */
u_int grain_;
- // Granularity of the assignment of the priorities. Some OSs have
- // fewer levels of priorities than we have threads in our test, so
- // with this mechanism we assign priorities to groups of threads
- // when there are more threads than priorities.
};
#endif /* GLOBALS_H */
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h
index 9d9e10b1f9c..0fd4f3fc865 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Task_Client.h
@@ -1,19 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// Task_Client.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee, Sergio Flores-Gaitan, and
-// Nagarajan Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Task_Client.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan
+ * @author and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef TASK_CLIENT_H
#define TASK_CLIENT_H
@@ -90,267 +89,281 @@ enum Cubit_Datatypes
typedef ACE_Unbounded_Queue<ACE_timer_t> JITTER_ARRAY;
typedef ACE_Unbounded_Queue_Iterator<ACE_timer_t> JITTER_ARRAY_ITERATOR;
+/**
+ * @class Task_State
+ *
+ * @brief Maintains state common to multiple Cubit clients.
+ *
+ * This class maintains state which is common to the potentially
+ * multiple concurrent clients.
+ */
class Task_State
{
- // = TITLE
- // Maintains state common to multiple Cubit clients.
- //
- // = DESCRIPTION
- // This class maintains state which is common to the potentially
- // multiple concurrent clients.
public:
+ /// Constructor.
Task_State (void);
- // Constructor.
+ /// parses the arguments with the provided argc and argv.
int parse_args (int argc,ACE_TCHAR **argv);
- // parses the arguments with the provided argc and argv.
+ /// Destructor
~Task_State (void);
- // Destructor
+ /// Barrier for the multiple clients to synchronize after binding to
+ /// the servants.
ACE_Barrier *barrier_;
- // Barrier for the multiple clients to synchronize after binding to
- // the servants.
+ /// All cubit objects will have this as prefix to its key.
const char *key_;
- // All cubit objects will have this as prefix to its key.
+ /// Number of times to loop, making calls.
u_int loop_count_;
- // Number of times to loop, making calls.
+ /// Number of concurrent clients to create.
u_int thread_count_;
- // Number of concurrent clients to create.
+ /// Array to store the latency for every client, indexed by
+ /// thread-id.
ACE_timer_t *latency_;
- // Array to store the latency for every client, indexed by
- // thread-id.
+ /// Int array to store the latencies.
int *ave_latency_;
- // Int array to store the latencies.
+ /// Which datatype to use to make the calls.
Cubit_Datatypes datatype_;
- // Which datatype to use to make the calls.
+ /// Lock to protect access to this object.
TAO_SYNCH_MUTEX lock_;
- // Lock to protect access to this object.
+ /// Flag for the thread_per_rate test.
u_int thread_per_rate_;
- // Flag for the thread_per_rate test.
+ /// This array stores the latency seen by each client for each
+ /// request, to be used later to compute jitter.
JITTER_ARRAY **global_jitter_array_;
- // This array stores the latency seen by each client for each
- // request, to be used later to compute jitter.
+ /// This array stores the call count of each thread. They will not
+ /// always have the same call count.
u_int *count_;
- // This array stores the call count of each thread. They will not
- // always have the same call count.
+ /// Flag that indicates if we are going to call the shutdown methos
+ /// for the servant.
u_int shutdown_;
- // Flag that indicates if we are going to call the shutdown methos
- // for the servant.
+ /// Flag that indicates if we are going to use oneway calls instead
+ /// of two-way.
u_int oneway_;
- // Flag that indicates if we are going to use oneway calls instead
- // of two-way.
+ /// Ior array used if utilization test is run.
char *one_ior_;
- // Ior array used if utilization test is run.
+ /// indicates whether we are running the "1 to n" test, which has 1
+ /// low priority servant and n low priority clients.
u_int one_to_n_test_;
- // indicates whether we are running the "1 to n" test, which has 1
- // low priority servant and n low priority clients.
+ /// flag to run context switch test
u_int context_switch_test_;
- // flag to run context switch test
+ /// Array of pointers used to hold the ior strings read from the ior file
+ /// that the server created.
char **iors_;
- // Array of pointers used to hold the ior strings read from the ior file
- // that the server created.
+ /// count on the number of iors
int iors_count_;
- // count on the number of iors
+ /// Name of the filename that the server used to store the iors.
ACE_TCHAR *ior_file_;
- // Name of the filename that the server used to store the iors.
+ /**
+ * this is the granularity of the timing of the CORBA requests. A
+ * value of 5 represents that we will take time every 5 requests,
+ * instead of the default of every request (1).
+ */
u_int granularity_;
- // this is the granularity of the timing of the CORBA requests. A
- // value of 5 represents that we will take time every 5 requests,
- // instead of the default of every request (1).
+ /**
+ * flag to indicate we are to use the utilization test. By default
+ * we do not use it, because it can cause starvation with real-time
+ * threads
+ */
u_int use_utilization_test_;
- // flag to indicate we are to use the utilization test. By default
- // we do not use it, because it can cause starvation with real-time
- // threads
+ /**
+ * Number of times the high priority looped. We are going to loop
+ * as long as there is low priority clients running, so as to
+ * maintain high priority traffic as long as low priority traffic is
+ * going through.
+ */
u_int high_priority_loop_count_;
- // Number of times the high priority looped. We are going to loop
- // as long as there is low priority clients running, so as to
- // maintain high priority traffic as long as low priority traffic is
- // going through.
+ /**
+ * semaphore in order for the high priority client to keep running
+ * as long as the low priority clients are running. See explanation
+ * of "high_priority_loop_count_" member in this class.
+ */
ACE_SYNCH_SEMAPHORE *semaphore_;
- // semaphore in order for the high priority client to keep running
- // as long as the low priority clients are running. See explanation
- // of "high_priority_loop_count_" member in this class.
+ /**
+ * flag to indicate we are to use multiple priorities for the low
+ * priority clients. By default we use only one priority for all
+ * client threads.
+ */
u_int use_multiple_priority_;
- // flag to indicate we are to use multiple priorities for the low
- // priority clients. By default we use only one priority for all
- // client threads.
+ /// global timer to be started by the utilization task.
ACE_High_Res_Timer timer_;
- // global timer to be started by the utilization task.
+ /// ready flag used by the high priority thread to wake up the low
+ /// priority threads after it's parsed the arguments.
int ready_;
- // ready flag used by the high priority thread to wake up the low
- // priority threads after it's parsed the arguments.
+ /// mutex for the condition variable.
TAO_SYNCH_MUTEX ready_mtx_;
- // mutex for the condition variable.
+ /// condition variable for the low priority threads to wait
+ ///until the high priority thread is done with the arguments parsing.
TAO_SYNCH_CONDITION ready_cnd_;
- // condition variable for the low priority threads to wait
- //until the high priority thread is done with the arguments parsing.
+ /// flag to indicate whether we make remote versus local invocations
+ /// to calculate accurately the ORB overhead.
u_int remote_invocations_;
- // flag to indicate whether we make remote versus local invocations
- // to calculate accurately the ORB overhead.
+ /// holds the total time for the utilization test to complete.
ACE_timer_t util_test_time_;
- // holds the total time for the utilization test to complete.
};
+/**
+ * @class Client
+ *
+ * @brief The Cubit client.
+ *
+ * This class implements the Cubit Client, which is an active object.
+ * `n' threads execute svc, and make 2way CORBA calls on the server
+ */
class Client : public ACE_Task<ACE_SYNCH>
{
- // = TITLE
- // The Cubit client.
- //
- // = DESCRIPTION
- // This class implements the Cubit Client, which is an active object.
- // `n' threads execute svc, and make 2way CORBA calls on the server
public:
+ /// Constructor, with a pointer to the common task state.
Client (ACE_Thread_Manager *,
Task_State *ts,
int argc,
ACE_TCHAR **argv,
u_int id);
- // Constructor, with a pointer to the common task state.
+ /// destructor.
~Client (void);
- // destructor.
+ /// The thread function.
virtual int svc (void);
- // The thread function.
+ /// Returns the latency of the high priority thread in usecs.
ACE_timer_t get_high_priority_latency (void);
- // Returns the latency of the high priority thread in usecs.
+ /// Returns the average latency found for the low
+ /// priority threads in usecs.
ACE_timer_t get_low_priority_latency (void);
- // Returns the average latency found for the low
- // priority threads in usecs.
+ /// Returns the high priority jitter in usecs.
ACE_timer_t get_high_priority_jitter (void);
- // Returns the high priority jitter in usecs.
+ /// Returns the jitter for all the low priority
+ /// thread request in usecs.
ACE_timer_t get_low_priority_jitter (void);
- // Returns the jitter for all the low priority
- // thread request in usecs.
+ /// gets the average latency for that thread.
ACE_timer_t get_latency (u_int thread_id);
- // gets the average latency for that thread.
+ /// gets the jitter for this thread.
ACE_timer_t get_jitter (u_int id);
- // gets the jitter for this thread.
+ /// Arbitrary generator used by the client to create the numbers to be
+ /// cubed.
static int func (u_int i);
- // Arbitrary generator used by the client to create the numbers to be
- // cubed.
private:
+ /// initialize the ORB.
CORBA::ORB_ptr init_orb (void);
- // initialize the ORB.
+ /// reads the cubit ior from a file.
void read_ior (void);
- // reads the cubit ior from a file.
+ /// gets the cubit object.
int get_cubit (CORBA::ORB_ptr orb);
- // gets the cubit object.
+ /// Run the various tests.
int run_tests (void);
- // Run the various tests.
+ /// make a CORBA request depending on the datatype.
int make_request (void);
- // make a CORBA request depending on the datatype.
+ /// makes the corba requests.
int do_test (void);
- // makes the corba requests.
+ /// call cube_octet method on the cubit object.
int cube_octet (void);
- // call cube_octet method on the cubit object.
+ /// call cube short on the cubit object.
int cube_short (void);
- // call cube short on the cubit object.
+ /// call cube long on the cubit object.
int cube_long (void);
- // call cube long on the cubit object.
+ /// call cube struct on the cubit object.
int cube_struct (void);
- // call cube struct on the cubit object.
+ /// prints the latency stats.
void print_stats (void);
- // prints the latency stats.
+ /// Records the latencies in the <Task_State>.
void put_latency (JITTER_ARRAY *jitter,
ACE_timer_t latency,
u_int thread_id,
u_int count);
- // Records the latencies in the <Task_State>.
+ /// Parses the arguments.
int parse_args (int, char **);
- // Parses the arguments.
+ /// determines the frequency at which to make calls depending on the
+ /// id of the thread.
void find_frequency (void);
- // determines the frequency at which to make calls depending on the
- // id of the thread.
+ /// calculate the delta value.
ACE_timer_t calc_delta (ACE_timer_t real_time,
ACE_timer_t delta);
- // calculate the delta value.
+ /// pointer to the cubit object.
Cubit_ptr cubit_;
- // pointer to the cubit object.
+ /// cubit implementation object.
Cubit_i cubit_impl_;
- // cubit implementation object.
+ /// Pointer to shared state.
Task_State *ts_;
- // Pointer to shared state.
+ /// number used for cubing.
u_int num_;
- // number used for cubing.
+ /// unique id of the task
u_int id_;
- // unique id of the task
+ /// count of the number of calls made.
u_int call_count_;
- // count of the number of calls made.
+ /// number of calls that failed.
u_int error_count_;
- // number of calls that failed.
+ /// ACE Unbounded set holding the latency values for all the
+ /// requests of this thread.
JITTER_ARRAY *my_jitter_array_;
- // ACE Unbounded set holding the latency values for all the
- // requests of this thread.
+ /// Timer using pccTimer for chorus and ACE_Timer for other platforms.
MT_Cubit_Timer *timer_;
- // Timer using pccTimer for chorus and ACE_Timer for other platforms.
+ /// frequency of CORBA requests.
ACE_timer_t frequency_;
- // frequency of CORBA requests.
+ /// aggregate latency of the requests.
ACE_timer_t latency_;
- // aggregate latency of the requests.
// command-line arguments.
int argc_;
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Timer.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Timer.h
index eb6931459a3..b246c0cd9c3 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Timer.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Timer.h
@@ -1,19 +1,17 @@
/* -*- C++ -*- */
-/* $Id$ */
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// Timer.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee, Sergio Flores-Gaitan and Nagarajan
-// Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Timer.h
+ *
+ * $Id$ */
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef _MT_CUBIT_TIMER_H
#define _MT_CUBIT_TIMER_H
@@ -26,11 +24,14 @@
#include "ace/High_Res_Timer.h"
+/**
+ * @class MT_Cubit_Timer
+ *
+ * @brief A class that encapsulates the pccTimer for chorus and uses
+ * ACE Timer for other platforms.
+ */
class MT_Cubit_Timer
{
- // = TITLE
- // A class that encapsulates the pccTimer for chorus and uses
- // ACE Timer for other platforms.
public:
MT_Cubit_Timer (u_int granularity);
@@ -40,16 +41,18 @@ public:
ACE_timer_t get_elapsed (void);
private:
+ /// timer.
ACE_High_Res_Timer timer_;
- // timer.
+ /// Elapsed time in microseconds.
ACE_Time_Value delta_;
- // Elapsed time in microseconds.
+ /**
+ * This is the granularity of the timing of the CORBA requests. A
+ * value of 5 represents that we will take time every 5 requests,
+ * instead of the default of every request (1).
+ */
u_int granularity_;
- // This is the granularity of the timing of the CORBA requests. A
- // value of 5 represents that we will take time every 5 requests,
- // instead of the default of every request (1).
};
#endif /* _MT_CUBIT_TIMER_H */
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h
index cad2577da57..04c9faeb05a 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/Util_Thread.h
@@ -1,57 +1,58 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// Util_Thread.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee, Sergio Flores-Gaitan and Nagarajan
-// Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Util_Thread.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef UTIL_THREAD_H
#define UTIL_THREAD_H
#include "Task_Client.h"
+/**
+ * @class Util_Thread
+ *
+ * @brief The thread that computes utilization.
+ */
class Util_Thread : public ACE_Task<ACE_NULL_SYNCH>
{
- // = TITLE
- // The thread that computes utilization.
public:
+ /// Constructor.
Util_Thread (Task_State *,
ACE_Thread_Manager *thr_mgr);
- // Constructor.
+ /// The thread entry point function.
virtual int svc (void);
- // The thread entry point function.
+ /// Gets the number of computations the thread was able to perform.
u_long get_number_of_computations (void);
- // Gets the number of computations the thread was able to perform.
+ /// this is the actual "computation" being performed.
void computation (void);
- // this is the actual "computation" being performed.
+ /// Indicates whether we're done.
int done_;
- // Indicates whether we're done.
private:
+ /// Run the computations.
int run_computations (void);
- // Run the computations.
+ /// This stores the number of computations performed
+ /// by the Util_Thread so far
u_long number_of_computations_;
- // This stores the number of computations performed
- // by the Util_Thread so far
+ /// Pointer to the Task state. Stores the state
+ /// common to the multiple client threads
Task_State *ts_;
- // Pointer to the Task state. Stores the state
- // common to the multiple client threads
};
#endif /* !defined (UTIL_THREAD_H) */
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/client.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/client.h
index 3cccca50c16..a10b01d9ea3 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/client.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/client.h
@@ -1,19 +1,18 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// client.h
-//
-// = AUTHOR
-// Andy Gokhale, Brian Mendel, Sumedh Mungee, Sergio Flores-Gaitan
-// and Nagarajan Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Brian Mendel
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#include "ace/Task.h"
@@ -36,141 +35,148 @@ extern "C" STATUS vmeDrv (void);
extern "C" STATUS vmeDevCreate (char *);
#endif /* defined (VME_DRIVER) */
+/**
+ * @class Client_i
+ *
+ * @brief Helper class implementing the Multi-Threaded Cubit client.
+ */
class Client_i : public virtual MT_Priority
{
- // = TITLE
- // Helper class implementing the Multi-Threaded Cubit client.
public:
+ ///constructor.
Client_i (void);
- //constructor.
+ /// destructor.
virtual ~Client_i (void);
- // destructor.
+ /// Initialize the state of <Client_i>.
int init (int argc, ACE_TCHAR *argv[]);
- // Initialize the state of <Client_i>.
+ /// Run the tests.
void run (void);
- // Run the tests.
+ /// Performs the priority inversion test.
int do_priority_inversion_test (void);
- // Performs the priority inversion test.
+ /// Performs the test with 4 threads each sending requests at rates
+ /// of 20, 10, 5, and 1Hz.
int do_thread_per_rate_test (void);
- // Performs the test with 4 threads each sending requests at rates
- // of 20, 10, 5, and 1Hz.
+ /// Starts the client utilization thread.
int start_servant (void);
- // Starts the client utilization thread.
+ /// output the latency results for the requests.
void output_latency (void);
- // output the latency results for the requests.
#if defined (VXWORKS)
+ /// Outputs the details of this task to a file taskinfo.txt.
void output_taskinfo (void);
- // Outputs the details of this task to a file taskinfo.txt.
#endif /* VXWORKS */
private:
+ /// Sets the priority to be used for the low priority clients.
void init_low_priority (void);
- // Sets the priority to be used for the low priority clients.
+ /// Calculate the time for one util computation.
void calc_util_time (void);
- // Calculate the time for one util computation.
+ /// Activates the high priority client.
int activate_high_client (void);
- // Activates the high priority client.
+ /// Activates the low priority client.
int activate_low_client (void);
- // Activates the low priority client.
+ /// Activates the utilization thread.
int activate_util_thread (void);
- // Activates the utilization thread.
+ /// Prints the results of the tests.
void print_priority_inversion_stats (void);
- // Prints the results of the tests.
+ /// Prints the context switch results.
void print_context_stats (void);
- // Prints the context switch results.
+ /// Prints the utilization test results.
void print_util_stats (void);
- // Prints the utilization test results.
+ /// Prints the latency and jitter results.
void print_latency_stats (void);
- // Prints the latency and jitter results.
+ /// gets the number of context switches.
void get_context_switches (void);
- // gets the number of context switches.
+ /// Pointer to the high priority client object.
Client *high_priority_client_;
- // Pointer to the high priority client object.
+ /// Array to hold pointers to the low priority tasks.
Client **low_priority_client_;
- // Array to hold pointers to the low priority tasks.
+ /// Timer for timing the tests.
ACE_High_Res_Timer timer_;
- // Timer for timing the tests.
+ /// Priority helper object.
MT_Priority priority_;
- // Priority helper object.
+ /// Utilization thread.
Util_Thread *util_thread_;
- // Utilization thread.
+ /// Utilization thread manager.
ACE_Thread_Manager util_thread_manager_;
- // Utilization thread manager.
+ /// Time for one computation of utilization thread.
ACE_timer_t util_task_duration_;
- // Time for one computation of utilization thread.
+ /// Pointer to task state.
Task_State *ts_;
- // Pointer to task state.
+ /// Priority used for the high priority client.
ACE_Sched_Priority high_priority_;
- // Priority used for the high priority client.
+ /// Priority used by the low priority clients.
ACE_Sched_Priority low_priority_;
- // Priority used by the low priority clients.
+ /// Number of low priority clients
u_int num_low_priority_;
- // Number of low priority clients
+ /// Number of priorities used.
u_int num_priorities_;
- // Number of priorities used.
+ /**
+ * Granularity of the assignment of the priorities. Some OSs have
+ * fewer levels of priorities than we have threads in our test, so
+ * with this mechanism we assign priorities to groups of threads
+ * when there are more threads than priorities.
+ */
u_int grain_;
- // Granularity of the assignment of the priorities. Some OSs have
- // fewer levels of priorities than we have threads in our test, so
- // with this mechanism we assign priorities to groups of threads
- // when there are more threads than priorities.
+ /// counter of the number of priorities used within a grain.
u_int counter_;
- // counter of the number of priorities used within a grain.
// Set a task_name string starting with "@", so we are able to
// accurately count the number of context switches.
char* task_name_;
+ /// elapsed time for the latency tests.
ACE_Time_Value delta_;
- // elapsed time for the latency tests.
+ /// number of command line arguments.
int argc_;
- // number of command line arguments.
+ /// command line argument array.
ACE_TCHAR **argv_;
- // command line argument array.
+ /**
+ * Create a separate manager for the client. This allows the use of
+ * its wait () method on VxWorks, without interfering with the
+ * server's (global) thread manager.
+ */
ACE_Thread_Manager client_thread_manager_;
- // Create a separate manager for the client. This allows the use of
- // its wait () method on VxWorks, without interfering with the
- // server's (global) thread manager.
+ /// Stores the total number of context switches incurred by the
+ /// program while making CORBA requests
u_int context_switch_;
- // Stores the total number of context switches incurred by the
- // program while making CORBA requests
+ /// Thread manager for the servant used for utilization.
ACE_Thread_Manager server_thread_manager_;
- // Thread manager for the servant used for utilization.
#if (defined (ACE_HAS_PRUSAGE_T) || defined (ACE_HAS_GETRUSAGE)) && !defined (ACE_WIN32)
ACE_Profile_Timer timer_for_context_switch;
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h
index 2eb4f2fb17c..d75c929c226 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/cubit_i.h
@@ -1,28 +1,30 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// cubit_i.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee, Sergio Flores-Gaitan and Nagarajan Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file cubit_i.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef _CUBIT_I_H
#define _CUBIT_I_H
#include "cubitS.h"
+/**
+ * @class Cubit_i
+ *
+ * @brief Cubit implementation class.
+ */
class Cubit_i : public POA_Cubit
{
- // = TITLE
- // Cubit implementation class.
public:
// = Initialization and termination methods.
Cubit_i (CORBA::ORB_ptr orb,
@@ -41,16 +43,16 @@ public:
virtual void shutdown (void);
+ /// The default POA
virtual PortableServer::POA_ptr
_default_POA (void);
- // The default POA
protected:
+ /// Keep a pointer to the ORB so we can shut it down.
CORBA::ORB_var orb_;
- // Keep a pointer to the ORB so we can shut it down.
+ /// The default POA..
PortableServer::POA_var poa_;
- // The default POA..
};
#endif /* _CUBIT_I_H */
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.cpp b/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.cpp
index 39129c7d146..1ae4f59307d 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.cpp
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHOR
-// Andy Gokhale,
-// Sumedh Mungee,
-// Sergio Flores-Gaitan, and
-// Nagarajan Surendran
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan
+ * @author and Nagarajan Surendran
+ */
+//=============================================================================
+
#include "ace/config-all.h"
diff --git a/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.h b/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.h
index f10030ed27f..be32928483c 100644
--- a/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.h
+++ b/TAO/performance-tests/Cubit/TAO/MT_Cubit/server.h
@@ -1,19 +1,17 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests
-//
-// = FILENAME
-// server.h
-//
-// = AUTHOR
-// Andy Gokhale, Sumedh Mungee,Sergio Flores-Gaitan and Nagarajan
-// Surendran.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.h
+ *
+ * $Id$
+ *
+ * @author Andy Gokhale
+ * @author Sumedh Mungee
+ * @author Sergio Flores-Gaitan and Nagarajan Surendran.
+ */
+//=============================================================================
+
#ifndef SERVER_H
#define SERVER_H
@@ -51,91 +49,95 @@ extern "C" STATUS vmeDrv (void);
extern "C" STATUS vmeDevCreate (char *);
#endif /* VME_DRIVER */
+/**
+ * @class Server
+ *
+ * @brief A multithreaded cubit server class.
+ *
+ * This class encapsulates the functionality of a multi-threaded
+ * cubit server. To use this, call initialize and then
+ * start_servants method.
+ */
class Server
{
- // = TITLE
- // A multithreaded cubit server class.
- //
- // = DESCRIPTION
- // This class encapsulates the functionality of a multi-threaded
- // cubit server. To use this, call initialize and then
- // start_servants method.
public:
+ /// Default constructor.
Server (void);
- // Default constructor.
+ /// Initialize the server state.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the server state.
+ /// Run method.
int run (void);
- // Run method.
private:
+ /// Start the high and low priority servants.
int start_servants (void);
- // Start the high and low priority servants.
+ /// Preliminary argument processing code.
void prelim_args_process (void);
- // Preliminary argument processing code.
+ /// sets the priority to be used for the low priority servants.
void init_low_priority (void);
- // sets the priority to be used for the low priority servants.
+ /// Writes the iors of the servants to a file
int write_iors (void);
- // Writes the iors of the servants to a file
+ /// Activates the high priority servant.
int activate_high_servant (void);
- // Activates the high priority servant.
+ /// Activates the low priority servants.
int activate_low_servants (void);
- // Activates the low priority servants.
+ /// Number of arguments for the servant.
int argc_;
- // Number of arguments for the servant.
+ /// Arguments for the ORB.
ACE_TCHAR **argv_;
- // Arguments for the ORB.
+ /// Array to hold pointers to the Cubit objects.
char * *cubits_;
- // Array to hold pointers to the Cubit objects.
+ /// Pointer to the high priority task
Cubit_Task *high_priority_task_;
- // Pointer to the high priority task
+ /// Array to hold pointers to the low priority tasks.
Cubit_Task **low_priority_tasks_;
- // Array to hold pointers to the low priority tasks.
+ /// Priority used for the high priority servant.
ACE_Sched_Priority high_priority_;
- // Priority used for the high priority servant.
+ /// Priority used by the low priority servants.
ACE_Sched_Priority low_priority_;
- // Priority used by the low priority servants.
+ /// Number of low priority servants
u_int num_low_priority_;
- // Number of low priority servants
+ /// Number of priorities used.
u_int num_priorities_;
- // Number of priorities used.
+ /**
+ * Granularity of the assignment of the priorities. Some OSs have
+ * fewer levels of priorities than we have threads in our test, so
+ * with this mechanism we assign priorities to groups of threads
+ * when there are more threads than priorities.
+ */
u_int grain_;
- // Granularity of the assignment of the priorities. Some OSs have
- // fewer levels of priorities than we have threads in our test, so
- // with this mechanism we assign priorities to groups of threads
- // when there are more threads than priorities.
+ /// count of the number of priorities used within a grain.
u_int counter_;
- // count of the number of priorities used within a grain.
+ /// argv passed to the high priority servant.
ACE_ARGV *high_argv_;
- // argv passed to the high priority servant.
+ /// argv passed to the low priority servants.
ACE_ARGV *low_argv_;
- // argv passed to the low priority servants.
+ /// Priority helper object.
MT_Priority priority_;
- // Priority helper object.
+ /// Thread manager for the servant threads.
ACE_Thread_Manager servant_manager_;
- // Thread manager for the servant threads.
};
#endif /* SERVER_H */
diff --git a/TAO/performance-tests/POA/Demux/client.cpp b/TAO/performance-tests/POA/Demux/client.cpp
index 416fec34ac0..3d2e703f8a4 100644
--- a/TAO/performance-tests/POA/Demux/client.cpp
+++ b/TAO/performance-tests/POA/Demux/client.cpp
@@ -1,19 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// client.cpp
-//
-// client side main program
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * @file client side main program
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "demux_test_client.h"
diff --git a/TAO/performance-tests/POA/Demux/demux_stats.cpp b/TAO/performance-tests/POA/Demux/demux_stats.cpp
index 46816b75a80..9216900f4a2 100644
--- a/TAO/performance-tests/POA/Demux/demux_stats.cpp
+++ b/TAO/performance-tests/POA/Demux/demux_stats.cpp
@@ -1,17 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_stats.cpp
-//
-// = AUTHOR
-//
-// Vishal Kachroo
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_stats.cpp
+ *
+ * $Id$
+ *
+ * @author Vishal Kachroo
+ */
+//=============================================================================
+
// FUZZ: disable check_for_math_include
#include <math.h>
@@ -23,19 +19,19 @@ class Demux_Stats
public:
+ /// Calculates the average latency and Standard deviation.
+ /// Expects the input data in my_results.dat.
int
calculate_avg_latency (void);
- // Calculates the average latency and Standard deviation.
- // Expects the input data in my_results.dat.
+ /// parses args.
int
Demux_Stats::parse_args (int argc_, char * argv_ []);
- // parses args.
private :
+ /// temporary results file.
FILE *result_fp_;
- // temporary results file.
int iterations;
};
diff --git a/TAO/performance-tests/POA/Demux/demux_test_client.cpp b/TAO/performance-tests/POA/Demux/demux_test_client.cpp
index ce0286e3e4b..cc6cb32c954 100644
--- a/TAO/performance-tests/POA/Demux/demux_test_client.cpp
+++ b/TAO/performance-tests/POA/Demux/demux_test_client.cpp
@@ -1,17 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_test_client.cpp
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_test_client.cpp
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "demux_test_client.h"
#include "tao/debug.h"
diff --git a/TAO/performance-tests/POA/Demux/demux_test_client.h b/TAO/performance-tests/POA/Demux/demux_test_client.h
index 2999b69f53b..29203b45710 100644
--- a/TAO/performance-tests/POA/Demux/demux_test_client.h
+++ b/TAO/performance-tests/POA/Demux/demux_test_client.h
@@ -1,22 +1,20 @@
#ifndef TAO_DEMUX_TEST_CLIENT_H
#define TAO_DEMUX_TEST_CLIENT_H
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_test_client.h
-//
-// Definition of the client-side demux_test class
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_test_client.h
+ *
+ * $Id$
+ *
+ * @file Definition of the client-side demux_test class
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
// FUZZ: disable check_for_math_include
@@ -46,83 +44,85 @@ public:
OP_PTR op_;
};
+ /// CTOR
Demux_Test_Client (void);
- // CTOR
+ /// DTOR
~Demux_Test_Client (void);
- // DTOR
+ /// initialize the client test bed
int init (int argc, ACE_TCHAR *argv []);
- // initialize the client test bed
+ /// run the tests
int run (void);
- // run the tests
private:
+ /// parse command line arguments
int parse_args (void);
- // parse command line arguments
+ /// initialize the operation database
int init_operation_db (void);
- // initialize the operation database
+ /// run linear strategy
int run_linear_test (void);
- // run linear strategy
+ /// run random strategy
int run_random_test (void);
- // run random strategy
+ /// run best strategy (w.r.t to linear)
int run_best_test (void);
- // run best strategy (w.r.t to linear)
+ /// run worst strategy (w.r.t to linear)
int run_worst_test (void);
- // run worst strategy (w.r.t to linear)
+ /// print results
int print_results (void);
- // print results
+ /// number of command line arguments
int argc_;
- // number of command line arguments
+ /// the actual command line arguments
ACE_TCHAR **argv_;
- // the actual command line arguments
+ /// The underlying ORB
CORBA::ORB_var orb_;
- // The underlying ORB
+ /// invocation strategy (default linear)
INVOKE_STRATEGY is_;
- // invocation strategy (default linear)
+ /// number of POAs
CORBA::ULong num_POAs_;
- // number of POAs
+ /// number of objects
CORBA::ULong num_objs_;
- // number of objects
+ /// number of operations
CORBA::ULong num_ops_;
- // number of operations
+ /// object references to the Demux_Test objects
typedef TAO_Intrusive_Ref_Count_Handle<Demux_Test> Demux_Test_Var;
typedef ACE_Vector<Demux_Test_Var> Demux_Test_Container;
Demux_Test_Container demux_test_;
- // object references to the Demux_Test objects
+ /// number of times to invoke the request
CORBA::ULong loop_count_;
- // number of times to invoke the request
+ /// IOR database
FILE *ior_fp_;
- // IOR database
+ /// temporary results file
FILE *result_fp_;
- // temporary results file
+ /**
+ * Step for the no. of objects to be skipped while making remote calls
+ * on the given no. of objects.
+ * If the step is 100, a call will be made to every 100th Object.
+ */
CORBA::ULong step_;
- // Step for the no. of objects to be skipped while making remote calls
- // on the given no. of objects.
- // If the step is 100, a call will be made to every 100th Object.
+ /// database of operations
Operation_DB_Entry op_db_[TAO_DEMUX_TEST_MAX_OPS];
- // database of operations
};
diff --git a/TAO/performance-tests/POA/Demux/demux_test_macros.h b/TAO/performance-tests/POA/Demux/demux_test_macros.h
index 31bb42ebe80..27728d39ee3 100644
--- a/TAO/performance-tests/POA/Demux/demux_test_macros.h
+++ b/TAO/performance-tests/POA/Demux/demux_test_macros.h
@@ -1,22 +1,20 @@
#ifndef TAO_DEMUX_TEST_MACROS_H
#define TAO_DEMUX_TEST_MACROS_H
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_test_macros.h
-//
-// constants used by both the server and client
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_test_macros.h
+ *
+ * $Id$
+ *
+ * @file constants used by both the server and client
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#define TAO_DEMUX_TEST_MAX_POAS 100
#define TAO_DEMUX_TEST_MAX_OBJS 1000
diff --git a/TAO/performance-tests/POA/Demux/demux_test_server.cpp b/TAO/performance-tests/POA/Demux/demux_test_server.cpp
index fbb43f15d8b..45105307a1c 100644
--- a/TAO/performance-tests/POA/Demux/demux_test_server.cpp
+++ b/TAO/performance-tests/POA/Demux/demux_test_server.cpp
@@ -1,17 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_test_server.cpp
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_test_server.cpp
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "demux_test_server.h"
#include "tao/debug.h"
diff --git a/TAO/performance-tests/POA/Demux/demux_test_server.h b/TAO/performance-tests/POA/Demux/demux_test_server.h
index 020849892cf..82fed3a069b 100644
--- a/TAO/performance-tests/POA/Demux/demux_test_server.h
+++ b/TAO/performance-tests/POA/Demux/demux_test_server.h
@@ -1,19 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// demux_test_server.h
-//
-// Server-side demux_test class
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file demux_test_server.h
+ *
+ * $Id$
+ *
+ * @file Server-side demux_test class
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef DOORS_DEMUX_TEST_SERVER_H
#define DOORS_DEMUX_TEST_SERVER_H
@@ -33,76 +31,76 @@
class Demux_Test_Server
{
public:
+ /// ctor
Demux_Test_Server (void);
- // ctor
+ /// dtor
~Demux_Test_Server (void);
- // dtor
+ /// Execute client code.
int run (void);
- // Execute client code.
+ /// Initialize the communication endpoint with server.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the communication endpoint with server.
+ /// Calculates the statistics by reading different data values from results.dat.
int calculate_avg_latency (void);
- // Calculates the statistics by reading different data values from results.dat.
private:
+ /// parse command line arguments (if any)
int parse_args (void);
- // parse command line arguments (if any)
+ /// initialize the naming service
int init_naming_service (void);
- // initialize the 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.
+ /// the ORB
CORBA::ORB_var orb_;
- // the ORB
+ /// the root POA (we will not have any objects registered with this)
PortableServer::POA_var root_poa_;
- // the root POA (we will not have any objects registered with this)
+ /// The POA manager
PortableServer::POAManager_var poa_mgr_;
- // The POA manager
+ /// An array of child POAs with the next one being the child of the previous
+ /// one
PortableServer::POA_var child_poa_ [TAO_DEMUX_TEST_MAX_POAS];
- // An array of child POAs with the next one being the child of the previous
- // one
+ /// 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.
// Demux_Test_i demux_test_[TAO_DEMUX_TEST_MAX_POAS * TAO_DEMUX_TEST_MAX_OBJS];
// The actual demux_test objects
+ /// number of POAs
CORBA::ULong num_POAs_;
- // number of POAs
+ /// number of objects
CORBA::ULong num_objs_;
- // number of objects
+ /// file storing POA names
FILE *poa_fp_;
- // file storing POA names
+ /// file for storing IORs
FILE *ior_fp_;
- // file for storing IORs
+ /// file for storing Servant Names.
FILE *servant_fp_;
- // file for storing Servant Names.
+ /// Use the USER_ID policy for servants as opposed to System ID.
int use_user_id_;
- // Use the USER_ID policy for servants as opposed to System ID.
+ /// Use the Transient POAs for servant activation as opposed
+ /// to persistent POAs.
int use_transient_poas_;
- // Use the Transient POAs for servant activation as opposed
- // to persistent POAs.
};
diff --git a/TAO/performance-tests/POA/Demux/server.cpp b/TAO/performance-tests/POA/Demux/server.cpp
index 340aa2fc33e..209bf92630e 100644
--- a/TAO/performance-tests/POA/Demux/server.cpp
+++ b/TAO/performance-tests/POA/Demux/server.cpp
@@ -1,19 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Demux
-//
-// = FILENAME
-// server.cpp
-//
-// Server-side driver program
-//
-// = AUTHOR
-//
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @file Server-side driver program
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "demux_test_server.h"
diff --git a/TAO/performance-tests/POA/Object_Creation_And_Registration/registration.cpp b/TAO/performance-tests/POA/Object_Creation_And_Registration/registration.cpp
index e723a7ad997..3e769711f33 100644
--- a/TAO/performance-tests/POA/Object_Creation_And_Registration/registration.cpp
+++ b/TAO/performance-tests/POA/Object_Creation_And_Registration/registration.cpp
@@ -1,22 +1,19 @@
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/POA/Object_Creation_And_Registration
-//
-// = FILENAME
-// registration.cpp
-//
-// = DESCRIPTION
-//
-// This test is used to measure the time it takes to register and
-// activate an object in the POA.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file registration.cpp
+ *
+ * $Id$
+ *
+ *
+ * This test is used to measure the time it takes to register and
+ * activate an object in the POA.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "tao/Server_Strategy_Factory.h"
@@ -67,9 +64,12 @@ inline int QuantifyStopRecordingData ()
#endif /* ACE_WIN32 */
#endif /* USING_QUANTIFY */
+/**
+ * @class test_i
+ *
+ * @brief Oversimplified servant class
+ */
class test_i : public POA_test
- // = TITLE
- // Oversimplified servant class
{
};
diff --git a/TAO/performance-tests/Pluggable/PP_Test_Client.h b/TAO/performance-tests/Pluggable/PP_Test_Client.h
index d19bb48fc1a..30359941d3d 100644
--- a/TAO/performance-tests/Pluggable/PP_Test_Client.h
+++ b/TAO/performance-tests/Pluggable/PP_Test_Client.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Pluggable
-//
-// = FILENAME
-// PP_Test_Client.h
-//
-// = DESCRIPTION
-// This class implements some basic no-op twoway and oneway requests
-// to time the latency of the pluggable protocol implementation.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file PP_Test_Client.h
+ *
+ * $Id$
+ *
+ * This class implements some basic no-op twoway and oneway requests
+ * to time the latency of the pluggable protocol implementation.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _PP_TEST_CLIENT_H
#define _PP_TEST_CLIENT_H
@@ -29,94 +25,96 @@
#include "PP_TestC.h"
+/**
+ * @class PP_Test_Client
+ *
+ * @brief Defines a class that encapsulates behaviour of the PP_Test 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
+ * PP_Teset CORBA server. All the complexity for initializing the
+ * server is hidden in the class. Just the run() interface is needed.
+ */
class PP_Test_Client
{
- // = TITLE
- // Defines a class that encapsulates behaviour of the PP_Test 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
- // PP_Teset CORBA server. All the complexity for initializing the
- // server is hidden in the class. Just the run() interface is needed.
public:
// = Constructor and destructor.
+ /// Use <testing_collocation> to control some client's behaviors.
PP_Test_Client (int shutdown = 0);
- // Use <testing_collocation> to control some client's behaviors.
~PP_Test_Client (void);
+ /// Execute client example code.
int run (void);
- // Execute client example code.
+ /// Initialize the client communication endpoint with server.
+ /// <collocation_test_ior> is used to pass in the ior file name.
int init (int argc, ACE_TCHAR **argv);
- // Initialize the client communication endpoint with server.
- // <collocation_test_ior> is used to pass in the ior file name.
private:
+ /// Function to read the cubit factory ior from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the cubit factory ior from a file.
+ /// Parses the arguments passed on the command line.
int parse_args (void);
- // Parses the arguments passed on the command line.
+ /// Oneway operation test.
void send_oneway (void);
- // Oneway operation test.
+ /// Twoway operation test.
void send_void (void);
- // Twoway operation test.
+ /// This method runs only the send_void() test.
int run_void (void);
- // This method runs only the send_void() test.
+ /// This method runs only the send_oneway() test.
int run_oneway (void);
- // This method runs only the send_oneway() test.
+ /// Invoke the method with <do_shutdown> != 0 to shutdown the server.
int shutdown_server (int do_shutdown);
- // Invoke the method with <do_shutdown> != 0 to shutdown the server.
+ /// # 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.
+ /// Remember our orb.
CORBA::ORB_var orb_;
- // Remember our orb.
+ /// Key of factory obj ref.
ACE_TCHAR *factory_key_;
- // Key of factory obj ref.
+ /// Number of times to do the send operations.
CORBA::ULong loop_count_;
- // Number of times to do the send operations.
+ /// Flag to tell server to shutdown.
int shutdown_;
- // Flag to tell server to shutdown.
+ /// factory pointer for cubit.
Pluggable_Test_Factory_var factory_;
- // factory pointer for cubit.
+ /// Pluggable_Test obj ref.
Pluggable_Test_var objref_;
- // Pluggable_Test obj ref.
+ /// # of calls made to functions.
CORBA::ULong call_count_;
- // # of calls made to functions.
+ /// # of errors incurred in the lifetime of the application.
CORBA::ULong error_count_;
- // # of errors incurred in the lifetime of the application.
+ /// File from which to obtain the IOR.
FILE *factory_ior_file_;
- // File from which to obtain the IOR.
+ /// File handle to read the IOR.
ACE_HANDLE f_handle_;
- // File handle to read the IOR.
+ /// Run only the cube_void() test.
int only_void_;
- // Run only the cube_void() test.
+ /// Run only the cube_oneway() test.
int only_oneway_;
- // Run only the cube_oneway() test.
};
#endif /* _PP_TEST_CLIENT_H */
diff --git a/TAO/performance-tests/Pluggable/PP_Test_Server.h b/TAO/performance-tests/Pluggable/PP_Test_Server.h
index 5da32da08c2..fb3d184dabf 100644
--- a/TAO/performance-tests/Pluggable/PP_Test_Server.h
+++ b/TAO/performance-tests/Pluggable/PP_Test_Server.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Pluggable
-//
-// = FILENAME
-// PP_Test_Server.h
-//
-// = DESCRIPTION
-// This class implements simple oneway and twoway no-op requests
-// to time latency and overhead of the pluggable protocol functionality.
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file PP_Test_Server.h
+ *
+ * $Id$
+ *
+ * This class implements simple oneway and twoway no-op requests
+ * to time latency and overhead of the pluggable protocol functionality.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _PP_TEST_SERVER_H
#define _PP_TEST_SERVER_H
@@ -30,52 +26,54 @@
#include "tao/Utils/ORB_Manager.h"
#include "PP_Test_i.h"
+/**
+ * @class PP_Test_Server
+ *
+ * @brief Defines a 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 server's state and then call run
+ * to run the orb.
+ */
class PP_Test_Server
{
- // = TITLE
- // Defines a 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 server's state and then call run
- // to run the orb.
public:
// = Initialization and termination methods.
+ /// Default constructor
PP_Test_Server (void);
- // Default constructor
+ /// Destructor
~PP_Test_Server (void);
- // Destructor
+ /// Initialize the server state - parsing arguments, etc.
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the server state - parsing arguments, etc.
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// File to output the cubit factory IOR.
FILE* ior_output_file_;
- // File to output the cubit factory IOR.
+ /// The ORB manager.
TAO_ORB_Manager orb_manager_;
- // The ORB manager.
+ /// Implementation object of the Pluggable Test factory.
Pluggable_Test_Factory_i *factory_impl_;
- // Implementation object of the Pluggable Test factory.
+ /// ID of the factory.
CORBA::String_var factory_id_;
- // ID of the factory.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
};
#endif /* _PP_TEST_SERVER_H */
diff --git a/TAO/performance-tests/Pluggable/PP_Test_i.cpp b/TAO/performance-tests/Pluggable/PP_Test_i.cpp
index 724e79e71d3..fb9bd0df41d 100644
--- a/TAO/performance-tests/Pluggable/PP_Test_i.cpp
+++ b/TAO/performance-tests/Pluggable/PP_Test_i.cpp
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Pluggable
-//
-// = FILENAME
-// PP_Test_i.cpp
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file PP_Test_i.cpp
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "tao/Timeprobe.h"
#include "tao/ORB_Constants.h"
diff --git a/TAO/performance-tests/Pluggable/PP_Test_i.h b/TAO/performance-tests/Pluggable/PP_Test_i.h
index 51e7c8b4b4a..f964518c379 100644
--- a/TAO/performance-tests/Pluggable/PP_Test_i.h
+++ b/TAO/performance-tests/Pluggable/PP_Test_i.h
@@ -1,69 +1,70 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/Pluggable
-//
-// = FILENAME
-// PP_Test_i.h
-//
-// = AUTHOR
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file PP_Test_i.h
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _PP_TEST_I_H
#define _PP_TEST_I_H
#include "PP_TestS.h"
+/**
+ * @class PP_Test_i
+ *
+ * @brief Illustrates how to integrate a servant with the generated
+ * skeleton.
+ *
+ * Implementation of the example at the servant side.
+ * Sends a no-op oneway and twoway request.
+ */
class PP_Test_i : public POA_Pluggable_Test
{
- // = TITLE
- // Illustrates how to integrate a servant with the generated
- // skeleton.
- //
- // = DESCRIPTION
- // Implementation of the example at the servant side.
- // Sends a no-op oneway and twoway request.
public:
+ /// Constructor
PP_Test_i (CORBA::ORB_ptr orb);
- // Constructor
+ /// Destructor
~PP_Test_i (void);
- // Destructor
+ /// Test a oneway call.
virtual void send_oneway (void);
- // Test a oneway call.
+ /// Test a twoway call.
virtual void send_void (void);
- // Test a twoway call.
+ /// Shutdown routine.
virtual void shutdown (void);
- // Shutdown routine.
protected:
+ /// Keep a pointer to the ORB so we can shut it down.
CORBA::ORB_var orb_;
- // Keep a pointer to the ORB so we can shut it down.
};
+/**
+ * @class Pluggable_Test_Factory_i:
+ *
+ * @brief Pluggable_Test_Factory_i
+ *
+ * Factory object returning the Pluggable_Test objrefs
+ */
class Pluggable_Test_Factory_i: public POA_Pluggable_Test_Factory
{
- // = TITLE
- // Pluggable_Test_Factory_i
- //
- // = DESCRIPTION
- // Factory object returning the Pluggable_Test objrefs
public:
+ /// Constructor.
Pluggable_Test_Factory_i (CORBA::ORB_ptr orb);
- // Constructor.
+ /// Destructor.
~Pluggable_Test_Factory_i (void);
- // Destructor.
+ /// Make a Pluggable Test object.
virtual Pluggable_Test_ptr make_pluggable_test (void);
- // Make a Pluggable Test object.
private:
PP_Test_i my_pluggable_test_;
diff --git a/TAO/performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h b/TAO/performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h
index e4cecd82b54..aa9c06f130a 100644
--- a/TAO/performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h
+++ b/TAO/performance-tests/RTCorba/Multiple_Endpoints/Common/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/TPP
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_TPP_TEST_I_H
#define TAO_TPP_TEST_I_H
#include "testS.h"
+/**
+ * @class Test_i
+ *
+ * @brief An implementation for the Test interface
+ *
+ * Implements the Test interface in test.idl
+ */
class RTCORBA_COMMON_Export Test_i : public POA_Test
{
- // = TITLE
- // An implementation for the Test interface
- //
- // = DESCRIPTION
- // Implements the Test interface in test.idl
- //
public:
+ /// ctor
Test_i (void);
- // ctor
// = The Test methods.
void test_method (CORBA::Long id);
diff --git a/TAO/performance-tests/RTCorba/Oneways/Reliable/test_i.h b/TAO/performance-tests/RTCorba/Oneways/Reliable/test_i.h
index 2c9998d16c4..5f5a56a1a83 100644
--- a/TAO/performance-tests/RTCorba/Oneways/Reliable/test_i.h
+++ b/TAO/performance-tests/RTCorba/Oneways/Reliable/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/performance-tests/RTCorba/Oneways/Reliable
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef TAO_RELIABLE_TEST_I_H
#define TAO_RELIABLE_TEST_I_H
#include "testS.h"
+/**
+ * @class Test_i
+ *
+ * @brief An implementation for the Test interface
+ *
+ * Implements the Test interface in test.idl
+ */
class Test_i : public POA_Test
{
- // = TITLE
- // An implementation for the Test interface
- //
- // = DESCRIPTION
- // Implements the Test interface in test.idl
- //
public:
+ /// ctor
Test_i (CORBA::ORB_ptr orb);
- // ctor
// = The Test methods.
void oneway_payload_test (const Test::data &d);
@@ -40,8 +38,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tao/IORManipulation/IORManip_Filter.h b/TAO/tao/IORManipulation/IORManip_Filter.h
index 91b8e9ee163..dc7ad95d74d 100644
--- a/TAO/tao/IORManipulation/IORManip_Filter.h
+++ b/TAO/tao/IORManipulation/IORManip_Filter.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// =========================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// IORManip_Filter.h
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// =========================================================================
+
+//=============================================================================
+/**
+ * @file IORManip_Filter.h
+ *
+ * $Id$
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_IORMANIP_FILTER_H
#define TAO_IORMANIP_FILTER_H
diff --git a/TAO/tao/IORManipulation/IORManip_IIOP_Filter.h b/TAO/tao/IORManipulation/IORManip_IIOP_Filter.h
index 73c6b661e7c..dd1d732ec0a 100644
--- a/TAO/tao/IORManipulation/IORManip_IIOP_Filter.h
+++ b/TAO/tao/IORManipulation/IORManip_IIOP_Filter.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// =========================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// IORManip_IIOP_Filter.h
-//
-// = AUTHOR
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// =========================================================================
+
+//=============================================================================
+/**
+ * @file IORManip_IIOP_Filter.h
+ *
+ * $Id$
+ *
+ * @author Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#ifndef TAO_IORMANIP_IIOP_FILTER_H
#define TAO_IORMANIP_IIOP_FILTER_H
diff --git a/TAO/tests/AMI_Timeouts/timeout_client.h b/TAO/tests/AMI_Timeouts/timeout_client.h
index 126be343504..e554b62ff80 100644
--- a/TAO/tests/AMI_Timeouts/timeout_client.h
+++ b/TAO/tests/AMI_Timeouts/timeout_client.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI_Timeouts
-//
-// = FILENAME
-// timeout_client.h
-//
-// = DESCRIPTION
-// Tests timeouts with AMI.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file timeout_client.h
+ *
+ * $Id$
+ *
+ * Tests timeouts with AMI.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "ace/Task.h"
diff --git a/TAO/tests/AMI_Timeouts/timeout_i.cpp b/TAO/tests/AMI_Timeouts/timeout_i.cpp
index fc67d8d8f09..a218795e902 100644
--- a/TAO/tests/AMI_Timeouts/timeout_i.cpp
+++ b/TAO/tests/AMI_Timeouts/timeout_i.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI_Timeouts
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Implements the timeout CORBA Object and its reply handler.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Implements the timeout CORBA Object and its reply handler.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "timeout_i.h"
#include "ace/OS_NS_unistd.h"
diff --git a/TAO/tests/AMI_Timeouts/timeout_i.h b/TAO/tests/AMI_Timeouts/timeout_i.h
index cde9fbcea71..3b7c7996303 100644
--- a/TAO/tests/AMI_Timeouts/timeout_i.h
+++ b/TAO/tests/AMI_Timeouts/timeout_i.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/AMI_Timeouts
-//
-// = FILENAME
-// timeout_i.h
-//
-// = DESCRIPTION
-// Implements the CORBA object.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file timeout_i.h
+ *
+ * $Id$
+ *
+ * Implements the CORBA object.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef TIMEOUT_I_H
#define TIMEOUT_I_H
diff --git a/TAO/tests/Alt_Mapping/alt_mapping_i.cpp b/TAO/tests/Alt_Mapping/alt_mapping_i.cpp
index f9392cbfda5..148c44a6c65 100644
--- a/TAO/tests/Alt_Mapping/alt_mapping_i.cpp
+++ b/TAO/tests/Alt_Mapping/alt_mapping_i.cpp
@@ -1,14 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// alt_mapping_i.cpp
-//
-// = AUTHOR
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file alt_mapping_i.cpp
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "alt_mapping_i.h"
diff --git a/TAO/tests/Alt_Mapping/alt_mapping_i.h b/TAO/tests/Alt_Mapping/alt_mapping_i.h
index 4eabc9a117f..c7d82ed4d58 100644
--- a/TAO/tests/Alt_Mapping/alt_mapping_i.h
+++ b/TAO/tests/Alt_Mapping/alt_mapping_i.h
@@ -1,26 +1,29 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// alt_mapping_i.h
-//
-// = AUTHOR
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file alt_mapping_i.h
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef ALT_MAPPING_I_H
#define ALT_MAPPING_I_H
#include "alt_mappingS.h"
+/**
+ * @class Alt_Mapping_i
+ *
+ * @brief Alt_Mapping_i
+ *
+ * Implementation of the Alt_Mapping_i test suite.
+ */
class Alt_Mapping_i : public POA_Alt_Mapping
{
- // = TITLE
- // Alt_Mapping_i
- // = DESCRIPTION
- // Implementation of the Alt_Mapping_i test suite.
public:
Alt_Mapping_i (CORBA::ORB_ptr orb);
diff --git a/TAO/tests/Alt_Mapping/client.cpp b/TAO/tests/Alt_Mapping/client.cpp
index 997152d5731..c7e35907ed7 100644
--- a/TAO/tests/Alt_Mapping/client.cpp
+++ b/TAO/tests/Alt_Mapping/client.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This file contains the implementation of the client-side of the
-// Alt_Mapping application.
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This file contains the implementation of the client-side of the
+ * Alt_Mapping application.
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef CLIENT_CPP
#define CLIENT_CPP
diff --git a/TAO/tests/Alt_Mapping/client.h b/TAO/tests/Alt_Mapping/client.h
index acdb2a18612..fe39af905ca 100644
--- a/TAO/tests/Alt_Mapping/client.h
+++ b/TAO/tests/Alt_Mapping/client.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Alt_Mapping_Test
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// Header file for the Alt_Mapping_Test client application.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * Header file for the Alt_Mapping_Test client application.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef ALT_MAPPING_CLIENT_H
#define ALT_MAPPING_CLIENT_H
@@ -24,18 +20,20 @@
#include "alt_mappingC.h"
#include "results.h"
+/**
+ * @class Alt_Mapping_Client
+ *
+ * @brief Alt_Mapping_Client
+ *
+ * This class declares an interface to run the example client for
+ * Alt_Mapping CORBA server. All the complexity for initializing
+ * the client is hidden in the class. Just the run () interface
+ * is needed. The template class does the specific work of making
+ * the request of the desired data type
+ */
template <class T>
class Alt_Mapping_Client
{
- // = TITLE
- // Alt_Mapping_Client
- //
- // = DESCRIPTION
- // This class declares an interface to run the example client for
- // Alt_Mapping CORBA server. All the complexity for initializing
- // the client is hidden in the class. Just the run () interface
- // is needed. The template class does the specific work of making
- // the request of the desired data type
public:
typedef T TEST_OBJECT;
@@ -46,21 +44,21 @@ public:
~Alt_Mapping_Client (void);
+ /// run the SII test
int run_sii_test (void);
- // run the SII test
private:
+ /// underlying ORB
CORBA::ORB_ptr orb_;
- // underlying ORB
+ /// alt mapping object reference
Alt_Mapping_ptr alt_mapping_test_;
- // alt mapping object reference
+ /// object doing the actual work
TEST_OBJECT *test_object_;
- // object doing the actual work
+ /// results
Results results_;
- // results
};
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
diff --git a/TAO/tests/Alt_Mapping/driver.cpp b/TAO/tests/Alt_Mapping/driver.cpp
index 637782e2ba7..33c8f309576 100644
--- a/TAO/tests/Alt_Mapping/driver.cpp
+++ b/TAO/tests/Alt_Mapping/driver.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// driver.cpp
-//
-// = DESCRIPTION
-// Driver program
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file driver.cpp
+ *
+ * $Id$
+ *
+ * Driver program
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "client.h"
#include "driver.h"
diff --git a/TAO/tests/Alt_Mapping/driver.h b/TAO/tests/Alt_Mapping/driver.h
index 0b670df7541..e20e146ca7d 100644
--- a/TAO/tests/Alt_Mapping/driver.h
+++ b/TAO/tests/Alt_Mapping/driver.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// driver.h
-//
-// = DESCRIPTION
-// Header file for the driver program. The driver is a singleton.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file driver.h
+ *
+ * $Id$
+ *
+ * Header file for the driver program. The driver is a singleton.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef DRIVER_H
#define DRIVER_H
@@ -23,30 +19,32 @@
#include "options.h"
#include "alt_mappingC.h"
+/**
+ * @class Driver
+ *
+ * @brief Driver
+ *
+ * Driver program for the client
+ */
class Driver
{
- // = TITLE
- // Driver
- //
- // = DESCRIPTION
- // Driver program for the client
public:
// = Constructor and destructor.
Driver (void);
~Driver (void);
+ /// Initialize the driver object
int init (int argc, ACE_TCHAR **argv);
- // Initialize the driver object
+ /// Execute client example code.
int run (void);
- // Execute client example code.
private:
+ /// underlying ORB (we do not own it)
CORBA::ORB_var orb_;
- // underlying ORB (we do not own it)
+ /// object reference (we do not own it)
Alt_Mapping_var objref_;
- // object reference (we do not own it)
};
#endif /* !defined */
diff --git a/TAO/tests/Alt_Mapping/helper.cpp b/TAO/tests/Alt_Mapping/helper.cpp
index 26f38b4ce3a..e3102eedaa0 100644
--- a/TAO/tests/Alt_Mapping/helper.cpp
+++ b/TAO/tests/Alt_Mapping/helper.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// helper.cpp
-//
-// = DESCRIPTION
-// Defines a helper class that can generate values for the parameters used
-// for the Alt_Mapping example
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file helper.cpp
+ *
+ * $Id$
+ *
+ * Defines a helper class that can generate values for the parameters used
+ * for the Alt_Mapping example
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "helper.h"
#include "ace/OS_NS_ctype.h"
diff --git a/TAO/tests/Alt_Mapping/helper.h b/TAO/tests/Alt_Mapping/helper.h
index 78aad3946a9..440dea5fb6c 100644
--- a/TAO/tests/Alt_Mapping/helper.h
+++ b/TAO/tests/Alt_Mapping/helper.h
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// helper.h
-//
-// = DESCRIPTION
-// Defines a helper class that can generate values for the parameters used
-// for the Param_Test example
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file helper.h
+ *
+ * $Id$
+ *
+ * Defines a helper class that can generate values for the parameters used
+ * for the Param_Test example
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef HELPER_H
#define HELPER_H
diff --git a/TAO/tests/Alt_Mapping/options.cpp b/TAO/tests/Alt_Mapping/options.cpp
index 7f662b7d7a7..66277389717 100644
--- a/TAO/tests/Alt_Mapping/options.cpp
+++ b/TAO/tests/Alt_Mapping/options.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// options.cpp
-//
-// = DESCRIPTION
-// Options for the Param_Test application
-//
-// = AUTHORS
-// Jeff Parsonss
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file options.cpp
+ *
+ * $Id$
+ *
+ * Options for the Param_Test application
+ *
+ *
+ * @author Jeff Parsonss
+ */
+//=============================================================================
+
#include "options.h"
#include "tao/debug.h"
diff --git a/TAO/tests/Alt_Mapping/options.h b/TAO/tests/Alt_Mapping/options.h
index d6596a5b74f..1c6d3fcbcc3 100644
--- a/TAO/tests/Alt_Mapping/options.h
+++ b/TAO/tests/Alt_Mapping/options.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// options.h
-//
-// = DESCRIPTION
-// Options for the Param_Test application
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file options.h
+ *
+ * $Id$
+ *
+ * Options for the Param_Test application
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef OPTIONS_H
#define OPTIONS_H
@@ -46,54 +42,54 @@ public:
DII
};
+ /// constructor
Options (void);
- // constructor
+ /// destructor
~Options (void);
- // destructor
+ /// Parses the arguments passed on the command line.
int parse_args (int argc, ACE_TCHAR **argv);
- // Parses the arguments passed on the command line.
+ /// return the IOR for the servant
char const * param_test_ior (void) const;
- // return the IOR for the servant
+ /// what test to run
TEST_TYPE test_type (void);
- // what test to run
+ /// whether to use SII or DII
INVOKE_TYPE invoke_type (void);
- // whether to use SII or DII
+ /// number of times to run the test
CORBA::ULong loop_count (void);
- // number of times to run the test
+ /// whether debug option is on or not
CORBA::Boolean debug (void) const;
- // whether debug option is on or not
+ /// If we should request the server to shutdown.
CORBA::Boolean shutdown (void) const;
- // If we should request the server to shutdown.
private:
+ /// Function to read the servant IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the servant IOR from a file.
+ /// IOR for the servant
CORBA::String_var ior_;
- // IOR for the servant
+ /// what test to run
TEST_TYPE test_type_;
- // what test to run
+ /// whether SII or DII
INVOKE_TYPE invoke_type_;
- // whether SII or DII
+ /// Number of times to do the "test_*" operations.
CORBA::ULong loop_count_;
- // Number of times to do the "test_*" operations.
+ /// debugging output values
CORBA::Boolean debug_;
- // debugging output values
+ /// server shutdown flag.
CORBA::Boolean shutdown_;
- // server shutdown flag.
};
typedef ACE_Singleton<Options, TAO_SYNCH_RECURSIVE_MUTEX> OPTIONS;
diff --git a/TAO/tests/Alt_Mapping/results.cpp b/TAO/tests/Alt_Mapping/results.cpp
index 56d38e2a92e..d196920829c 100644
--- a/TAO/tests/Alt_Mapping/results.cpp
+++ b/TAO/tests/Alt_Mapping/results.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// results.cpp
-//
-// = DESCRIPTION
-// Printing the results
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file results.cpp
+ *
+ * $Id$
+ *
+ * Printing the results
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "results.h"
#include "tao/debug.h"
diff --git a/TAO/tests/Alt_Mapping/results.h b/TAO/tests/Alt_Mapping/results.h
index e04e26e5f3c..65c490debd4 100644
--- a/TAO/tests/Alt_Mapping/results.h
+++ b/TAO/tests/Alt_Mapping/results.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// results.h
-//
-// = DESCRIPTION
-// Printing the results
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file results.h
+ *
+ * $Id$
+ *
+ * Printing the results
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef RESULTS_H
#define RESULTS_H
@@ -38,51 +35,51 @@ TAO_END_VERSIONED_NAMESPACE_DECL
class Results
{
public:
+ /// ctor
Results (void);
- // ctor
+ /// destructor
~Results (void);
- // destructor
+ /// prints the time stats
void print_stats (void);
- // prints the time stats
+ /// print the exception
void print_exception (const char *call_name);
- // print the exception
+ /// start timing
void start_timer (void);
- // start timing
+ /// stop timing
void stop_timer (void);
- // stop timing
+ /// return call count
CORBA::ULong call_count (void);
- // return call count
+ /// set the call count
void call_count (CORBA::ULong);
- // set the call count
+ /// return the error count
CORBA::ULong error_count (void);
- // return the error count
+ /// set error count
void error_count (CORBA::ULong);
- // set error count
+ /// set the number of times the test will be run
void iterations (CORBA::ULong iters);
- // set the number of times the test will be run
private:
+ /// # of calls made to functions
CORBA::ULong call_count_;
- // # of calls made to functions
+ /// # of errors incurred in the lifetime of the application.
CORBA::ULong error_count_;
- // # of errors incurred in the lifetime of the application.
+ /// for timing the test
ACE_Profile_Timer timer_;
- // for timing the test
+ /// holds the elapsed time for each iteration
ACE_Profile_Timer::ACE_Elapsed_Time *elapsed_time_;
- // holds the elapsed time for each iteration
};
#endif /* RESULTS_H */
diff --git a/TAO/tests/Alt_Mapping/server.cpp b/TAO/tests/Alt_Mapping/server.cpp
index a0098e9d9b4..16b2a14bcfc 100644
--- a/TAO/tests/Alt_Mapping/server.cpp
+++ b/TAO/tests/Alt_Mapping/server.cpp
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHOR
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "alt_mapping_i.h"
#include "tao/Codeset/Codeset.h"
diff --git a/TAO/tests/Alt_Mapping/tests.h b/TAO/tests/Alt_Mapping/tests.h
index ed6cdb30ef8..e435bc5d383 100644
--- a/TAO/tests/Alt_Mapping/tests.h
+++ b/TAO/tests/Alt_Mapping/tests.h
@@ -1,17 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = FILENAME
-// tests.h
-//
-// = DESCRIPTION
-// All the test objects header files included here
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file tests.h
+ *
+ * $Id$
+ *
+ * All the test objects header files included here
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef TESTS_H
#define TESTS_H
diff --git a/TAO/tests/Alt_Mapping/ub_string.cpp b/TAO/tests/Alt_Mapping/ub_string.cpp
index 426b3dfd000..420d0215d4e 100644
--- a/TAO/tests/Alt_Mapping/ub_string.cpp
+++ b/TAO/tests/Alt_Mapping/ub_string.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_string.cpp
-//
-// = DESCRIPTION
-// tests unbounded strings
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_string.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded strings
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_string.h"
diff --git a/TAO/tests/Alt_Mapping/ub_string.h b/TAO/tests/Alt_Mapping/ub_string.h
index a66640052d1..aa06499ad3c 100644
--- a/TAO/tests/Alt_Mapping/ub_string.h
+++ b/TAO/tests/Alt_Mapping/ub_string.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// unbounded_string.h
-//
-// = DESCRIPTION
-// Tests unbounded string
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file unbounded_string.h
+ *
+ * $Id$
+ *
+ * Tests unbounded string
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_STRING_H
#define PARAM_TEST_UNBOUNDED_STRING_H
@@ -27,36 +24,36 @@
class Test_Unbounded_String
{
public:
+ /// ctor
Test_Unbounded_String (void);
- // ctor
+ /// dtor
~Test_Unbounded_String (void);
- // dtor
+ /// run the SII test
int run_sii_test (Alt_Mapping_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Alt_Mapping_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
private:
+ /// operation name
char *opname_;
- // operation name
std::string in_;
std::string inout_;
diff --git a/TAO/tests/Alt_Mapping/ub_struct_seq.cpp b/TAO/tests/Alt_Mapping/ub_struct_seq.cpp
index 019df9de1f0..34084dd495a 100644
--- a/TAO/tests/Alt_Mapping/ub_struct_seq.cpp
+++ b/TAO/tests/Alt_Mapping/ub_struct_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_struct_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded struct sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_struct_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded struct sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_struct_seq.h"
diff --git a/TAO/tests/Alt_Mapping/ub_struct_seq.h b/TAO/tests/Alt_Mapping/ub_struct_seq.h
index a79a5fcf70a..17ee8681201 100644
--- a/TAO/tests/Alt_Mapping/ub_struct_seq.h
+++ b/TAO/tests/Alt_Mapping/ub_struct_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_struct_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded struct sequence
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_struct_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded struct sequence
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef ALT_MAPPING_TEST_UNBOUNED_STRUCT_SEQUENCE_H
#define ALT_MAPPING_TEST_UNBOUNED_STRUCT_SEQUENCE_H
@@ -28,37 +25,37 @@
class Test_Unbounded_Struct_Sequence
{
public:
+ /// ctor
Test_Unbounded_Struct_Sequence (void);
- // ctor
+ /// dtor
~Test_Unbounded_Struct_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Alt_Mapping_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Alt_Mapping_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// print all the values
void print_values (void);
- // print all the values
protected:
+ /// compare
CORBA::Boolean compare (const Alt_Mapping::StructSeq &s1,
const Alt_Mapping::StructSeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Alt_Mapping::StructSeq &s);
- // print individual sequence
private:
char *opname_;
diff --git a/TAO/tests/BiDirectional/test_i.h b/TAO/tests/BiDirectional/test_i.h
index cc4725dc141..3914ef78a3e 100644
--- a/TAO/tests/BiDirectional/test_i.h
+++ b/TAO/tests/BiDirectional/test_i.h
@@ -1,59 +1,58 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
#include "testS.h"
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// Safe way to shutdown
void shutdown (void);
- // Safe way to shutdown
+ /// The callback method
void callback_method (void);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @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, int no_iterations);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback);
@@ -65,17 +64,17 @@ public:
int call_client (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Callback_var callback_;
- // Callback Object
+ /// Number of times the callback needs to be called
int no_iterations_;
- // Number of times the callback needs to be called
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/BiDirectional_DelayedUpcall/test_i.h b/TAO/tests/BiDirectional_DelayedUpcall/test_i.h
index ba1f46f4764..3a4bc82f063 100644
--- a/TAO/tests/BiDirectional_DelayedUpcall/test_i.h
+++ b/TAO/tests/BiDirectional_DelayedUpcall/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
@@ -19,43 +16,45 @@
#include "testS.h"
#include "ace/Event_Handler.h"
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public virtual POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb, Simple_Server_ptr srv);
- // ctor
+ /// Safe way to shutdown
void shutdown (void);
- // Safe way to shutdown
+ /// The callback method
void callback_method (void);
- // The callback method
private:
+ /// The orb
+ /// The server
CORBA::ORB_var orb_;
- // The orb
Simple_Server_var server_;
- // The server
};
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public virtual POA_Simple_Server, public virtual ACE_Event_Handler
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb, int no_iterations);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback);
@@ -68,17 +67,17 @@ public:
const void *act = 0);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Callback_var callback_;
- // Callback Object
+ /// Number of times the callback needs to be called
int no_iterations_;
- // Number of times the callback needs to be called
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/BiDirectional_MultipleORB/destroy.cpp b/TAO/tests/BiDirectional_MultipleORB/destroy.cpp
index 0644e2078a8..718576ac8a1 100644
--- a/TAO/tests/BiDirectional_MultipleORB/destroy.cpp
+++ b/TAO/tests/BiDirectional_MultipleORB/destroy.cpp
@@ -1,21 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDir_Multiple_ORB
-//
-// = FILENAME
-// destroy.cpp
-//
-// = DESCRIPTION
-// Modified ORB destruction test.
-//
-// = AUTHOR
-// Andrew Schnable <Andrew.Schnable@veritas.com>
-// Iliyan Jeliazkov <jeliazkov_i@ociweb.com>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file destroy.cpp
+ *
+ * $Id$
+ *
+ * Modified ORB destruction test.
+ *
+ *
+ * @author Andrew Schnable <Andrew.Schnable@veritas.com> Iliyan Jeliazkov <jeliazkov_i@ociweb.com>
+ */
+//=============================================================================
+
#include "tao/corba.h"
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/BiDirectional_NestedUpcall/test_i.h b/TAO/tests/BiDirectional_NestedUpcall/test_i.h
index 41c91c52b59..7ae2ce17af0 100644
--- a/TAO/tests/BiDirectional_NestedUpcall/test_i.h
+++ b/TAO/tests/BiDirectional_NestedUpcall/test_i.h
@@ -1,58 +1,57 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
#include "testS.h"
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public virtual POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// Safe way to shutdown
void shutdown (void);
- // Safe way to shutdown
+ /// The callback method
void callback_method (void);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Simple_Server_i : public virtual 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, int no_iterations);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback);
@@ -62,17 +61,17 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Callback_var callback_;
- // Callback Object
+ /// Number of times the callback needs to be called
int no_iterations_;
- // Number of times the callback needs to be called
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/Bug_2174_Regression/test_i.h b/TAO/tests/Bug_2174_Regression/test_i.h
index 8c102e3a1b7..eb3d07084a5 100644
--- a/TAO/tests/Bug_2174_Regression/test_i.h
+++ b/TAO/tests/Bug_2174_Regression/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Timeout
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_TIMEOUT_TEST_I_H
#define TAO_TIMEOUT_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.
CORBA::Long echo (CORBA::Long x,
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TIMEOUT_TEST_I_H */
diff --git a/TAO/tests/Bug_2734_Regression/test_i.h b/TAO/tests/Bug_2734_Regression/test_i.h
index 8c102e3a1b7..eb3d07084a5 100644
--- a/TAO/tests/Bug_2734_Regression/test_i.h
+++ b/TAO/tests/Bug_2734_Regression/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Timeout
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_TIMEOUT_TEST_I_H
#define TAO_TIMEOUT_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.
CORBA::Long echo (CORBA::Long x,
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TIMEOUT_TEST_I_H */
diff --git a/TAO/tests/Bug_2935_Regression/middle_i.h b/TAO/tests/Bug_2935_Regression/middle_i.h
index 74de26395d4..08ef48d788f 100644
--- a/TAO/tests/Bug_2935_Regression/middle_i.h
+++ b/TAO/tests/Bug_2935_Regression/middle_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/time
-//
-// = FILENAME
-// middle_i.h
-//
-// = DESCRIPTION
-// This class implements the Time IDL interface.
-//
-// = AUTHOR
-// Darrell Brunsch <brunsch@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file middle_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Time IDL interface.
+ *
+ *
+ * @author Darrell Brunsch <brunsch@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef MIDDLE_I_H
#define MIDDLE_I_H
@@ -23,15 +20,16 @@
#include "ThreeTierC.h"
#include "ThreeTierS.h"
+/**
+ * @class Middle_i:
+ *
+ * @brief ThreeTier Object Implementation as middle
+ *
+ * The middle implementaiton of the ThreeTier interface simply
+ * forwards requests to
+ */
class Middle_i: public POA_ThreeTier
{
- // = TITLE
- // ThreeTier Object Implementation as middle
- //
- // = DESCRIPTION
- // The middle implementaiton of the ThreeTier interface simply
- // forwards requests to
- //
public:
Middle_i (CORBA::ORB_ptr orb, ThreeTier_ptr target);
~Middle_i ();
diff --git a/TAO/tests/Bug_2935_Regression/sink_i.h b/TAO/tests/Bug_2935_Regression/sink_i.h
index 4b184c09e8f..3e4f72cd3b4 100644
--- a/TAO/tests/Bug_2935_Regression/sink_i.h
+++ b/TAO/tests/Bug_2935_Regression/sink_i.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/ThreeTier
-//
-// = FILENAME
-// Sink_i.h
-//
-// = DESCRIPTION
-// This class implements the ThreeTier IDL interface.
-// It acts as the "end of the line" for tick and tock
-// requests.
-//
-// = AUTHOR
-// Dale Wilson <wilsond@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Sink_i.h
+ *
+ * $Id$
+ *
+ * This class implements the ThreeTier IDL interface.
+ * It acts as the "end of the line" for tick and tock
+ * requests.
+ *
+ *
+ * @author Dale Wilson <wilsond@ociweb.com>
+ */
+//=============================================================================
+
#ifndef SINK_I_H
#define SINK_I_H
@@ -31,8 +28,8 @@ public:
/// @param an initialized ORB
Sink_i (CORBA::ORB_ptr orb);
+ /// Destructor
~Sink_i ();
- // Destructor
bool parse_args (int & argc, ACE_TCHAR * argv[]);
diff --git a/TAO/tests/Bug_2935_Regression/source_i.h b/TAO/tests/Bug_2935_Regression/source_i.h
index add472917c2..7c1e423ff82 100644
--- a/TAO/tests/Bug_2935_Regression/source_i.h
+++ b/TAO/tests/Bug_2935_Regression/source_i.h
@@ -1,35 +1,34 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/ThreeTier
-//
-// = FILENAME
-// source_i.h
-//
-// = DESCRIPTION
-// This class implements the source for a three tier system
-// Adapted from TAO/examples/Simple/time
-//
-// = AUTHOR
-// Dale Wilson <wilsond@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file source_i.h
+ *
+ * $Id$
+ *
+ * This class implements the source for a three tier system
+ * Adapted from TAO/examples/Simple/time
+ *
+ *
+ * @author Dale Wilson <wilsond@ociweb.com>
+ */
+//=============================================================================
+
#ifndef SOURCE_I_H
#define SOURCE_I_H
#include "ThreeTierC.h"
+/**
+ * @class Source_i
+ *
+ * @brief Source interface subclass.
+ *
+ * a source of data for the three tier test
+ */
class Source_i
{
- // = TITLE
- // Source interface subclass.
- //
- // = DESCRIPTION
- // a source of data for the three tier test
public:
Source_i (ThreeTier_ptr target);
@@ -37,8 +36,8 @@ public:
bool parse_args(int argc, ACE_TCHAR *argv[]);
+ /// Execute the methods
int run ();
- // Execute the methods
private:
ThreeTier_var target_;
diff --git a/TAO/tests/Bug_3068_Regression/test_i.h b/TAO/tests/Bug_3068_Regression/test_i.h
index 57c0aaacf11..461312294b9 100644
--- a/TAO/tests/Bug_3068_Regression/test_i.h
+++ b/TAO/tests/Bug_3068_Regression/test_i.h
@@ -1,18 +1,15 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/BiDirectional
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_BIDIRECTIONAL_TEST_I_H
#define TAO_BIDIRECTIONAL_TEST_I_H
@@ -40,43 +37,46 @@ private:
};
+/**
+ * @class Callback_i
+ *
+ * @brief A callback object to the "client"
+ *
+ * To test that the server can call the client on the same
+ * connection that was established by the client
+ */
class Callback_i : public POA_Callback
{
- // = TITLE
- // A callback object to the "client"
- //
- // = DESCRIPTION
- // To test that the server can call the client on the same
- // connection that was established by the client
- //
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// Safe way to shutdown
void shutdown ();
- // Safe way to shutdown
+ /// The callback method
void callback_method (const CORBA::OctetSeq& payload);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @class Simple_Server_i
+ *
+ * @brief Simpler Server implementation
+ *
+ * Implements the Simple_Server interface in test.idl
+ * for (int loop = 0; loop < 10; loop++)
+ */
class Simple_Server_i : public POA_Simple_Server
{
- // = TITLE
- // Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- // for (int loop = 0; loop < 10; loop++)
public:
+ /// ctor
Simple_Server_i (CORBA::ORB_ptr orb, int no_iterations);
- // ctor
// = The Simple_Server methods.
void ow_test ();
@@ -88,17 +88,17 @@ public:
void shutdown ();
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Flag to indicate, whether we are ready for a remote call.
int flag_;
- // Flag to indicate, whether we are ready for a remote call.
+ /// Callback Object
Caller *caller_;
- // Callback Object
+ /// Number of times the callback needs to be called
int iterations_;
- // Number of times the callback needs to be called
int ow_count_;
};
diff --git a/TAO/tests/Bug_3683_Regression/Echo_Client_i.h b/TAO/tests/Bug_3683_Regression/Echo_Client_i.h
index 2ca50272169..df2d4496a5d 100644
--- a/TAO/tests/Bug_3683_Regression/Echo_Client_i.h
+++ b/TAO/tests/Bug_3683_Regression/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,30 +20,32 @@
#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:
int parse_args (int argc, ACE_TCHAR *argv[]);
+ /// Instantiate the client object.
Client<Echo> client_;
- // Instantiate the client object.
size_t payload_length_;
};
diff --git a/TAO/tests/Bug_3683_Regression/Echo_i.h b/TAO/tests/Bug_3683_Regression/Echo_i.h
index b048eeb8357..5afd29de0b1 100644
--- a/TAO/tests/Bug_3683_Regression/Echo_i.h
+++ b/TAO/tests/Bug_3683_Regression/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/tests/Bug_3683_Regression/Simple_util.h b/TAO/tests/Bug_3683_Regression/Simple_util.h
index a5b2bd8304f..ccd1638d7be 100644
--- a/TAO/tests/Bug_3683_Regression/Simple_util.h
+++ b/TAO/tests/Bug_3683_Regression/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
@@ -24,101 +21,105 @@
#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.
+ /// 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.
+ /// 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)
{
@@ -126,33 +127,33 @@ 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.
+ /// # 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/tests/CDR/alignment.cpp b/TAO/tests/CDR/alignment.cpp
index b5d6a0ca29b..bd4b8574737 100644
--- a/TAO/tests/CDR/alignment.cpp
+++ b/TAO/tests/CDR/alignment.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// alignment.cpp
-//
-// = DESCRIPTION
-// Verifies that octet sequence marshaling does not affect
-// marshaling.
-//
-// = AUTHORS
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file alignment.cpp
+ *
+ * $Id$
+ *
+ * Verifies that octet sequence marshaling does not affect
+ * marshaling.
+ *
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "tao/CDR.h"
diff --git a/TAO/tests/CDR/allocator.cpp b/TAO/tests/CDR/allocator.cpp
index 20301ddecfd..59feefc454c 100644
--- a/TAO/tests/CDR/allocator.cpp
+++ b/TAO/tests/CDR/allocator.cpp
@@ -1,25 +1,22 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// allocator.cpp
-//
-// = DESCRIPTION
-// Compares the performance of a TSS allocator, with no locks, to
-// the global allocator (with locks) even in the abscence of
-// contention.
-// The idea behind this test is to measure the predictability of
-// each allocator, specially under the light of potential
-// fragmentation in the main allocator.
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file allocator.cpp
+ *
+ * $Id$
+ *
+ * Compares the performance of a TSS allocator, with no locks, to
+ * the global allocator (with locks) even in the abscence of
+ * contention.
+ * The idea behind this test is to measure the predictability of
+ * each allocator, specially under the light of potential
+ * fragmentation in the main allocator.
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "tao/ORB_Core.h"
#include "tao/ORB.h"
@@ -29,37 +26,42 @@
#define DEFAULT_BUFFER_SIZE 512
+/**
+ * @class Application_Simulator
+ *
+ * Tries to simulate the behavior of an application: it randomly
+ * acquires and releases memory, of variable sizes.
+ * The intention is to produce some level of fragmentation in main
+ * memory.
+ */
class Application_Simulator
{
- // = DESCRIPTION
- // Tries to simulate the behavior of an application: it randomly
- // acquires and releases memory, of variable sizes.
- // The intention is to produce some level of fragmentation in main
- // memory.
public:
+ /// Constructor, limits the amount of fragmentation and memory this
+ /// class takes.
Application_Simulator (int max_fragments,
int max_fragment_size);
- // Constructor, limits the amount of fragmentation and memory this
- // class takes.
+ /// Destructor, releases any memory left behind.
~Application_Simulator (void);
- // Destructor, releases any memory left behind.
+ /**
+ * Simulate an upcall. The class allocates some memory and then
+ * releases some memory too, the amount of memory allocated and the
+ * number of allocations is random.
+ */
void upcall (unsigned int* seed);
- // Simulate an upcall. The class allocates some memory and then
- // releases some memory too, the amount of memory allocated and the
- // number of allocations is random.
private:
+ /// The allocated buffers.
char** buffers_;
- // The allocated buffers.
+ /// The size of the <buffers_> array.
int max_fragments_;
- // The size of the <buffers_> array.
+ /// The maximum size of any element of <buffers_>
int max_fragment_size_;
- // The maximum size of any element of <buffers_>
};
int
diff --git a/TAO/tests/CDR/basic_types.cpp b/TAO/tests/CDR/basic_types.cpp
index 2f78c30aa77..b4341bddaf0 100644
--- a/TAO/tests/CDR/basic_types.cpp
+++ b/TAO/tests/CDR/basic_types.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// basic_types.cpp
-//
-// = DESCRIPTION
-// Test the basic funcionality of a CDR stream by encoding some
-// basic types and then decoding them again.
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file basic_types.cpp
+ *
+ * $Id$
+ *
+ * Test the basic funcionality of a CDR stream by encoding some
+ * basic types and then decoding them again.
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/debug.h"
diff --git a/TAO/tests/CDR/growth.cpp b/TAO/tests/CDR/growth.cpp
index ebdde8cd3f7..270aff91fb4 100644
--- a/TAO/tests/CDR/growth.cpp
+++ b/TAO/tests/CDR/growth.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// growth.cpp
-//
-// = DESCRIPTION
-// Helps in measuring how the growth strategy affects the
-// performance of CDR streams.
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file growth.cpp
+ *
+ * $Id$
+ *
+ * Helps in measuring how the growth strategy affects the
+ * performance of CDR streams.
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/High_Res_Timer.h"
diff --git a/TAO/tests/CDR/octet_sequence.cpp b/TAO/tests/CDR/octet_sequence.cpp
index 8518aec1aec..22888c58360 100644
--- a/TAO/tests/CDR/octet_sequence.cpp
+++ b/TAO/tests/CDR/octet_sequence.cpp
@@ -1,22 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// octet_sequence.cpp
-//
-// = DESCRIPTION
-// Verifies that reference counting is performed correctly for octet
-// sequence marshaling.
-//
-// = AUTHORS
-// Dave Meyer (dmeyer@std.saic.com)
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file octet_sequence.cpp
+ *
+ * $Id$
+ *
+ * Verifies that reference counting is performed correctly for octet
+ * sequence marshaling.
+ *
+ *
+ * @author Dave Meyer (dmeyer@std.saic.com)Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#include "ace/Log_Msg.h"
diff --git a/TAO/tests/CDR/tc.cpp b/TAO/tests/CDR/tc.cpp
index d5e57b1cd78..f15126eceb2 100644
--- a/TAO/tests/CDR/tc.cpp
+++ b/TAO/tests/CDR/tc.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CDR
-//
-// = FILENAME
-// tc.cpp
-//
-// = DESCRIPTION
-// Verify that the basic typecodes are able to interpret their CDR
-// buffers.
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file tc.cpp
+ *
+ * $Id$
+ *
+ * Verify that the basic typecodes are able to interpret their CDR
+ * buffers.
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "tao/AnyTypeCode/TypeCode.h"
#include "tao/AnyTypeCode/TypeCode_Constants.h"
diff --git a/TAO/tests/CSD_Collocation/Collocation_Tester.h b/TAO/tests/CSD_Collocation/Collocation_Tester.h
index 8756a731843..26592c22039 100644
--- a/TAO/tests/CSD_Collocation/Collocation_Tester.h
+++ b/TAO/tests/CSD_Collocation/Collocation_Tester.h
@@ -1,18 +1,18 @@
-// $Id$
-
-//============================================================================
-//
-// = FILENAME
-// Collocation_Test.h
-//
-// = DESCRIPTION
-// Server class to perform testing of TAO's collocation mechanism.
-//
-// = AUTHOR
-// Nanbor Wang
-//
+
+//=============================================================================
+/**
+ * @file Collocation_Test.h
+ *
+ * $Id$
+ *
+ * Server class to perform testing of TAO's collocation mechanism.
+ *
+ *
+ * @author Nanbor Wang
+ */
//=============================================================================
+
#if !defined (TAO_COLLOCATION_TEST_H)
#define TAO_COLLOCATION_TEST_H
@@ -29,18 +29,18 @@ public:
void shutdown (void);
+ /// Initializing the Collocation_Test object.
int init (int argc, ACE_TCHAR *argv[]);
- // Initializing the Collocation_Test object.
+ /// Parse the test specific arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parse the test specific arguments.
+ /// This test narrow an object reference to its base class and see
+ /// if it works correctly.
int test_narrow (void);
- // This test narrow an object reference to its base class and see
- // if it works correctly.
+ /// Run the test.
int run (void);
- // Run the test.
private:
CORBA::ORB_var orb_;
@@ -49,14 +49,14 @@ private:
PortableServer::POAManager_var poa_manager_;
+ /// Our basic test object.
CORBA::Object_var diamond_obj_;
- // Our basic test object.
+ /// A collection of servant for basic narrowing test.
Top_i top_servant_;
Left_i left_servant_;
Right_i right_servant_;
Buttom_i diamond_servant_;
- // A collection of servant for basic narrowing test.
};
#endif /* TAO_COLLOCATION_TEST_H */
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp
index d5dfd92b64d..88e1e62aa20 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.cpp
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/libs/IBM1047_ISO8859
-//
-// = FILENAME
-// Char_IBM1047_ISO8859_Factory.cpp
-//
-// = DESCRIPTION
-// A tempate instantiation of the codeset translator factory from TAO. This
-// one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
-// translator.
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Char_IBM1047_ISO8859_Factory.cpp
+ *
+ * $Id$
+ *
+ * A tempate instantiation of the codeset translator factory from TAO. This
+ * one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
+ * translator.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "Char_IBM1047_ISO8859_Factory.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h
index 9cf65339c52..16668f9d0cb 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Factory.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/libs/IBM1047_ISO8859
-//
-// = FILENAME
-// Char_IBM1047_ISO8859_Factory.h
-//
-// = DESCRIPTION
-// A tempate instantiation of the codeset translator factory from TAO. This
-// one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
-// translator.
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Char_IBM1047_ISO8859_Factory.h
+ *
+ * $Id$
+ *
+ * A tempate instantiation of the codeset translator factory from TAO. This
+ * one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
+ * translator.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#ifndef CHAR_IBM1047_ISO8859_FACTORY_H
#define CHAR_IBM1047_ISO8859_FACTORY_H
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp
index b4c14d41fae..4c9b150d5b9 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Char_IBM1047_ISO8859_Translator.cpp
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// Char_IBM1047_ISO8859_Translator.cpp
-//
-// = DESCRIPTION
-// Defines the arrays required to convert between ISO8859 (aka
-// Latin/1) and IBM1047 (aka EBCDIC).
-//
-// = AUTHOR
-// Jim Rogers (jrogers@viasoft.com)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Char_IBM1047_ISO8859_Translator.cpp
+ *
+ * $Id$
+ *
+ * Defines the arrays required to convert between ISO8859 (aka
+ * Latin/1) and IBM1047 (aka EBCDIC).
+ *
+ *
+ * @author Jim Rogers (jrogers@viasoft.com)
+ */
+//=============================================================================
+
#include "Char_IBM1047_ISO8859_Translator.h"
#include "ace/OS_Memory.h"
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp
index c395b202966..3f9a95a769d 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.cpp
@@ -1,24 +1,21 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/libs/IBM1047_ISO8859
-//
-// = FILENAME
-// Wchar_IBM1047_ISO8859_Factory.cpp
-//
-// = DESCRIPTION
-// A tempate instantiation of the codeset translator factory from TAO. This
-// one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
-// translator. In this case, wchars and wstrings are translated rather than
-// strings and chars.
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Wchar_IBM1047_ISO8859_Factory.cpp
+ *
+ * $Id$
+ *
+ * A tempate instantiation of the codeset translator factory from TAO. This
+ * one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
+ * translator. In this case, wchars and wstrings are translated rather than
+ * strings and chars.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "Wchar_IBM1047_ISO8859_Factory.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h
index 520933dba9d..ded6dca377a 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Factory.h
@@ -1,24 +1,21 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/libs/IBM1047_ISO8859
-//
-// = FILENAME
-// Wchar_IBM1047_ISO8859_Factory.cpp
-//
-// = DESCRIPTION
-// A tempate instantiation of the codeset translator factory from TAO. This
-// one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
-// translator. In this case, wchars and wstrings are translated rather than
-// strings and chars.
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Wchar_IBM1047_ISO8859_Factory.cpp
+ *
+ * $Id$
+ *
+ * A tempate instantiation of the codeset translator factory from TAO. This
+ * one loads a modified version of ACE's IBM1047 (EBCDIC) to ISO8859 (ASCII)
+ * translator. In this case, wchars and wstrings are translated rather than
+ * strings and chars.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#ifndef WCHAR_IBM1047_ISO8859_FACTORY_H
#define WCHAR_IBM1047_ISO8859_FACTORY_H
diff --git a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp
index a6eb5a8d1d3..0a30896062e 100644
--- a/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp
+++ b/TAO/tests/CodeSets/libs/IBM1047_ISO8859/Wchar_IBM1047_ISO8859_Translator.cpp
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// Wchar_IBM1047_ISO8859_Translator.cpp
-//
-// = DESCRIPTION
-// Defines the arrays required to convert between ISO8859 (aka
-// Latin/1) and IBM1047 (aka EBCDIC).
-//
-// = AUTHOR
-// Mahesh Vedantam (mahesh@ociweb.com)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Wchar_IBM1047_ISO8859_Translator.cpp
+ *
+ * $Id$
+ *
+ * Defines the arrays required to convert between ISO8859 (aka
+ * Latin/1) and IBM1047 (aka EBCDIC).
+ *
+ *
+ * @author Mahesh Vedantam (mahesh@ociweb.com)
+ */
+//=============================================================================
+
#include "Wchar_IBM1047_ISO8859_Translator.h"
diff --git a/TAO/tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp b/TAO/tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp
index 2ff695969cd..c9eb43d47c2 100644
--- a/TAO/tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp
+++ b/TAO/tests/CodeSets/libs/UCS4_UTF16/WUCS4_UTF16.cpp
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// WUCS4_UTF16.cpp
-//
-// = DESCRIPTION
-// Defines the arrays required to convert between UCS-4 a 4 byte wide char
-// codeset, and UCS-16, aka unicode, a 2-byte codeset.
-//
-// = AUTHOR
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file WUCS4_UTF16.cpp
+ *
+ * $Id$
+ *
+ * Defines the arrays required to convert between UCS-4 a 4 byte wide char
+ * codeset, and UCS-16, aka unicode, a 2-byte codeset.
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
#include "WUCS4_UTF16.h"
#include "ace/OS_Memory.h"
diff --git a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp
index b532491333f..498630aa68c 100644
--- a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp
+++ b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tao/Codesets/translators/UTF16_UCS2/
-//
-// = FILENAME
-// UTF16_UCS2_Factory.cpp
-//
-// = DESCRIPTION
-// A tempate instantiation of the codeset translator factory from TAO.
-//
-// = AUTHORS
-// Byron Harris <harrisb@ociweb.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file UTF16_UCS2_Factory.cpp
+ *
+ * $Id$
+ *
+ * A tempate instantiation of the codeset translator factory from TAO.
+ *
+ *
+ * @author Byron Harris <harrisb@ociweb.com>
+ */
+//=============================================================================
+
#include "UTF16_UCS2_Factory.h"
diff --git a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h
index 3cc382fd3f7..5a617905dc3 100644
--- a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h
+++ b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Factory.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/translators/UTF16_UCS2
-//
-// = FILENAME
-// UTF16_UCS2_Factory.cpp
-//
-// = DESCRIPTION
-// A tempate instantiation of a codeset translator factory from TAO. This
-// loads the UTF16_UCS2_Translator.
-//
-// = AUTHORS
-// Byron Harris <harrisb@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file UTF16_UCS2_Factory.cpp
+ *
+ * $Id$
+ *
+ * A tempate instantiation of a codeset translator factory from TAO. This
+ * loads the UTF16_UCS2_Translator.
+ *
+ *
+ * @author Byron Harris <harrisb@ociweb.com>
+ */
+//=============================================================================
+
#ifndef UTF16_UCS2_FACTORY_H
#define UTF16_UCS2_FACTORY_H
diff --git a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp
index d0383fbae43..0c01c8d314d 100644
--- a/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp
+++ b/TAO/tests/CodeSets/libs/UTF16_UCS2/UTF16_UCS2_Translator.cpp
@@ -1,35 +1,31 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// UTF16_UCS2
-//
-// = FILENAME
-// UTF16_UCS2_Translator.cpp
-//
-// = DESCRIPTION
-// Defines the arrays required to convert between UCS-2, a 2 byte wide char
-// codeset, and UCS-16, aka unicode, a 2-byte codeset. As a bit-pattern
-// these two should be identical, with the exception that UCS-2 cannot
-// certain characters that UTF16 can, using escape codepoints.
-//
-// This translator can be dynamically loaded into TAO at run-time using
-// a service configurator file with the following contents:
-//
-// dynamic UTF16_UCS2_Factory Service_Object * UTF16_UCS2:_make_UTF16_UCS2_Factory ()
-//
-// static Resource_Factory
-// "-ORBWCharCodesetTranslator UTF16_UCS2_Factory"
-//
-// This code used UTF16_BOM_Translator as a starting point.
-//
-// = AUTHOR
-// Iliyan Jeliazkov <jeliazkov_i@ociweb.com>
-// Byron Harris <harrisb@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file UTF16_UCS2_Translator.cpp
+ *
+ * $Id$
+ *
+ * Defines the arrays required to convert between UCS-2, a 2 byte wide char
+ * codeset, and UCS-16, aka unicode, a 2-byte codeset. As a bit-pattern
+ * these two should be identical, with the exception that UCS-2 cannot
+ * certain characters that UTF16 can, using escape codepoints.
+ *
+ * This translator can be dynamically loaded into TAO at run-time using
+ * a service configurator file with the following contents:
+ *
+ * dynamic UTF16_UCS2_Factory Service_Object * UTF16_UCS2:_make_UTF16_UCS2_Factory ()
+ *
+ * static Resource_Factory
+ * "-ORBWCharCodesetTranslator UTF16_UCS2_Factory"
+ *
+ * This code used UTF16_BOM_Translator as a starting point.
+ *
+ *
+ * @author Iliyan Jeliazkov <jeliazkov_i@ociweb.com> Byron Harris <harrisb@ociweb.com>
+ */
+//=============================================================================
+
#include "UTF16_UCS2_Translator.h"
#include "tao/debug.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/tests/CodeSets/simple/client.cpp b/TAO/tests/CodeSets/simple/client.cpp
index 217c0237b86..e3c2e1479cc 100644
--- a/TAO/tests/CodeSets/simple/client.cpp
+++ b/TAO/tests/CodeSets/simple/client.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/simple
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A simple client to demonstrate the use of codeset translation
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A simple client to demonstrate the use of codeset translation
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
// IDL generated headers
#include "simpleC.h"
#include "ace/ace_wchar.h"
diff --git a/TAO/tests/CodeSets/simple/server.cpp b/TAO/tests/CodeSets/simple/server.cpp
index f7926efe84d..0d2bc0708a2 100644
--- a/TAO/tests/CodeSets/simple/server.cpp
+++ b/TAO/tests/CodeSets/simple/server.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/CodeSets/simple
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A simple client to demonstrate the use of codeset translation
-//
-// = AUTHORS
-// Phil Mesnier <mesnier_p@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A simple client to demonstrate the use of codeset translation
+ *
+ *
+ * @author Phil Mesnier <mesnier_p@ociweb.com>
+ */
+//=============================================================================
+
// IDL generated header
#include "simpleS.h"
diff --git a/TAO/tests/Collocation/Collocation_Tester.h b/TAO/tests/Collocation/Collocation_Tester.h
index 180dbf6958d..19e3fc9a21f 100644
--- a/TAO/tests/Collocation/Collocation_Tester.h
+++ b/TAO/tests/Collocation/Collocation_Tester.h
@@ -1,18 +1,18 @@
-// $Id$
-
-//============================================================================
-//
-// = FILENAME
-// Collocation_Test.h
-//
-// = DESCRIPTION
-// Server class to perform testing of TAO's collocation mechanism.
-//
-// = AUTHOR
-// Nanbor Wang
-//
+
+//=============================================================================
+/**
+ * @file Collocation_Test.h
+ *
+ * $Id$
+ *
+ * Server class to perform testing of TAO's collocation mechanism.
+ *
+ *
+ * @author Nanbor Wang
+ */
//=============================================================================
+
#if !defined (TAO_COLLOCATION_TEST_H)
#define TAO_COLLOCATION_TEST_H
@@ -31,18 +31,18 @@ public:
void shutdown (void);
+ /// Initializing the Collocation_Test object.
int init (int argc, ACE_TCHAR *argv[]);
- // Initializing the Collocation_Test object.
+ /// Parse the test specific arguments.
int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parse the test specific arguments.
+ /// This test narrow an object reference to its base class and see
+ /// if it works correctly.
int test_narrow (void);
- // This test narrow an object reference to its base class and see
- // if it works correctly.
+ /// Run the test.
int run (void);
- // Run the test.
private:
CORBA::ORB_var orb_;
@@ -51,14 +51,14 @@ private:
PortableServer::POAManager_var poa_manager_;
+ /// Our basic test object.
CORBA::Object_var diamond_obj_;
- // Our basic test object.
+ /// A collection of servant for basic narrowing test.
Top_i top_servant_;
Left_i left_servant_;
Right_i right_servant_;
Buttom_i diamond_servant_;
- // A collection of servant for basic narrowing test.
};
#endif /* TAO_COLLOCATION_TEST_H */
diff --git a/TAO/tests/DIOP/UDP_Client_i.h b/TAO/tests/DIOP/UDP_Client_i.h
index f1b18efe785..bc6d2580966 100644
--- a/TAO/tests/DIOP/UDP_Client_i.h
+++ b/TAO/tests/DIOP/UDP_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/UDP
-//
-// = FILENAME
-// UDP_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the client functionality of the UDP test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file UDP_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the client functionality of the UDP test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef UDP_CLIENT_I_H
#define UDP_CLIENT_I_H
@@ -36,15 +33,15 @@ class UDP_Client_i
//
public:
// = Initialization and termination methods.
+ /// Constructor
UDP_Client_i (CORBA::ORB_ptr orb,
UDP_ptr udp,
UDP_ptr udpHandler,
ACE_UINT32 msec,
ACE_UINT32 iterations);
- // Constructor
+ /// Destructor
virtual ~UDP_Client_i (void);
- // Destructor
private:
// Runs in a separate thread.
diff --git a/TAO/tests/DIOP/UDP_i.h b/TAO/tests/DIOP/UDP_i.h
index fc58a7bea4e..23a7b3da3e2 100644
--- a/TAO/tests/DIOP/UDP_i.h
+++ b/TAO/tests/DIOP/UDP_i.h
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/UDP
-//
-// = FILENAME
-// UDP_i.h
-//
-// = DESCRIPTION
-// This class implements the server functionality of the UDP test.
-// We support only single threaded servers, as we have a null mutex
-// for locking our state.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file UDP_i.h
+ *
+ * $Id$
+ *
+ * This class implements the server functionality of the UDP test.
+ * We support only single threaded servers, as we have a null mutex
+ * for locking our state.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#ifndef UDP_I_H
#define UDP_I_H
@@ -26,34 +23,36 @@
#include "ace/Hash_Map_Manager.h"
#include "ace/Null_Mutex.h"
+/**
+ * @class UDP_i:
+ *
+ * @brief UDP Object Implementation
+ *
+ * This class implements the UDP object, which accepts two methods.
+ * The first, <invoke> accepts a string identifying the client
+ * and a request_id so that the server can verify if the requests
+ * arrived in order.
+ */
class UDP_i: public POA_UDP
{
- // = TITLE
- // UDP Object Implementation
- //
- // = DESCRIPTION
- // This class implements the UDP object, which accepts two methods.
- // The first, <invoke> accepts a string identifying the client
- // and a request_id so that the server can verify if the requests
- // arrived in order.
public:
// = Initialization and termination methods.
+ /// Constructor
UDP_i (CORBA::ORB_ptr o);
- // Constructor
+ /// Destructor
~UDP_i (void);
- // Destructor
virtual void invoke (const char *client_name,
UDP_ptr udpHandler,
CORBA::Long request_id);
+ /// Shutdown the server.
virtual void shutdown (void);
- // Shutdown the server.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
ACE_Hash_Map_Manager_Ex < CORBA::String_var,
CORBA::Long,
diff --git a/TAO/tests/DIOP/client.cpp b/TAO/tests/DIOP/client.cpp
index 69e9c0136a4..8fd43270900 100644
--- a/TAO/tests/DIOP/client.cpp
+++ b/TAO/tests/DIOP/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Basic
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client for the UDP test.
-//
-// = AUTHOR
-// Michael Kircher <Michael.Kircher@mchp.siemens.de>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client for the UDP test.
+ *
+ *
+ * @author Michael Kircher <Michael.Kircher@mchp.siemens.de>
+ */
+//=============================================================================
+
#include "UDPC.h"
diff --git a/TAO/tests/DIOP/server.cpp b/TAO/tests/DIOP/server.cpp
index cd9f9bffc4d..a7372010e30 100644
--- a/TAO/tests/DIOP/server.cpp
+++ b/TAO/tests/DIOP/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/PluggableUDP/tests/Basic
-//
-// = 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 "UDP_i.h"
diff --git a/TAO/tests/DSI_AMI_Gateway/test_dsi.h b/TAO/tests/DSI_AMI_Gateway/test_dsi.h
index 46a0b4aa99d..b8f7c7665e1 100644
--- a/TAO/tests/DSI_AMI_Gateway/test_dsi.h
+++ b/TAO/tests/DSI_AMI_Gateway/test_dsi.h
@@ -1,17 +1,14 @@
-// $Id$
-// ===================================================
-//
-// = LIBRARY
-// TAO/tests/DSI_Gateway
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ===================================================
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_DSI_GATEWAY_TEST_DSI_H
#define TAO_DSI_GATEWAY_TEST_DSI_H
@@ -22,25 +19,28 @@
#include "tao/PortableServer/PortableServer.h"
#include "tao/ORB.h"
+/**
+ * @class DSI_Simple_Server
+ *
+ * @brief DSI Simpler Server implementation
+ *
+ * Implements the DSI/DII gateway.
+ */
class DSI_Simple_Server : public TAO_DynamicImplementation
{
- // = TITLE
- // DSI Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the DSI/DII gateway.
- //
public:
+ /// ctor
DSI_Simple_Server (CORBA::ORB_ptr orb,
CORBA::Object_ptr target,
PortableServer::POA_ptr poa);
- // ctor
+ /**
+ * Turns around and calls invoke, but using AMH style handler
+ * = The DynamicImplementation methods.
+ *
+ */
virtual void _dispatch (TAO_ServerRequest &request,
void *context);
- // Turns around and calls invoke, but using AMH style handler
- // = The DynamicImplementation methods.
- //
// we need this because it is a pure virtual method in
// its parent class
@@ -57,14 +57,14 @@ public:
);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Target object, forward requests to it...
CORBA::Object_var target_;
- // Target object, forward requests to it...
+ /// The POA
PortableServer::POA_var poa_;
- // The POA
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/DSI_AMI_Gateway/test_i.h b/TAO/tests/DSI_AMI_Gateway/test_i.h
index 89e1c70d9f6..0810aac6c63 100644
--- a/TAO/tests/DSI_AMI_Gateway/test_i.h
+++ b/TAO/tests/DSI_AMI_Gateway/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/DSI_Gateway
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_DSI_GATEWAY_TEST_I_H
#define TAO_DSI_GATEWAY_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.
CORBA::Long test_method (CORBA::Long x,
diff --git a/TAO/tests/DSI_Gateway/test_dsi.h b/TAO/tests/DSI_Gateway/test_dsi.h
index 5c5ea947a47..87d7439ae04 100644
--- a/TAO/tests/DSI_Gateway/test_dsi.h
+++ b/TAO/tests/DSI_Gateway/test_dsi.h
@@ -1,17 +1,14 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/DSI_Gateway
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_DSI_GATEWAY_TEST_DSI_H
#define TAO_DSI_GATEWAY_TEST_DSI_H
@@ -21,19 +18,20 @@
#include "tao/PortableServer/PortableServer.h"
#include "tao/ORB.h"
+/**
+ * @class DSI_Simple_Server
+ *
+ * @brief DSI Simpler Server implementation
+ *
+ * Implements the DSI/DII gateway.
+ */
class DSI_Simple_Server : public TAO_DynamicImplementation
{
- // = TITLE
- // DSI Simpler Server implementation
- //
- // = DESCRIPTION
- // Implements the DSI/DII gateway.
- //
public:
+ /// ctor
DSI_Simple_Server (CORBA::ORB_ptr orb,
CORBA::Object_ptr target,
PortableServer::POA_ptr poa);
- // ctor
// = The DynamicImplementation methods.
virtual void invoke (CORBA::ServerRequest_ptr request);
@@ -47,14 +45,14 @@ public:
);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Target object, forward requests to it...
CORBA::Object_var target_;
- // Target object, forward requests to it...
+ /// The POA
PortableServer::POA_var poa_;
- // The POA
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/DSI_Gateway/test_i.h b/TAO/tests/DSI_Gateway/test_i.h
index 89e1c70d9f6..0810aac6c63 100644
--- a/TAO/tests/DSI_Gateway/test_i.h
+++ b/TAO/tests/DSI_Gateway/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/DSI_Gateway
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_DSI_GATEWAY_TEST_I_H
#define TAO_DSI_GATEWAY_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.
CORBA::Long test_method (CORBA::Long x,
diff --git a/TAO/tests/Explicit_Event_Loop/client.cpp b/TAO/tests/Explicit_Event_Loop/client.cpp
index 79309f3e6ad..ccf9be6b357 100644
--- a/TAO/tests/Explicit_Event_Loop/client.cpp
+++ b/TAO/tests/Explicit_Event_Loop/client.cpp
@@ -1,23 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Explicit_Event_Loop
-//
-// = 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"
diff --git a/TAO/tests/Explicit_Event_Loop/server.cpp b/TAO/tests/Explicit_Event_Loop/server.cpp
index 8d86f0c3e3c..8da642317de 100644
--- a/TAO/tests/Explicit_Event_Loop/server.cpp
+++ b/TAO/tests/Explicit_Event_Loop/server.cpp
@@ -1,23 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Explicit_Event_Loop
-//
-// = 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 "tao/debug.h"
diff --git a/TAO/tests/Explicit_Event_Loop/server.h b/TAO/tests/Explicit_Event_Loop/server.h
index 63a80d2c89f..207cc33c69d 100644
--- a/TAO/tests/Explicit_Event_Loop/server.h
+++ b/TAO/tests/Explicit_Event_Loop/server.h
@@ -1,22 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Explicit_Event_Loop
-//
-// = 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/tests/Exposed_Policies/Counter_i.h b/TAO/tests/Exposed_Policies/Counter_i.h
index 8703a2d95a9..18e32d1c90b 100644
--- a/TAO/tests/Exposed_Policies/Counter_i.h
+++ b/TAO/tests/Exposed_Policies/Counter_i.h
@@ -1,20 +1,17 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Exposed_Policies
-//
-// = FILENAME
-// Counter_i.h
-//
-// = DESCRIPTION
-// This class implements the Counter IDL interface.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Counter_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Counter IDL interface.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef COUNTER_I_H_
#define COUNTER_I_H_
diff --git a/TAO/tests/Exposed_Policies/Policy_Tester.h b/TAO/tests/Exposed_Policies/Policy_Tester.h
index 1a659c8c01c..6d59d7809ba 100644
--- a/TAO/tests/Exposed_Policies/Policy_Tester.h
+++ b/TAO/tests/Exposed_Policies/Policy_Tester.h
@@ -1,21 +1,17 @@
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Exposed_Policies
-//
-// = FILENAME
-// Policy_Verifier.h
-//
-// = DESCRIPTION
-// This class verifies that the policy are correctly embedded
-// in the IOR.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Policy_Verifier.h
+ *
+ * $Id$
+ *
+ * This class verifies that the policy are correctly embedded
+ * in the IOR.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef POLICY_TESTER_H_
#define POLICY_TESTER_H_
@@ -35,8 +31,8 @@ public:
Policy_Tester (void);
~Policy_Tester (void);
+ /// Runs the test.
void run (void);
- // Runs the test.
int init (int argc,
ACE_TCHAR *argv[]);
diff --git a/TAO/tests/Exposed_Policies/Policy_Verifier.h b/TAO/tests/Exposed_Policies/Policy_Verifier.h
index 52d06f1cdcb..ba7a03d7180 100644
--- a/TAO/tests/Exposed_Policies/Policy_Verifier.h
+++ b/TAO/tests/Exposed_Policies/Policy_Verifier.h
@@ -1,21 +1,17 @@
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Exposed_Policies
-//
-// = FILENAME
-// Policy_Verifier.h
-//
-// = DESCRIPTION
-// This class verifies that the policy are correctly embedded
-// in the IOR.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Policy_Verifier.h
+ *
+ * $Id$
+ *
+ * This class verifies that the policy are correctly embedded
+ * in the IOR.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef POLICY_VERIFIER_H_
#define POLICY_VERIFIER_H_
diff --git a/TAO/tests/Exposed_Policies/RT_Properties.h b/TAO/tests/Exposed_Policies/RT_Properties.h
index 5184952e4cd..e37728ae291 100644
--- a/TAO/tests/Exposed_Policies/RT_Properties.h
+++ b/TAO/tests/Exposed_Policies/RT_Properties.h
@@ -1,21 +1,17 @@
-//$Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// RT_Properties.h
-//
-// = DESCRIPTION
-// Defines a series of "real time" property that an Object
-// or a POA created on a RT-ORB can have.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file RT_Properties.h
+ *
+ * $Id$
+ *
+ * Defines a series of "real time" property that an Object
+ * or a POA created on a RT-ORB can have.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef RT_PROPERTIES_H_
#define RT_PROPERTIES_H_
diff --git a/TAO/tests/FL_Cube/test_i.h b/TAO/tests/FL_Cube/test_i.h
index df7b3e46e23..0e44cef3353 100644
--- a/TAO/tests/FL_Cube/test_i.h
+++ b/TAO/tests/FL_Cube/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/FL_Server
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_FL_SERVER_TEST_I_H
#define TAO_FL_SERVER_TEST_I_H
@@ -24,42 +21,43 @@
class Simple_Window : public Fl_Gl_Window
{
public:
+ /// Constructor
Simple_Window (int x, int y, int w, int h,
const char * l = 0);
- // Constructor
void set_x_angle (CORBA::Long x);
void set_y_angle (CORBA::Long y);
private:
+ /// from the Fl_Gl_Window...
virtual void draw (void);
- // from the Fl_Gl_Window...
virtual void draw_cube (void);
+ /// The angles...
CORBA::Long x_angle_;
CORBA::Long y_angle_;
- // The angles...
+ /// The vertices of the cube
float boxv0[3]; float boxv1[3];
float boxv2[3]; float boxv3[3];
float boxv4[3]; float boxv5[3];
float boxv6[3]; float boxv7[3];
- // The vertices of the cube
};
+/**
+ * @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,
Simple_Window* window);
- // ctor
// = The Simple_Server methods.
void set_x_angle (CORBA::Long x);
@@ -67,11 +65,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Display the graphics...
Simple_Window* window_;
- // Display the graphics...
};
#endif /* TAO_FL_SERVER_TEST_I_H */
diff --git a/TAO/tests/Faults/ping_i.h b/TAO/tests/Faults/ping_i.h
index 79ec976b05c..6031f7e400f 100644
--- a/TAO/tests/Faults/ping_i.h
+++ b/TAO/tests/Faults/ping_i.h
@@ -1,37 +1,35 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Faults
-//
-// = FILENAME
-// ping_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ping_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_PING_I_H
#define TAO_PING_I_H
#include "pingS.h"
+/**
+ * @class PingObject_i
+ *
+ * @brief A simple implementation of the <ping> interface
+ *
+ * Used to verify that the client can tolerate server crashes with
+ * oneway invocations and that there are no problems with
+ * persistent object references after the crash.
+ */
class PingObject_i : public POA_PingObject
{
- // = TITLE
- // A simple implementation of the <ping> interface
- //
- // = DESCRIPTION
- // Used to verify that the client can tolerate server crashes with
- // oneway invocations and that there are no problems with
- // persistent object references after the crash.
- //
public:
+ /// ctor
PingObject_i (CORBA::ORB_ptr orb,
PortableServer::POA_ptr the_poa);
- // ctor
// = The PingObject interface methods
void ping (PingObject_ptr callback);
@@ -41,11 +39,11 @@ public:
PortableServer::POA_ptr _default_POA (void);
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
+ /// The poa
PortableServer::POA_var poa_;
- // The poa
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/Faults/test_i.h b/TAO/tests/Faults/test_i.h
index 33cb36484d3..68d5f80cd05 100644
--- a/TAO/tests/Faults/test_i.h
+++ b/TAO/tests/Faults/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_FAILURE_TEST_I_H
#define TAO_FAILURE_TEST_I_H
@@ -29,28 +26,29 @@ class Callback_i
// receives a callback object.
//
public:
+ /// ctor
Callback_i (CORBA::ORB_ptr orb);
- // ctor
+ /// The callback method
void shutdown (CORBA::Boolean is_clean);
- // The callback method
private:
+ /// The orb
CORBA::ORB_var orb_;
- // The orb
};
+/**
+ * @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.
CORBA::Long test_method (CORBA::Boolean do_callback,
@@ -62,22 +60,23 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
+/**
+ * @class Middle_i
+ *
+ * @brief Another implementation of the simple server...
+ *
+ * Implements the Simple_Server interface in test.idl
+ */
class Middle_i : public virtual POA_Simple_Server
{
- // = TITLE
- // Another implementation of the simple server...
- //
- // = DESCRIPTION
- // Implements the Simple_Server interface in test.idl
- //
public:
+ /// ctor
Middle_i (CORBA::ORB_ptr orb,
Simple_Server_ptr server);
- // ctor
// = The Simple_Server methods.
CORBA::Long test_method (CORBA::Boolean do_callback,
@@ -89,11 +88,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// The real server
Simple_Server_var server_;
- // The real server
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/File_IO/File_i.cpp b/TAO/tests/File_IO/File_i.cpp
index 23327d98042..1776c7394c0 100644
--- a/TAO/tests/File_IO/File_i.cpp
+++ b/TAO/tests/File_IO/File_i.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-//===================================================================
-//
-// = FILENAME
-// File_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the File IDL module and the interfaces
-// Descriptor and System in it.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file File_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the File IDL module and the interfaces
+ * Descriptor and System in it.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "File_i.h"
#include "ace/OS_NS_stdio.h"
diff --git a/TAO/tests/File_IO/File_i.h b/TAO/tests/File_IO/File_i.h
index 3b4858c1c18..37d90074392 100644
--- a/TAO/tests/File_IO/File_i.h
+++ b/TAO/tests/File_IO/File_i.h
@@ -1,87 +1,96 @@
-// $Id$
-
-//===================================================================
-//
-// = FILENAME
-// File_i.h
-//
-// = DESCRIPTION
-// Defines the implementation classes for the File IDL
-// module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file File_i.h
+ *
+ * $Id$
+ *
+ * Defines the implementation classes for the File IDL
+ * module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "FileS.h"
+/**
+ * @class FileImpl
+ *
+ * @brief FileImpl class provides the namespace for the File IDL module .
+ */
class FileImpl
{
- // = TITLE
- // FileImpl class provides the namespace for the File IDL module .
public:
+ /**
+ * @class Descriptor
+ *
+ * @brief Descriptor implements the Descriptor interface in the File
+ * Module A single Descriptor servant can serve multiple object
+ * references
+ */
class Descriptor : public POA_File::Descriptor
{
- // = TITLE
- // Descriptor implements the Descriptor interface in the File
- // Module A single Descriptor servant can serve multiple object
- // references
public:
+ /// Constructor
Descriptor (PortableServer::POA_ptr poa);
- // Constructor
+ /// Destructor
~Descriptor (void);
- // Destructor
+ /// Returns the default POA of this object
PortableServer::POA_ptr _default_POA (void);
- // Returns the default POA of this object
+ /// write buffer to File corresponding to this Descriptor
virtual CORBA::Long write (const File::Descriptor::DataBuffer &buffer);
- // write buffer to File corresponding to this Descriptor
virtual File::Descriptor::DataBuffer *read (CORBA::Long num_bytes);
+ /// seek to the offset in file from whence
virtual CORBA::ULong lseek (CORBA::ULong offset,
CORBA::Long whence);
- // seek to the offset in file from whence
+ /// closes the file corresponding to the requested ObjectID
virtual void destroy (void);
- // closes the file corresponding to the requested ObjectID
private:
+ /// Extracts the ACE_HANDLE from the objectID
ACE_HANDLE fd (void);
- // Extracts the ACE_HANDLE from the objectID
PortableServer::POA_var poa_;
};
+ /**
+ * @class System
+ *
+ * @brief File System implementation class.
+ */
class System : public POA_File::System
{
- // = TITLE
- // File System implementation class.
public:
+ /// Constructor, Creates a single File Descriptor Servant and
+ /// registers it with the POA as the Default Servant
System (PortableServer::POA_ptr poa);
- // Constructor, Creates a single File Descriptor Servant and
- // registers it with the POA as the Default Servant
+ ///Destructor
~System (void);
- //Destructor
+ ///Returns the default POA of this object
PortableServer::POA_ptr _default_POA (void);
- //Returns the default POA of this object
+ /// Opens a file ,creates a Descriptor reference with the
+ /// ACE_HANDLE and returns that reference
File::Descriptor_ptr open (const char *file_name,
CORBA::Long flags);
- // Opens a file ,creates a Descriptor reference with the
- // ACE_HANDLE and returns that reference
private:
PortableServer::POA_var poa_;
+ /// The single File Descriptor servant which serves requests for
+ /// any Descriptor object under poa_.
Descriptor fd_servant_;
- // The single File Descriptor servant which serves requests for
- // any Descriptor object under poa_.
};
};
diff --git a/TAO/tests/File_IO/client.cpp b/TAO/tests/File_IO/client.cpp
index 84685c5e27f..fa43de2625b 100644
--- a/TAO/tests/File_IO/client.cpp
+++ b/TAO/tests/File_IO/client.cpp
@@ -1,19 +1,17 @@
-// $Id$
-
-//===================================================================
-// = LIBRARY
-// TAO/tests/POA/Default_Servant/client
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A client program for the File IDL module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A client program for the File IDL module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "FileC.h"
#include "tao/debug.h"
diff --git a/TAO/tests/ForwardOnceUponException/test_i.h b/TAO/tests/ForwardOnceUponException/test_i.h
index ce17954e580..169a6a7823f 100755
--- a/TAO/tests/ForwardOnceUponException/test_i.h
+++ b/TAO/tests/ForwardOnceUponException/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Forwarding
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_FORWARDING_TEST_I_H
#define TAO_FORWARDING_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.
CORBA::Boolean test_is_a (const char * type);
@@ -38,8 +36,8 @@ public:
int ncalls () const;
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
int ncalls_;
int raise_exception_;
diff --git a/TAO/tests/ForwardUponObjectNotExist/test_i.h b/TAO/tests/ForwardUponObjectNotExist/test_i.h
index 60670e13d54..abf27c63925 100755
--- a/TAO/tests/ForwardUponObjectNotExist/test_i.h
+++ b/TAO/tests/ForwardUponObjectNotExist/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Forwarding
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_FORWARDING_TEST_I_H
#define TAO_FORWARDING_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.
CORBA::Boolean test_is_a (const char * type);
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/Forwarding/test_i.h b/TAO/tests/Forwarding/test_i.h
index 60670e13d54..abf27c63925 100644
--- a/TAO/tests/Forwarding/test_i.h
+++ b/TAO/tests/Forwarding/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Forwarding
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_FORWARDING_TEST_I_H
#define TAO_FORWARDING_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.
CORBA::Boolean test_is_a (const char * type);
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/IDL_Test/main.cpp b/TAO/tests/IDL_Test/main.cpp
index 965dc0981f1..01508dd0dd1 100644
--- a/TAO/tests/IDL_Test/main.cpp
+++ b/TAO/tests/IDL_Test/main.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/IDL_Test
-//
-// = FILENAME
-// main.cpp
-//
-// = DESCRIPTION
-// We test the pragma prefixes generated in pragma.idl, and
-// the values of some generated constants in constants.idl.
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file main.cpp
+ *
+ * $Id$
+ *
+ * We test the pragma prefixes generated in pragma.idl, and
+ * the values of some generated constants in constants.idl.
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "pragmaS.h"
#include "unionC.h"
diff --git a/TAO/tests/InterOp-Naming/INS_i.h b/TAO/tests/InterOp-Naming/INS_i.h
index 6f24fbc2094..5888b059637 100644
--- a/TAO/tests/InterOp-Naming/INS_i.h
+++ b/TAO/tests/InterOp-Naming/INS_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/InterOp-Naming
-//
-// = FILENAME
-// INS_i.h
-//
-// = DESCRIPTION
-// This class implements the INS interface.
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file INS_i.h
+ *
+ * $Id$
+ *
+ * This class implements the INS interface.
+ *
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef INS_I_H
#define INS_I_H
@@ -27,21 +24,21 @@ class INS_i : public POA_INS
public:
// = Initialization and termination methods.
+ /// Constructor.
INS_i (void);
- // Constructor.
+ /// Destructor.
~INS_i (void);
- // Destructor.
+ /// test the INS.
char * test_ins (void);
- // test the INS.
+ /// Set the ORB pointer.
void orb (CORBA::ORB_ptr o);
- // Set the ORB pointer.
private:
+ /// ORB pointer.
CORBA::ORB_var orb_;
- // ORB pointer.
};
diff --git a/TAO/tests/InterOp-Naming/Server_i.h b/TAO/tests/InterOp-Naming/Server_i.h
index e833b024a1e..35248fd2acd 100644
--- a/TAO/tests/InterOp-Naming/Server_i.h
+++ b/TAO/tests/InterOp-Naming/Server_i.h
@@ -1,20 +1,17 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/InterOp-Naming
-//
-// = FILENAME
-// Server_i.h
-//
-// = DESCRIPTION
-// The class is the driver for the INS test server.
-//
-// = AUTHOR
-// Vishal Kachroo <vishal@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Server_i.h
+ *
+ * $Id$
+ *
+ * The class is the driver for the INS test server.
+ *
+ *
+ * @author Vishal Kachroo <vishal@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVER_I_H
#define SERVER_I_H
@@ -30,45 +27,45 @@ class Server_i
public:
// = Initialization and termination methods.
+ /// Constructor.
Server_i (void);
- // Constructor.
+ /// Destructor.
~Server_i (void);
- // Destructor.
+ /// Initialize the Server state - parsing arguments and waiting.
int init (int argc,
ACE_TCHAR *argv[]);
- // Initialize the Server state - parsing arguments and waiting.
+ /// Add an IOR to the ORB-IOR table.
int add_IOR_to_table (CORBA::String_var ior);
- // Add an IOR to the ORB-IOR table.
+ /// Run the orb.
int run (void);
- // Run the orb.
protected:
+ /// Servant class
INS_i servant_;
- // Servant class
+ /// 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.
+ /// Used test the INS.
char * 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.
};
#endif /* SERVER_I_H */
diff --git a/TAO/tests/Leader_Followers/client.cpp b/TAO/tests/Leader_Followers/client.cpp
index ffe3b5693d1..a69ca775862 100644
--- a/TAO/tests/Leader_Followers/client.cpp
+++ b/TAO/tests/Leader_Followers/client.cpp
@@ -1,17 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// See README.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * See README.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Read_Buffer.h"
diff --git a/TAO/tests/Leader_Followers/test_i.h b/TAO/tests/Leader_Followers/test_i.h
index 74db1115a2b..175291ddca8 100644
--- a/TAO/tests/Leader_Followers/test_i.h
+++ b/TAO/tests/Leader_Followers/test_i.h
@@ -1,28 +1,27 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Leader_Followers/
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
+/**
+ * @class test_i
+ *
+ * @brief Simple test implementation.
+ */
class test_i : public POA_test
{
- // = TITLE
- // Simple test implementation.
- //
public:
+ /// ctor.
test_i (CORBA::ORB_ptr orb);
- // ctor.
// = The test interface methods.
CORBA::ULong method (CORBA::ULong work);
@@ -30,6 +29,6 @@ public:
void shutdown (void);
private:
+ /// The ORB.
CORBA::ORB_var orb_;
- // The ORB.
};
diff --git a/TAO/tests/MProfile/test_i.h b/TAO/tests/MProfile/test_i.h
index 07f971408ac..58cc6ea1bb9 100644
--- a/TAO/tests/MProfile/test_i.h
+++ b/TAO/tests/MProfile/test_i.h
@@ -1,37 +1,35 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Mprofile
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan <coryan@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu>
+ */
+//=============================================================================
+
#ifndef TAO_MPROFILE_TEST_I_H
#define TAO_MPROFILE_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
+ /// ctor
Simple_Server_i (void);
- // ctor
// = The Simple_Server methods.
CORBA::Long remote_call (void);
diff --git a/TAO/tests/MProfile_Connection_Timeout/test_i.h b/TAO/tests/MProfile_Connection_Timeout/test_i.h
index cb4554e8655..bd1c4cbe7e8 100644
--- a/TAO/tests/MProfile_Connection_Timeout/test_i.h
+++ b/TAO/tests/MProfile_Connection_Timeout/test_i.h
@@ -1,37 +1,35 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/MProfile_Connection_Timeout
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@isis-server.isis.vanderbilt.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@isis-server.isis.vanderbilt.edu>
+ */
+//=============================================================================
+
#ifndef TAO_MPROFILE_CONNECTION_TIMEOUT_TEST_I_H
#define TAO_MPROFILE_CONNECTION_TIMEOUT_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
+ /// ctor
Simple_Server_i (void);
- // ctor
// = The Simple_Server methods.
CORBA::ULongLong remote_call (void);
diff --git a/TAO/tests/MProfile_Forwarding/Servant_Locator.cpp b/TAO/tests/MProfile_Forwarding/Servant_Locator.cpp
index f897a8e4e92..5fa43c2d25c 100644
--- a/TAO/tests/MProfile_Forwarding/Servant_Locator.cpp
+++ b/TAO/tests/MProfile_Forwarding/Servant_Locator.cpp
@@ -1,22 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Forwarding/Servant_Locator
-//
-// = FILENAME
-// Servant_Locator.cpp
-//
-// = DESCRIPTION
-// Implementation of MyFooServantLocator class , used with a POA
-// having a NON_RETAIN policy.
-//
-// = AUTHOR
-// Irfan Pyarali
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Locator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of MyFooServantLocator class , used with a POA
+ * having a NON_RETAIN policy.
+ *
+ *
+ * @author Irfan Pyarali Michael Kircher
+ */
+//=============================================================================
+
#include "Servant_Locator.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/tests/MProfile_Forwarding/Servant_Locator.h b/TAO/tests/MProfile_Forwarding/Servant_Locator.h
index 112a61c7432..891d8ea1374 100644
--- a/TAO/tests/MProfile_Forwarding/Servant_Locator.h
+++ b/TAO/tests/MProfile_Forwarding/Servant_Locator.h
@@ -1,21 +1,18 @@
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Forwarding/Servant_Locator
-//
-// = FILENAME
-// Servant_Locator.h
-//
-// = DESCRIPTION
-// Defines a MyFooServantLocator class , used with a POA having
-// a NON_RETAIN policy
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file Servant_Locator.h
+ *
+ * $Id$
+ *
+ * Defines a MyFooServantLocator class , used with a POA having
+ * a NON_RETAIN policy
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#ifndef _SERVANT_LOCATOR_H_
#define _SERVANT_LOCATOR_H_
@@ -24,11 +21,14 @@
#include "tao/PortableServer/ServantLocatorC.h"
#include "tao/ORB.h"
+/**
+ * @class Servant_Locator
+ *
+ * @brief This class is used by a POA with USE_SERVANT_MANAGER and
+ * NON_RETAIN policy.
+ */
class Servant_Locator : public PortableServer::ServantLocator
{
- // = TITLE
- // This class is used by a POA with USE_SERVANT_MANAGER and
- // NON_RETAIN policy.
public:
Servant_Locator (CORBA::ORB_ptr orb_ptr);
@@ -36,29 +36,29 @@ public:
~Servant_Locator ();
+ /// This method is invoked by a POA whenever it receives a request
+ /// for MyFoo object that is not currently active.
virtual PortableServer::Servant preinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie &the_cookie);
- // This method is invoked by a POA whenever it receives a request
- // for MyFoo object that is not currently active.
+ /// This method is invoked whenever a MyFooServant completes a
+ /// request.
virtual void postinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie the_cookie,
PortableServer::Servant the_servant);
- // This method is invoked whenever a MyFooServant completes a
- // request.
+ /// To be removed..
void set (CORBA::Object_var obj);
- // To be removed..
private:
CORBA::ORB_var orb_var_;
+ /// To be removed
CORBA::Object_var objref_;
- // To be removed
};
#endif /* _SERVANT_LOCATOR_H */
diff --git a/TAO/tests/MProfile_Forwarding/test_i.h b/TAO/tests/MProfile_Forwarding/test_i.h
index 69525a827ec..ba29a0b6941 100644
--- a/TAO/tests/MProfile_Forwarding/test_i.h
+++ b/TAO/tests/MProfile_Forwarding/test_i.h
@@ -1,37 +1,36 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan
+ */
+//=============================================================================
+
#ifndef MPROFILE_FORWARDING_TEST_I_H
#define MPROFILE_FORWARDING_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:
Simple_Server_i (CORBA::ORB_ptr orb);
// ctor
+ /// ctor
Simple_Server_i (void);
- // ctor
// = The Simple_Server methods.
void remote_call (void);
diff --git a/TAO/tests/MT_Client/test_i.h b/TAO/tests/MT_Client/test_i.h
index e38a1d70ad0..a752d15c3ea 100644
--- a/TAO/tests/MT_Client/test_i.h
+++ b/TAO/tests/MT_Client/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 test_method (void);
diff --git a/TAO/tests/MT_Server/test_i.h b/TAO/tests/MT_Server/test_i.h
index d1113ac50d7..aa98bce6909 100644
--- a/TAO/tests/MT_Server/test_i.h
+++ b/TAO/tests/MT_Server/test_i.h
@@ -1,34 +1,32 @@
-// $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
#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.
CORBA::Long test_method (CORBA::Long x);
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/Multiple/Collocation_Tester.h b/TAO/tests/Multiple/Collocation_Tester.h
index e220b07b466..64c3a0c0dad 100644
--- a/TAO/tests/Multiple/Collocation_Tester.h
+++ b/TAO/tests/Multiple/Collocation_Tester.h
@@ -1,21 +1,17 @@
-//$Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Multiple
-//
-// = FILENAME
-// Collocation_Tester.h
-//
-// = DESCRIPTION
-// This file contains the class that tests the TAO's collocation
-// mechanism.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Collocation_Tester.h
+ *
+ * $Id$
+ *
+ * This file contains the class that tests the TAO's collocation
+ * mechanism.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
// -- Custom App. Include --
#include "MultipleC.h"
@@ -41,38 +37,40 @@ public:
~Collocation_Tester ();
// -- Command --
+ /// Runs the test.
void run (void);
- // Runs the test.
private:
// -- Helper Methods --
+ /// Tests the method accessible thru the
+ /// Top interface.
int test_top (void);
- // Tests the method accessible thru the
- // Top interface.
+ /// Tests the method accessible thru the
+ /// Right interface.
int test_right (void);
- // Tests the method accessible thru the
- // Right interface.
+ /// Tests the method accessible thru the
+ /// Left interface.
int test_left (void);
- // Tests the method accessible thru the
- // Left interface.
+ /// Tests the method accessible thru the
+ /// Bottom interface.
int test_bottom (void);
- // Tests the method accessible thru the
- // Bottom interface.
+ /**
+ * This method tests wether the answer obtained
+ * is the one expected. As strcmp, it returns zero
+ * if a match occurs and a non-zero value if there
+ * is no match (actually 1 is returned if there is
+ * no match.
+ */
int match_answer (const char *actual_answer,
const char *right_answer,
const char *method_name);
- // This method tests wether the answer obtained
- // is the one expected. As strcmp, it returns zero
- // if a match occurs and a non-zero value if there
- // is no match (actually 1 is returned if there is
- // no match.
void shutdown (void);
private:
diff --git a/TAO/tests/Multiple/Multiple_Impl.h b/TAO/tests/Multiple/Multiple_Impl.h
index 97b507ea1b2..e53381aef39 100644
--- a/TAO/tests/Multiple/Multiple_Impl.h
+++ b/TAO/tests/Multiple/Multiple_Impl.h
@@ -1,21 +1,17 @@
-//$Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Multiple
-//
-// = FILENAME
-// Multiple_Impl.h
-//
-// = DESCRIPTION
-// This file contains the servant implementation used to test the
-// new collocation collocation scheme.
-//
-// = AUTHOR
-// Angelo Corsaro <corsaro@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Multiple_Impl.h
+ *
+ * $Id$
+ *
+ * This file contains the servant implementation used to test the
+ * new collocation collocation scheme.
+ *
+ *
+ * @author Angelo Corsaro <corsaro@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_MULTIPLE_IMPL_H_
@@ -24,14 +20,16 @@
// -- App. Specific Include --
#include "MultipleS.h"
+/**
+ * @class Bottom_Impl
+ *
+ * @brief Bottom_Impl
+ *
+ * This class implements the servant for the Bottom interface
+ * defined in the IDL file.
+ */
class Bottom_Impl : public virtual POA_Multiple::Bottom
{
-// = TITLE
-// Bottom_Impl
-//
-// = DESCRIPTION
-// This class implements the servant for the Bottom interface
-// defined in the IDL file.
public:
@@ -56,16 +54,18 @@ private:
+/**
+ * @class Delegated_Bottom_Impl
+ *
+ * @brief Delegated_Bottom_Impl
+ *
+ * This class implements the servant for the Bottom interface
+ * which delegates all the request to another Bottom corba object.
+ * This call forwarding is made using different strategy depending
+ * on the option set for the ORB.
+ */
class Delegated_Bottom_Impl : public virtual POA_Multiple::Bottom
{
-// = TITLE
-// Delegated_Bottom_Impl
-//
-// = DESCRIPTION
-// This class implements the servant for the Bottom interface
-// which delegates all the request to another Bottom corba object.
-// This call forwarding is made using different strategy depending
-// on the option set for the ORB.
public:
diff --git a/TAO/tests/Multiple_Inheritance/client.cpp b/TAO/tests/Multiple_Inheritance/client.cpp
index 7132b072be9..b49b16472c0 100644
--- a/TAO/tests/Multiple_Inheritance/client.cpp
+++ b/TAO/tests/Multiple_Inheritance/client.cpp
@@ -1,19 +1,16 @@
-// $Id$
-//
-//===================================================================
-// = LIBRARY
-// TAO/tests/Multiple_Inheritance
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A client program for the Multiple Inheritance module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A client program for the Multiple Inheritance module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Read_Buffer.h"
diff --git a/TAO/tests/Muxed_GIOP_Versions/test_i.h b/TAO/tests/Muxed_GIOP_Versions/test_i.h
index d1113ac50d7..aa98bce6909 100644
--- a/TAO/tests/Muxed_GIOP_Versions/test_i.h
+++ b/TAO/tests/Muxed_GIOP_Versions/test_i.h
@@ -1,34 +1,32 @@
-// $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
#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.
CORBA::Long test_method (CORBA::Long x);
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/Native_Exceptions/test_i.h b/TAO/tests/Native_Exceptions/test_i.h
index 5bbb20d51b1..7d91d2db577 100644
--- a/TAO/tests/Native_Exceptions/test_i.h
+++ b/TAO/tests/Native_Exceptions/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Native_Exceptions
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_NATIVE_EXCEPTIONS_TEST_I_H
#define TAO_NATIVE_EXCEPTIONS_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.
CORBA::Long test_method (CORBA::Long x);
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp b/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp
index 3d33a2a5a1b..6bf0f6555b2 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// MT_Object_i.cpp
-//
-// = DESCRIPTION
-// This class implements the Object A of the
-// Nested Upcalls - MT Client test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file MT_Object_i.cpp
+ *
+ * $Id$
+ *
+ * This class implements the Object A of the
+ * Nested Upcalls - MT Client test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "MT_Object_i.h"
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.h b/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.h
index bfddb076334..608fe0ba278 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.h
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/MT_Object_i.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client test
-//
-// = FILENAME
-// MT_Object_A_i.h
-//
-// = DESCRIPTION
-// This class implements the Object A of the
-// Nested Upcalls - MT Client test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file MT_Object_A_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Object A of the
+ * Nested Upcalls - MT Client test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef MT_OBJECT_IMPL_H
# define MT_OBJECT_IMPL_H
@@ -24,16 +20,19 @@
#include "MT_Client_TestS.h"
#include "MT_Client_TestC.h"
+/**
+ * @class MT_Object_i
+ *
+ * @brief Implement the <MT_Object> IDL interface.
+ */
class MT_Object_i : public POA_MT_Object
{
- // = TITLE
- // Implement the <MT_Object> IDL interface.
public:
+ /// Constructor.
MT_Object_i (void);
- // Constructor.
+ /// Destructor.
virtual ~MT_Object_i (void);
- // Destructor.
virtual CORBA::Long yadda (CORBA::Long hop_count,
MT_Object_ptr partner);
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/client.cpp b/TAO/tests/NestedUpcall/MT_Client_Test/client.cpp
index 5318bcb69c6..b1d3f5db780 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/client.cpp
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/client.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// Start one server thread calling a distant MT Object serveral times,
-// also starting serveral client threads which call the MT Object too.
-// The server does nested upcalls.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * Start one server thread calling a distant MT Object serveral times,
+ * also starting serveral client threads which call the MT Object too.
+ * The server does nested upcalls.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "client.h"
#include "local_server.h"
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/client.h b/TAO/tests/NestedUpcall/MT_Client_Test/client.h
index 6d25e8c355e..f9334ac5bdb 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/client.h
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/client.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// Test for multithreaded client using one global ORB (and Reactor)
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * Test for multithreaded client using one global ORB (and Reactor)
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef MT_CLIENT_H
#define MT_CLIENT_H
@@ -31,68 +27,72 @@
#include "tao/ORB.h"
#include "MT_Client_TestC.h"
+/**
+ * @class MT_Client
+ *
+ * @brief A simple client talking to one server
+ *
+ * It is connecting to a server which holds the Object_A
+ * or using the "-m" switch to a server holding the MT_Object
+ */
class MT_Client
{
- // = TITLE
- // A simple client talking to one server
- //
- // = DESCRIPTION
- // It is connecting to a server which holds the Object_A
- // or using the "-m" switch to a server holding the MT_Object
public:
+ /// = Constructor and destructor.
MT_Client (void);
~MT_Client (void);
- // = Constructor and destructor.
+ /// 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,
int client_number);
- // Initialize the client communication endpoint with server.
private:
+ /// reading the IOR of object A in
int read_ior (ACE_TCHAR *filename);
- // reading the IOR of object A in
+ /// 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 the object
char *object_key_;
- // Key of the object
+ /// Flag to tell server to shutdown.
int shutdown_;
- // Flag to tell server to shutdown.
+ /// Remember our orb.
CORBA::ORB_var orb_var_;
- // Remember our orb.
+ /// pointer to the mt Object
MT_Object_var mT_Object_var_;
- // pointer to the mt Object
+ /// This is used to choose the server...
int client_number_;
- // This is used to choose the server...
+ /// number of loops
unsigned long iterations_;
- // number of loops
};
+/**
+ * @class MT_Client_Task
+ *
+ * @brief Wrapper for the MT_Client to be an extra thread
+ *
+ * No big purpose, just wrapping
+ */
class MT_Client_Task : public ACE_Task<ACE_SYNCH>
{
- // = TITLE
- // Wrapper for the MT_Client to be an extra thread
- //
- // = DESCRIPTION
- // No big purpose, just wrapping
public:
MT_Client_Task (int argc, ACE_TCHAR **argv, int client_number);
@@ -103,8 +103,8 @@ private:
int argc_;
ACE_TCHAR **argv_;
+ /// To determine if we use the first or the second server.
int client_number_;
- // To determine if we use the first or the second server.
};
#endif /* MT_CLIENT_H */
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/local_server.cpp b/TAO/tests/NestedUpcall/MT_Client_Test/local_server.cpp
index 73b716d5219..94aeb20f8ca 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/local_server.cpp
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/local_server.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// local_server.cpp
-//
-// = DESCRIPTION
-// This server will run the ORB briefly and then make
-// several calls on the distant MT Object.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file local_server.cpp
+ *
+ * $Id$
+ *
+ * This server will run the ORB briefly and then make
+ * several calls on the distant MT Object.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "local_server.h"
#include "tao/debug.h"
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/local_server.h b/TAO/tests/NestedUpcall/MT_Client_Test/local_server.h
index b486c2f443e..82b6e9a4061 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/local_server.h
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/local_server.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// local_server.h
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - MT Client test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file local_server.h
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - MT Client test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef MT_CLIENT_TEST_MT_SERVER_H
#define MT_CLIENT_TEST_MT_SERVER_H
@@ -35,76 +31,80 @@ TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_ORB_Manager;
TAO_END_VERSIONED_NAMESPACE_DECL
+/**
+ * @class MT_Server
+ *
+ * @brief This is the server for the mt_object
+ *
+ * See the README file for more information.
+ */
class MT_Server
{
- // = TITLE
- // This is the server for the mt_object
- //
- // = DESCRIPTION
- // See the README file for more information.
public:
+ /// Default constructor
MT_Server ();
- // Default constructor
+ /// Destructor
~MT_Server (void);
- // Destructor
+ /// Initialize the MT_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv,
TAO_ORB_Manager* orb_manager_ptr);
- // Initialize the MT_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
+ /// Just run it briefly
int run_ORB_briefly (void);
- // Just run it briefly
private:
+ /// reading the IOR of mt object in
int read_ior (ACE_TCHAR *filename);
- // reading the IOR of mt object in
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// Key of the object
char *object_key_;
- // Key of the object
+ /// File to output the IOR of the object A.
FILE* ior_output_file_;
- // File to output the IOR of the object A.
+ /// The ORB manager
TAO_ORB_Manager* orb_manager_ptr_;
- // The ORB manager
+ /// Implementation object
MT_Object_i mT_Object_i_;
- // Implementation object
+ /// reference for the distant MT Object
MT_Object_var mT_Object_var_;
- // reference for the distant MT Object
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// number of times the server should call to the disted MT OBject
unsigned int iterations_;
- // number of times the server should call to the disted MT OBject
+ /// IOR of our servant.
CORBA::String_var str_;
- // IOR of our servant.
};
+/**
+ * @class MT_Server_Task
+ *
+ * @brief Wrapper for the MT_Server to be an extra thread
+ *
+ * No big purpose, just wrapping
+ */
class MT_Server_Task : public ACE_Task<ACE_SYNCH>
{
- // = TITLE
- // Wrapper for the MT_Server to be an extra thread
- //
- // = DESCRIPTION
- // No big purpose, just wrapping
public:
MT_Server_Task (ACE_Thread_Manager* thr_mgr_ptr,
int argc,
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/server.cpp b/TAO/tests/NestedUpcall/MT_Client_Test/server.cpp
index b01e3dbdb8e..5c9ae335c6f 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/server.cpp
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/server.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - MT_Client test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - MT_Client test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "server.h"
#include "tao/debug.h"
diff --git a/TAO/tests/NestedUpcall/MT_Client_Test/server.h b/TAO/tests/NestedUpcall/MT_Client_Test/server.h
index 8d0e237514e..881d221ae8d 100644
--- a/TAO/tests/NestedUpcall/MT_Client_Test/server.h
+++ b/TAO/tests/NestedUpcall/MT_Client_Test/server.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/MT_Client_Test
-//
-// = FILENAME
-// server_A.h
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - MT Client test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server_A.h
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - MT Client test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef MT_CLIENT_TEST_MT_OBJECT_SERVER_H
#define MT_CLIENT_TEST_MT_OBJECT_SERVER_H
@@ -31,47 +27,49 @@
#include "tao/Utils/ORB_Manager.h"
#include "MT_Object_i.h"
+/**
+ * @class MT_Object_Server
+ *
+ * @brief This is the server for the object A in the test.
+ *
+ * See the README file for more information.
+ */
class MT_Object_Server
{
- // = TITLE
- // This is the server for the object A in the test.
- //
- // = DESCRIPTION
- // See the README file for more information.
public:
+ /// Default constructor
MT_Object_Server (void);
- // Default constructor
+ /// Destructor
~MT_Object_Server (void);
- // Destructor
+ /// Initialize the NestedUpCalls_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the NestedUpCalls_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// File to output the IOR of the object A.
FILE* ior_output_file_;
- // File to output the IOR of the object A.
+ /// The ORB manager
TAO_ORB_Manager orb_manager_;
- // The ORB manager
+ /// Implementation object MT_OBject
MT_Object_i mT_Object_i_;
- // Implementation object MT_OBject
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
u_char use_mt_object_;
};
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.cpp b/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.cpp
index 9d278338a50..6eaf18c8bd0 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Object_A_i.cpp
-//
-// = DESCRIPTION
-// This class implements the Object A of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Object_A_i.cpp
+ *
+ * $Id$
+ *
+ * This class implements the Object A of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "tao/Exception.h"
#include "Initiator_i.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.h b/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.h
index 2d9e9fa1cac..2d4ba8b9c37 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Initiator_i.h
@@ -1,48 +1,47 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Initiator_i.h
-//
-// = DESCRIPTION
-// This class implements the Initiator of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Initiator_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Initiator of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef INITIATOR_IMPL_H
# define INITIATOR_IMPL_H
#include "Triangle_TestS.h"
+/**
+ * @class Initiator_i
+ *
+ * @brief Implement the <Initiator> IDL interface.
+ */
class Initiator_i : public POA_Initiator
{
- // = TITLE
- // Implement the <Initiator> IDL interface.
public:
+ /// Constructor.
Initiator_i (Object_A_ptr object_A_ptr,
Object_B_ptr object_B_ptr);
- // Constructor.
+ /// Destructor.
virtual ~Initiator_i (void);
- // Destructor.
virtual void foo_object_B (void);
private:
+ /// reference to object A
Object_A_var object_A_var_;
- // reference to object A
+ /// reference to object B
Object_B_var object_B_var_;
- // reference to object B
};
#endif /* INITIATOR_IMPL_H */
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.cpp b/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.cpp
index 98e7790d2ee..0946f3c3ce7 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Object_A_i.cpp
-//
-// = DESCRIPTION
-// This class implements the Object A of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Object_A_i.cpp
+ *
+ * $Id$
+ *
+ * This class implements the Object A of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "Object_A_i.h"
#include "tao/ORB_Core.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.h b/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.h
index 6373eb3e5ff..71e604800f7 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Object_A_i.h
@@ -1,38 +1,37 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Object_A_i.h
-//
-// = DESCRIPTION
-// This class implements the Object A of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Object_A_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Object A of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef OBJECT_B_IMPL_H
# define OBJECT_B_IMPL_H
#include "Triangle_TestS.h"
+/**
+ * @class Object_A_i
+ *
+ * @brief Implement the <Object_A> IDL interface.
+ */
class Object_A_i : public POA_Object_A
{
- // = TITLE
- // Implement the <Object_A> IDL interface.
public:
+ /// Constructor.
Object_A_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Object_A_i (void);
- // Destructor.
virtual void foo (Initiator_ptr theInitiator_ptr);
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.cpp b/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.cpp
index 6005f4947fb..70cc0810439 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Object_B_i.cpp
-//
-// = DESCRIPTION
-// This class implements the Object B of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Object_B_i.cpp
+ *
+ * $Id$
+ *
+ * This class implements the Object B of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "tao/Exception.h"
#include "Object_B_i.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.h b/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.h
index ff31c25e3c3..1fd5f66bb5e 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/Object_B_i.h
@@ -1,38 +1,37 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// Object_B_i.h
-//
-// = DESCRIPTION
-// This class implements the Object B of the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Object_B_i.h
+ *
+ * $Id$
+ *
+ * This class implements the Object B of the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef OBJECT_B_IMPL_H
# define OBJECT_B_IMPL_H
#include "Triangle_TestS.h"
+/**
+ * @class Object_B_i
+ *
+ * @brief Implement the <Object_B> IDL interface.
+ */
class Object_B_i : public POA_Object_B
{
- // = TITLE
- // Implement the <Object_B> IDL interface.
public:
+ /// Constructor.
Object_B_i (void);
- // Constructor.
+ /// Destructor.
virtual ~Object_B_i (void);
- // Destructor.
virtual void foo(Object_A_ptr theObject_A_ptr);
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/initiator.cpp b/TAO/tests/NestedUpcall/Triangle_Test/initiator.cpp
index 6f1a67dde02..3b7500c822c 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/initiator.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/initiator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// initiator.cpp
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file initiator.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "initiator.h"
#include "tao/debug.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/initiator.h b/TAO/tests/NestedUpcall/Triangle_Test/initiator.h
index 36be7ab5da6..d1c4c5f6848 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/initiator.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/initiator.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// initiator.h
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file initiator.h
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef _TRIANGLE_TEST_INITITATOR_SERVER_H
#define _TRIANGLE_TEST_INITITATOR_SERVER_H
@@ -31,62 +27,64 @@
#include "tao/Utils/ORB_Manager.h"
#include "Initiator_i.h"
+/**
+ * @class Initiator_Server
+ *
+ * @brief This is the server for the Initiator in the test.
+ *
+ * See the README file for more information.
+ */
class Initiator_Server
{
- // = TITLE
- // This is the server for the Initiator in the test.
- //
- // = DESCRIPTION
- // See the README file for more information.
public:
+ /// Default constructor
Initiator_Server (void);
- // Default constructor
+ /// Destructor
~Initiator_Server (void);
- // Destructor
+ /// read in the IOR's for the two objects A and B
int read_ior (ACE_TCHAR *filename, unsigned int A_B);
- // read in the IOR's for the two objects A and B
+ /// Initialize the Initiator_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the Initiator_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// The IOR of object A
char * object_A_key_;
- // The IOR of object A
+ /// The IOR of object B
char * object_B_key_;
- // The IOR of object B
+ /// reference to object A
Object_A_var object_A_var_;
- // reference to object A
+ /// reference to object B
Object_B_var object_B_var_;
- // reference to object B
+ /// The ORB manager
TAO_ORB_Manager orb_manager_;
- // The ORB manager
+ /// Implementation object of the Initiator
Initiator_i *initiator_i_ptr_;
- // Implementation object of the Initiator
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
+ /// IOR of my servant.
CORBA::String_var str_;
- // IOR of my servant.
};
#endif /* _TRIANGLE_TEST_INITITATOR_SERVER_H */
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/server_A.cpp b/TAO/tests/NestedUpcall/Triangle_Test/server_A.cpp
index 564ae4e6818..f651030f77c 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/server_A.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/server_A.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// server_A.cpp
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server_A.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "server_A.h"
#include "tao/debug.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/server_A.h b/TAO/tests/NestedUpcall/Triangle_Test/server_A.h
index 095d1122d51..efb5257f293 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/server_A.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/server_A.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// server_A.h
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server_A.h
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef _TRIANGLE_TEST_OBJECT_A_SERVER_H
#define _TRIANGLE_TEST_OBJECT_A_SERVER_H
@@ -31,47 +27,49 @@
#include "tao/Utils/ORB_Manager.h"
#include "Object_A_i.h"
+/**
+ * @class Object_A_Server
+ *
+ * @brief This is the server for the object A in the test.
+ *
+ * See the README file for more information.
+ */
class Object_A_Server
{
- // = TITLE
- // This is the server for the object A in the test.
- //
- // = DESCRIPTION
- // See the README file for more information.
public:
+ /// Default constructor
Object_A_Server (void);
- // Default constructor
+ /// Destructor
~Object_A_Server (void);
- // Destructor
+ /// Initialize the NestedUpCalls_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the NestedUpCalls_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// File to output the IOR of the object A.
FILE* ior_output_file_;
- // File to output the IOR of the object A.
+ /// The ORB manager
TAO_ORB_Manager orb_manager_;
- // The ORB manager
+ /// Implementation object of the NestedUpCalls reactor.
Object_A_i object_A_i_;
- // Implementation object of the NestedUpCalls reactor.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
};
#endif /* _TRIANGLE_TEST_OBJECT_A_SERVER_H */
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/server_B.cpp b/TAO/tests/NestedUpcall/Triangle_Test/server_B.cpp
index 59fb2d7be9b..e37c51b3819 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/server_B.cpp
+++ b/TAO/tests/NestedUpcall/Triangle_Test/server_B.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// server_B.cpp
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test.
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server_B.cpp
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test.
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#include "server_B.h"
#include "tao/debug.h"
diff --git a/TAO/tests/NestedUpcall/Triangle_Test/server_B.h b/TAO/tests/NestedUpcall/Triangle_Test/server_B.h
index ec252a201a0..2eb4faaf39d 100644
--- a/TAO/tests/NestedUpcall/Triangle_Test/server_B.h
+++ b/TAO/tests/NestedUpcall/Triangle_Test/server_B.h
@@ -1,22 +1,18 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/NestedUpCalls/Triangle_Test
-//
-// = FILENAME
-// server_B.h
-//
-// = DESCRIPTION
-// This class implements a simple server for the
-// Nested Upcalls - Triangle test
-//
-// = AUTHORS
-// Michael Kircher
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server_B.h
+ *
+ * $Id$
+ *
+ * This class implements a simple server for the
+ * Nested Upcalls - Triangle test
+ *
+ *
+ * @author Michael Kircher
+ */
+//=============================================================================
+
#ifndef _TRIANGLE_TEST_OBJECT_B_SERVER_H
#define _TRIANGLE_TEST_OBJECT_B_SERVER_H
@@ -31,47 +27,49 @@
#include "tao/Utils/ORB_Manager.h"
#include "Object_B_i.h"
+/**
+ * @class Object_B_Server
+ *
+ * @brief This is the server for the object A in the test.
+ *
+ * See the README file for more information.
+ */
class Object_B_Server
{
- // = TITLE
- // This is the server for the object A in the test.
- //
- // = DESCRIPTION
- // See the README file for more information.
public:
+ /// Default constructor
Object_B_Server (void);
- // Default constructor
+ /// Destructor
~Object_B_Server (void);
- // Destructor
+ /// Initialize the NestedUpCalls_Server state - parsing arguments and ...
int init (int argc,
ACE_TCHAR **argv);
- // Initialize the NestedUpCalls_Server state - parsing arguments and ...
+ /// Run the orb
int run (void);
- // Run the orb
private:
+ /// Parses the commandline arguments.
int parse_args (void);
- // Parses the commandline arguments.
+ /// File to output the IOR of the object A.
FILE* ior_output_file_;
- // File to output the IOR of the object A.
+ /// The ORB manager
TAO_ORB_Manager orb_manager_;
- // The ORB manager
+ /// Implementation object of the NestedUpCalls reactor.
Object_B_i object_B_i_;
- // Implementation object of the NestedUpCalls reactor.
+ /// Number of commandline arguments.
int argc_;
- // Number of commandline arguments.
+ /// commandline arguments.
ACE_TCHAR **argv_;
- // commandline arguments.
};
#endif /* _TRIANGLE_TEST_OBJECT_B_SERVER_H */
diff --git a/TAO/tests/OBV/Any/AnyS_impl.h b/TAO/tests/OBV/Any/AnyS_impl.h
index 44540f31ac8..7bdb376b825 100644
--- a/TAO/tests/OBV/Any/AnyS_impl.h
+++ b/TAO/tests/OBV/Any/AnyS_impl.h
@@ -1,35 +1,33 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Any
-//
-// = FILENAME
-// AnyS_impl.h
-//
-// = AUTHOR
-// Boris Kolpackov <bosk@ipmce.ru>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file AnyS_impl.h
+ *
+ * $Id$
+ *
+ * @author Boris Kolpackov <bosk@ipmce.ru>
+ */
+//=============================================================================
+
#ifndef TAO_ANY_S_IMPL_H
#define TAO_ANY_S_IMPL_H
#include "AnyS.h"
+/**
+ * @class Test_impl
+ *
+ * @brief Implementation of Test interface
+ *
+ * This interface is provided to produce valuetypes and test
+ * marshaling
+ */
class Test_impl : public POA_OBV_AnyTest::Test
{
- // = TITLE
- // Implementation of Test interface
- //
- // = DESCRIPTION
- // This interface is provided to produce valuetypes and test
- // marshaling
- //
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual CORBA::Any * get_something (
CORBA::Boolean need_vb);
@@ -39,9 +37,9 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
CORBA::Boolean even_;
- // The ORB
};
#endif /* TAO_ANY_S_IMPL_H */
diff --git a/TAO/tests/OBV/Collocated/Forward/Test_impl.h b/TAO/tests/OBV/Collocated/Forward/Test_impl.h
index 56bfb18a128..491368adb23 100644
--- a/TAO/tests/OBV/Collocated/Forward/Test_impl.h
+++ b/TAO/tests/OBV/Collocated/Forward/Test_impl.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Collocated/Forward
-//
-// = FILENAME
-// Test_impl.h
-//
-// = AUTHOR
-// Boris Kolpackov <bosk@ipmce.ru>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Test_impl.h
+ *
+ * $Id$
+ *
+ * @author Boris Kolpackov <bosk@ipmce.ru>
+ */
+//=============================================================================
+
#ifndef TAO_TEST_IMPL_H
#define TAO_TEST_IMPL_H
@@ -20,18 +17,19 @@
#include "TreeBaseS.h"
#include "TreeNodeS.h"
+/**
+ * @class Test_impl
+ *
+ * @brief Implementation of Test interface
+ *
+ * This interface is provided to produce valuetypes and test
+ * marshaling
+ */
class Test_impl : public POA_Test
{
- // = TITLE
- // Implementation of Test interface
- //
- // = DESCRIPTION
- // This interface is provided to produce valuetypes and test
- // marshaling
- //
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual TreeController * reflect (
TreeController * tc);
@@ -39,8 +37,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TEST_IMPL_H */
diff --git a/TAO/tests/OBV/Factory/FactoryS_impl.h b/TAO/tests/OBV/Factory/FactoryS_impl.h
index 24dfdf771d3..5dd7138e2ad 100644
--- a/TAO/tests/OBV/Factory/FactoryS_impl.h
+++ b/TAO/tests/OBV/Factory/FactoryS_impl.h
@@ -1,35 +1,33 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Factory
-//
-// = FILENAME
-// FactoryS_impl.h
-//
-// = AUTHOR
-// Boris Kolpackov <bosk@ipmce.ru>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file FactoryS_impl.h
+ *
+ * $Id$
+ *
+ * @author Boris Kolpackov <bosk@ipmce.ru>
+ */
+//=============================================================================
+
#ifndef TAO_FACTORY_S_IMPL_H
#define TAO_FACTORY_S_IMPL_H
#include "FactoryS.h"
+/**
+ * @class Test_impl
+ *
+ * @brief Implementation of Test interface
+ *
+ * This interface is provided to produce valuetypes and test
+ * marshaling
+ */
class Test_impl : public POA_OBV_FactoryTest::Test
{
- // = TITLE
- // Implementation of Test interface
- //
- // = DESCRIPTION
- // This interface is provided to produce valuetypes and test
- // marshaling
- //
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual OBV_FactoryTest::BaseValue * get_base_value (void);
@@ -40,8 +38,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_FACTORY_S_IMPL_H */
diff --git a/TAO/tests/OBV/Forward/Test_impl.h b/TAO/tests/OBV/Forward/Test_impl.h
index 9092f1576e4..99d7d47f66d 100644
--- a/TAO/tests/OBV/Forward/Test_impl.h
+++ b/TAO/tests/OBV/Forward/Test_impl.h
@@ -1,35 +1,33 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Forward
-//
-// = FILENAME
-// Test_impl.h
-//
-// = AUTHOR
-// Boris Kolpackov <bosk@ipmce.ru>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Test_impl.h
+ *
+ * $Id$
+ *
+ * @author Boris Kolpackov <bosk@ipmce.ru>
+ */
+//=============================================================================
+
#ifndef TAO_TEST_IMPL_H
#define TAO_TEST_IMPL_H
#include "TreeControllerS.h"
+/**
+ * @class Test_impl
+ *
+ * @brief Implementation of Test interface
+ *
+ * This interface is provided to produce valuetypes and test
+ * marshaling
+ */
class Test_impl : public POA_Test
{
- // = TITLE
- // Implementation of Test interface
- //
- // = DESCRIPTION
- // This interface is provided to produce valuetypes and test
- // marshaling
- //
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual TreeController * reflect (
TreeController * tc);
@@ -37,8 +35,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TEST_IMPL_H */
diff --git a/TAO/tests/OBV/Simple/Client_i.h b/TAO/tests/OBV/Simple/Client_i.h
index 7406b10edcb..296bf588550 100644
--- a/TAO/tests/OBV/Simple/Client_i.h
+++ b/TAO/tests/OBV/Simple/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
@@ -28,28 +22,30 @@
#include "OBVC.h"
#include "Simple_util.h"
+/**
+ * @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/tests/OBV/Simple/Server_i.h b/TAO/tests/OBV/Simple/Server_i.h
index 0d249a51b72..ae0b534a54b 100644
--- a/TAO/tests/OBV/Simple/Server_i.h
+++ b/TAO/tests/OBV/Simple/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,12 +37,12 @@ public:
virtual void shutdown (
);
+ /// 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/tests/OBV/Simple/Simple_util.h b/TAO/tests/OBV/Simple/Simple_util.h
index a8c70b1d52f..d96ca0900e7 100644
--- a/TAO/tests/OBV/Simple/Simple_util.h
+++ b/TAO/tests/OBV/Simple/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.
ACE_TCHAR *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/tests/OBV/TC_Alignment/test_i.h b/TAO/tests/OBV/TC_Alignment/test_i.h
index b51b8e7e1ab..c4a7c8086cc 100644
--- a/TAO/tests/OBV/TC_Alignment/test_i.h
+++ b/TAO/tests/OBV/TC_Alignment/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/TC_Alignment
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Jeff Parsons <j.parsons@vanderbilt.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Jeff Parsons <j.parsons@vanderbilt.edu>
+ */
+//=============================================================================
+
#ifndef TAO_OBV_TC_ALIGNMENT_TEST_I_H
#define TAO_OBV_TC_ALIGNMENT_TEST_I_H
diff --git a/TAO/tests/OBV/Truncatable/TruncatableS_impl.h b/TAO/tests/OBV/Truncatable/TruncatableS_impl.h
index 4c8c6d46218..456b546e83e 100644
--- a/TAO/tests/OBV/Truncatable/TruncatableS_impl.h
+++ b/TAO/tests/OBV/Truncatable/TruncatableS_impl.h
@@ -1,35 +1,33 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/Truncatable
-//
-// = FILENAME
-// TruncatableS_impl.h
-//
-// = AUTHOR
-// Boris Kolpackov <bosk@ipmce.ru>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file TruncatableS_impl.h
+ *
+ * $Id$
+ *
+ * @author Boris Kolpackov <bosk@ipmce.ru>
+ */
+//=============================================================================
+
#ifndef TAO_TRUNCATABLE_S_IMPL_H
#define TAO_TRUNCATABLE_S_IMPL_H
#include "TruncatableS.h"
+/**
+ * @class Test_impl
+ *
+ * @brief Implementation of Test interface
+ *
+ * This interface is provided to produce valuetypes and test
+ * marshaling
+ */
class Test_impl : public POA_OBV_TruncatableTest::Test
{
- // = TITLE
- // Implementation of Test interface
- //
- // = DESCRIPTION
- // This interface is provided to produce valuetypes and test
- // marshaling
- //
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual void op1 (
const char * id,
@@ -71,8 +69,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TRUNCATABLE_S_IMPL_H */
diff --git a/TAO/tests/OBV/ValueBox/Test_impl.h b/TAO/tests/OBV/ValueBox/Test_impl.h
index 179177176be..c5857dd9d47 100644
--- a/TAO/tests/OBV/ValueBox/Test_impl.h
+++ b/TAO/tests/OBV/ValueBox/Test_impl.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OBV/ValueBox
-//
-// = FILENAME
-// Test_impl.h
-//
-// = AUTHOR
-// Gary Maxey
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Test_impl.h
+ *
+ * $Id$
+ *
+ * @author Gary Maxey
+ */
+//=============================================================================
+
#ifndef TAO_TEST_IMPL_H
@@ -23,8 +20,8 @@
class Test_impl : public POA_Test
{
public:
+ /// ctor
Test_impl (CORBA::ORB_ptr orb);
- // ctor
virtual VBlong * basic_op1 (
VBlong * p1,
@@ -111,8 +108,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TEST_IMPL_H */
diff --git a/TAO/tests/ORB_destroy/ORB_destroy.cpp b/TAO/tests/ORB_destroy/ORB_destroy.cpp
index 26ca7cc92cc..61aa04872aa 100644
--- a/TAO/tests/ORB_destroy/ORB_destroy.cpp
+++ b/TAO/tests/ORB_destroy/ORB_destroy.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/ORB_destroy
-//
-// = FILENAME
-// ORB_destroy.cpp
-//
-// = DESCRIPTION
-// Simple ORB destruction test.
-//
-// = AUTHOR
-// Irfan Pyarali <irfan@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file ORB_destroy.cpp
+ *
+ * $Id$
+ *
+ * Simple ORB destruction test.
+ *
+ *
+ * @author Irfan Pyarali <irfan@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/Object_Loader/Loader.h b/TAO/tests/Object_Loader/Loader.h
index 18e157271b3..0d2ed52f964 100644
--- a/TAO/tests/Object_Loader/Loader.h
+++ b/TAO/tests/Object_Loader/Loader.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Object_Loader
-//
-// = FILENAME
-// Loader.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Loader.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_OBJECT_LOADER_LOADER_H
#define TAO_OBJECT_LOADER_LOADER_H
@@ -19,21 +16,22 @@
#include "tao/Object_Loader.h"
#include "OLT_Export.h"
+/**
+ * @class Loader
+ *
+ * @brief Implement the Test interface
+ *
+ */
class OLT_Export Loader : public TAO_Object_Loader
{
- // = TITLE
- // Implement the Test interface
- //
- // = DESCRIPTION
- //
public:
+ /// ctor
Loader (void);
- // ctor
+ /// Create a new instance
virtual CORBA::Object_ptr create_object (CORBA::ORB_ptr orb,
int argc,
ACE_TCHAR *argv[]);
- // Create a new instance
};
// ACE_STATIC_SVC_DECLARE (Loader)
diff --git a/TAO/tests/Object_Loader/Test_i.h b/TAO/tests/Object_Loader/Test_i.h
index e9a7edf00bb..e9efeb48bce 100644
--- a/TAO/tests/Object_Loader/Test_i.h
+++ b/TAO/tests/Object_Loader/Test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Object_Loader
-//
-// = FILENAME
-// Test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_OBJECT_LOADER_TEST_I_H
#define TAO_OBJECT_LOADER_TEST_I_H
@@ -19,16 +16,17 @@
#include "TestS.h"
#include "OLT_Export.h"
+/**
+ * @class Test_i
+ *
+ * @brief Implement the Test interface
+ *
+ */
class OLT_Export Test_i : public POA_Test
{
- // = TITLE
- // Implement the Test interface
- //
- // = DESCRIPTION
- //
public:
+ /// ctor
Test_i (PortableServer::POA_ptr poa);
- // ctor
CORBA::Long instance_count (void);
@@ -37,8 +35,8 @@ public:
PortableServer::POA_ptr _default_POA (void);
private:
+ /// The default POA used for this object
PortableServer::POA_var poa_;
- // The default POA used for this object
static CORBA::Long instance_count_;
};
diff --git a/TAO/tests/OctetSeq/OctetSeq.cpp b/TAO/tests/OctetSeq/OctetSeq.cpp
index aaec6fc62eb..14548dd498a 100644
--- a/TAO/tests/OctetSeq/OctetSeq.cpp
+++ b/TAO/tests/OctetSeq/OctetSeq.cpp
@@ -1,23 +1,20 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OctetSeq
-//
-// = FILENAME
-// octetseq.cpp
-//
-// = DESCRIPTION
-// TAO optimizes octet sequences, this test verifies that the
-// optimizations do not break any code and that they effectively
-// improve performance.
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file octetseq.cpp
+ *
+ * $Id$
+ *
+ * TAO optimizes octet sequences, this test verifies that the
+ * optimizations do not break any code and that they effectively
+ * improve performance.
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/High_Res_Timer.h"
diff --git a/TAO/tests/OctetSeq/test_i.h b/TAO/tests/OctetSeq/test_i.h
index 1269850b911..5608f216f64 100644
--- a/TAO/tests/OctetSeq/test_i.h
+++ b/TAO/tests/OctetSeq/test_i.h
@@ -1,35 +1,34 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/OctetSeq
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_OCTETSEQ_TEST_I_H
#define TAO_OCTETSEQ_TEST_I_H
#include "testS.h"
+/**
+ * @class Database_i
+ *
+ * Implements the Database interface in test.idl
+ */
class Database_i : public POA_Test::Database
{
- // = DESCRIPTION
- // Implements the Database interface in test.idl
- //
public:
+ /// ctor
Database_i (CORBA::ORB_ptr orb,
Test::Index max_range);
- // ctor
+ /// dtor
~Database_i (void);
- // dtor
// = The Simple_Server methods.
void set (Test::Index i,
@@ -44,14 +43,14 @@ public:
void shutdown (void);
private:
+ /// The ORB pointer
CORBA::ORB_var orb_;
- // The ORB pointer
+ /// The maximum number of elements in the database
Test::Index max_range_;
- // The maximum number of elements in the database
+ /// The elements
Test::OctetSeq* elements_;
- // The elements
};
#if defined(__ACE_INLINE__)
diff --git a/TAO/tests/POA/Adapter_Activator/server.cpp b/TAO/tests/POA/Adapter_Activator/server.cpp
index 3e021282d5e..075079129c5 100644
--- a/TAO/tests/POA/Adapter_Activator/server.cpp
+++ b/TAO/tests/POA/Adapter_Activator/server.cpp
@@ -1,26 +1,23 @@
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Adapter_Activator
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This example is very similar to the Explicit_Activation example
-// except that the POAs are deleted once the object references have
-// been created. After this, an adapter activator is install in the
-// RootPOA to reactivate the POAs on demand.
-//
-// Similar to the Explicit_Activation, the client for this example
-// is Generic_Servant.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This example is very similar to the Explicit_Activation example
+ * except that the POAs are deleted once the object references have
+ * been created. After this, an adapter activator is install in the
+ * RootPOA to reactivate the POAs on demand.
+ *
+ * Similar to the Explicit_Activation, the client for this example
+ * is Generic_Servant.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "test_i.h"
@@ -38,9 +35,9 @@ class reference_counted_test_i :
public virtual test_i
{
public:
+ /// Constructor - takes a POA and a value parameter
reference_counted_test_i (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor - takes a POA and a value parameter
};
reference_counted_test_i::reference_counted_test_i (CORBA::ORB_ptr orb,
diff --git a/TAO/tests/POA/Bug_2511_Regression/server.cpp b/TAO/tests/POA/Bug_2511_Regression/server.cpp
index c0f63a4e5cf..6e205f64ea3 100644
--- a/TAO/tests/POA/Bug_2511_Regression/server.cpp
+++ b/TAO/tests/POA/Bug_2511_Regression/server.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/MT_Servant_Locator
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This program tests that multiple calls to the Servant Locator
-// can take place simultaneously.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This program tests that multiple calls to the Servant Locator
+ * can take place simultaneously.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "tao/PortableServer/ServantLocatorC.h"
diff --git a/TAO/tests/POA/Current/Current.cpp b/TAO/tests/POA/Current/Current.cpp
index f710a939edc..914f665c636 100644
--- a/TAO/tests/POA/Current/Current.cpp
+++ b/TAO/tests/POA/Current/Current.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Current
-//
-// = FILENAME
-// Current.cpp
-//
-// = DESCRIPTION
-// This program tests if accessing the POA current before the
-// RootPOA can cause any problems.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Current.cpp
+ *
+ * $Id$
+ *
+ * This program tests if accessing the POA current before the
+ * RootPOA can cause any problems.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/POA/DSI/client.cpp b/TAO/tests/POA/DSI/client.cpp
index 8e645897f43..8cadb1d1896 100644
--- a/TAO/tests/POA/DSI/client.cpp
+++ b/TAO/tests/POA/DSI/client.cpp
@@ -1,19 +1,17 @@
-// $Id$
-
-//===================================================================
-// = LIBRARY
-// TAO/tests/POA/DSI/client
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A client program for the Database IDL module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A client program for the Database IDL module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Read_Buffer.h"
diff --git a/TAO/tests/POA/DSI/server.cpp b/TAO/tests/POA/DSI/server.cpp
index 4015882d2e0..f702a4a42c8 100644
--- a/TAO/tests/POA/DSI/server.cpp
+++ b/TAO/tests/POA/DSI/server.cpp
@@ -1,19 +1,17 @@
-// $Id$
-
-//===================================================================
-// = LIBRARY
-// TAO/tests/POA/Default_Servant/server
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// A server program for the File IDL module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * A server program for the File IDL module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "Database_i.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/tests/POA/Default_Servant/Default_Servant.cpp b/TAO/tests/POA/Default_Servant/Default_Servant.cpp
index b548c0bec98..0a2ada0131d 100644
--- a/TAO/tests/POA/Default_Servant/Default_Servant.cpp
+++ b/TAO/tests/POA/Default_Servant/Default_Servant.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Default_Servant
-//
-// = FILENAME
-// Default_Servant.cpp
-//
-// = DESCRIPTION
-// This program tests the behavior of POA::id_to_servant() and
-// POA::reference_to_servant() with the use of default servants.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Default_Servant.cpp
+ *
+ * $Id$
+ *
+ * This program tests the behavior of POA::id_to_servant() and
+ * POA::reference_to_servant() with the use of default servants.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/SString.h"
diff --git a/TAO/tests/POA/Default_Servant2/File_i.cpp b/TAO/tests/POA/Default_Servant2/File_i.cpp
index 33679bf14f2..8dadb95ddd7 100644
--- a/TAO/tests/POA/Default_Servant2/File_i.cpp
+++ b/TAO/tests/POA/Default_Servant2/File_i.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-//===================================================================
-//
-// = FILENAME
-// File_i.cpp
-//
-// = DESCRIPTION
-// Implementation of the File IDL module and the interfaces
-// Descriptor and System in it.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file File_i.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the File IDL module and the interfaces
+ * Descriptor and System in it.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "File_i.h"
#include "ace/OS_NS_stdio.h"
diff --git a/TAO/tests/POA/Default_Servant2/File_i.h b/TAO/tests/POA/Default_Servant2/File_i.h
index 5c5de0a4da4..96238ca075e 100644
--- a/TAO/tests/POA/Default_Servant2/File_i.h
+++ b/TAO/tests/POA/Default_Servant2/File_i.h
@@ -1,82 +1,91 @@
-// $Id$
-
-//===================================================================
-//
-// = FILENAME
-// File_i.h
-//
-// = DESCRIPTION
-// Defines the implementation classes for the File IDL
-// module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file File_i.h
+ *
+ * $Id$
+ *
+ * Defines the implementation classes for the File IDL
+ * module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "FileS.h"
+/**
+ * @class FileImpl
+ *
+ * @brief FileImpl class provides the namespace for the File IDL module .
+ */
class FileImpl
{
- // = TITLE
- // FileImpl class provides the namespace for the File IDL module .
public:
+ /**
+ * @class Descriptor
+ *
+ * @brief Descriptor implements the Descriptor interface in the File
+ * Module A single Descriptor servant can serve multiple object
+ * references
+ */
class Descriptor : public POA_File::Descriptor
{
- // = TITLE
- // Descriptor implements the Descriptor interface in the File
- // Module A single Descriptor servant can serve multiple object
- // references
public:
+ /// Constructor
Descriptor (PortableServer::POA_ptr poa);
- // Constructor
+ /// Destructor
~Descriptor (void);
- // Destructor
+ /// Returns the default POA of this object
PortableServer::POA_ptr _default_POA (void);
- // Returns the default POA of this object
+ /// write buffer to File corresponding to this Descriptor
virtual CORBA::Long write (const File::Descriptor::DataBuffer &buffer);
- // write buffer to File corresponding to this Descriptor
virtual File::Descriptor::DataBuffer *read (CORBA::Long num_bytes);
+ /// seek to the offset in file from whence
virtual CORBA::ULong lseek (CORBA::ULong offset,
CORBA::Long whence);
- // seek to the offset in file from whence
+ /// closes the file corresponding to the requested ObjectID
virtual void destroy (void);
- // closes the file corresponding to the requested ObjectID
private:
+ /// Extracts the ACE_HANDLE from the objectID
ACE_HANDLE fd (void);
- // Extracts the ACE_HANDLE from the objectID
PortableServer::POA_var poa_;
};
+ /**
+ * @class System
+ *
+ * @brief File System implementation class.
+ */
class System : public POA_File::System
{
- // = TITLE
- // File System implementation class.
public:
+ /// Constructor, Creates a single File Descriptor Servant and
+ /// registers it with the POA as the Default Servant
System (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor, Creates a single File Descriptor Servant and
- // registers it with the POA as the Default Servant
+ ///Destructor
~System (void);
- //Destructor
+ ///Returns the default POA of this object
PortableServer::POA_ptr _default_POA (void);
- //Returns the default POA of this object
+ /// Opens a file ,creates a Descriptor reference with the
+ /// ACE_HANDLE and returns that reference
File::Descriptor_ptr open (const char *file_name,
CORBA::Long flags);
- // Opens a file ,creates a Descriptor reference with the
- // ACE_HANDLE and returns that reference
void shutdown (void);
private:
@@ -84,8 +93,8 @@ public:
PortableServer::POA_var poa_;
+ /// The single File Descriptor servant which serves requests for
+ /// any Descriptor object under poa_.
Descriptor fd_servant_;
- // The single File Descriptor servant which serves requests for
- // any Descriptor object under poa_.
};
};
diff --git a/TAO/tests/POA/Default_Servant2/client.cpp b/TAO/tests/POA/Default_Servant2/client.cpp
index 2b821fee3dc..70cfde5879e 100644
--- a/TAO/tests/POA/Default_Servant2/client.cpp
+++ b/TAO/tests/POA/Default_Servant2/client.cpp
@@ -1,19 +1,17 @@
-// $Id$
-
-//===================================================================
-// = LIBRARY
-// TAO/tests/POA/Default_Servant/client
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// A client program for the File IDL module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * A client program for the File IDL module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "FileC.h"
#include "tao/debug.h"
diff --git a/TAO/tests/POA/Default_Servant2/server.cpp b/TAO/tests/POA/Default_Servant2/server.cpp
index 12d5a4a271e..c4bf0788b75 100644
--- a/TAO/tests/POA/Default_Servant2/server.cpp
+++ b/TAO/tests/POA/Default_Servant2/server.cpp
@@ -1,19 +1,17 @@
-// $Id$
-
-//===================================================================
-// = LIBRARY
-// TAO/tests/POA/Default_Servant/server
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// A server program for the File IDL module
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//====================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * A server program for the File IDL module
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "File_i.h"
#include "tao/debug.h"
diff --git a/TAO/tests/POA/Etherealization/Etherealization.cpp b/TAO/tests/POA/Etherealization/Etherealization.cpp
index 498dd087888..c5b086aa895 100644
--- a/TAO/tests/POA/Etherealization/Etherealization.cpp
+++ b/TAO/tests/POA/Etherealization/Etherealization.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Etherealization
-//
-// = FILENAME
-// Etherealization.cpp
-//
-// = DESCRIPTION
-// This program tests for deactivation and etherealization of
-// reference counted and non reference counted servants.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Etherealization.cpp
+ *
+ * $Id$
+ *
+ * This program tests for deactivation and etherealization of
+ * reference counted and non reference counted servants.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp b/TAO/tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp
index 1f159c8cc13..9f7f101b28b 100644
--- a/TAO/tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp
+++ b/TAO/tests/POA/Excessive_Object_Deactivations/Excessive_Object_Deactivations.cpp
@@ -1,23 +1,20 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Excessive_Object_Deactivations
-//
-// = FILENAME
-// Excessive_Object_Deactivations.cpp
-//
-// = DESCRIPTION
-// This program tests for excessive deactivations of a servant.
-// The test checks excessive deactivations in a POA with SYSTEM_ID
-// and other POA with USER_ID. The test also check for excessive
-// deactivations during upcalls.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Excessive_Object_Deactivations.cpp
+ *
+ * $Id$
+ *
+ * This program tests for excessive deactivations of a servant.
+ * The test checks excessive deactivations in a POA with SYSTEM_ID
+ * and other POA with USER_ID. The test also check for excessive
+ * deactivations during upcalls.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
diff --git a/TAO/tests/POA/Explicit_Activation/server.cpp b/TAO/tests/POA/Explicit_Activation/server.cpp
index 8d7d6cb1b52..54d1e76aa4d 100644
--- a/TAO/tests/POA/Explicit_Activation/server.cpp
+++ b/TAO/tests/POA/Explicit_Activation/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Explicit_Activation
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Explicit creation of servants.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Explicit creation of servants.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/SString.h"
diff --git a/TAO/tests/POA/FindPOA/FindPOA.cpp b/TAO/tests/POA/FindPOA/FindPOA.cpp
index f9d19aef75d..d7e3c868aa8 100644
--- a/TAO/tests/POA/FindPOA/FindPOA.cpp
+++ b/TAO/tests/POA/FindPOA/FindPOA.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//===========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/FindPOA
-//
-// = FILENAME
-// FindPOA.cpp
-//
-// = DESCRIPTION
-// This Program tests the find_POA method of a POA.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//===========================================================================
+
+//=============================================================================
+/**
+ * @file FindPOA.cpp
+ *
+ * $Id$
+ *
+ * This Program tests the find_POA method of a POA.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
#include "tao/PortableServer/Adapter_Activator.h"
diff --git a/TAO/tests/POA/Forwarding/Servant_Activator.h b/TAO/tests/POA/Forwarding/Servant_Activator.h
index 57a31ea1bb8..e2e81975774 100644
--- a/TAO/tests/POA/Forwarding/Servant_Activator.h
+++ b/TAO/tests/POA/Forwarding/Servant_Activator.h
@@ -1,23 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/Forwarding
-//
-// = FILENAME
-// Servant_Activator.h
-//
-// = DESCRIPTION
-// Defines a ServantActivator class, used with a POA having a
-// RETAIN policy
-//
-// = AUTHOR
-// Irfan Pyarali
-// Michael Kircher
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Activator.h
+ *
+ * $Id$
+ *
+ * Defines a ServantActivator class, used with a POA having a
+ * RETAIN policy
+ *
+ *
+ * @author Irfan Pyarali Michael Kircher
+ */
+//=============================================================================
+
#ifndef SERVANT_ACTIVATOR_H
#define SERVANT_ACTIVATOR_H
@@ -47,14 +43,14 @@ public:
CORBA::Boolean cleanup_in_progress,
CORBA::Boolean remaining_activations);
+ /// Object should be forwarded from now on.
void forward_requests (void);
- // Object should be forwarded from now on.
private:
CORBA::ORB_var orb_;
+ /// Location to forward to
CORBA::Object_var forward_to_;
- // Location to forward to
};
#endif /* SERVANT_ACTIVATOR_H */
diff --git a/TAO/tests/POA/Forwarding/client.cpp b/TAO/tests/POA/Forwarding/client.cpp
index 4bfcf09ac6e..11f800e37f8 100644
--- a/TAO/tests/POA/Forwarding/client.cpp
+++ b/TAO/tests/POA/Forwarding/client.cpp
@@ -1,20 +1,19 @@
-// $Id$
-
-//==========================================================================
-//
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-//
-// This is a simple test client implementation. Also looks out
-// for forwarding exceptions
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//==========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ *
+ * This is a simple test client implementation. Also looks out
+ * for forwarding exceptions
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/streams.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/tests/POA/Forwarding/server.cpp b/TAO/tests/POA/Forwarding/server.cpp
index b1856fac302..b73de679875 100644
--- a/TAO/tests/POA/Forwarding/server.cpp
+++ b/TAO/tests/POA/Forwarding/server.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ========================================================================
-// = LIBRARY
-// TAO/examples/POA/Forwarding
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Server that receives requests. The server can be asked to
-// forward new requests to another server.
-//
-// = AUTHOR
-// Irfan Pyarali
-// Michael Kircher
-//
-// ========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Server that receives requests. The server can be asked to
+ * forward new requests to another server.
+ *
+ *
+ * @author Irfan Pyarali Michael Kircher
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "test_i.h"
diff --git a/TAO/tests/POA/Forwarding/test_i.h b/TAO/tests/POA/Forwarding/test_i.h
index 023e60b962a..ce1fbff6f14 100644
--- a/TAO/tests/POA/Forwarding/test_i.h
+++ b/TAO/tests/POA/Forwarding/test_i.h
@@ -1,17 +1,17 @@
-// $Id$
//=============================================================================
-//
-// = FILENAME
-// test_i.h
-//
-// = DESCRIPTION
-// Defines test_i class for the test interface
-//
-// = AUTHOR
-// Irfan Pyarali and Michael Kircher
-//
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * Defines test_i class for the test interface
+ *
+ *
+ * @author Irfan Pyarali and Michael Kircher
+ */
//=============================================================================
+
#include "testS.h"
class ServantActivator;
@@ -32,8 +32,8 @@ public:
virtual void shutdown (void);
+ /// Returns the default POA for this servant.
virtual PortableServer::POA_ptr _default_POA (void);
- // Returns the default POA for this servant.
protected:
CORBA::ORB_var orb_;
diff --git a/TAO/tests/POA/Generic_Servant/test_i.h b/TAO/tests/POA/Generic_Servant/test_i.h
index 24094760497..cc3c834acb5 100644
--- a/TAO/tests/POA/Generic_Servant/test_i.h
+++ b/TAO/tests/POA/Generic_Servant/test_i.h
@@ -1,53 +1,52 @@
-// $Id$
//=============================================================================
-//
-//
-// = FILENAME
-// test_i.h
-//
-// = DESCRIPTION
-// Defines test_i class for the test interface
-//
-// = AUTHOR
-// Irfan Pyarali
-//
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * Defines test_i class for the test interface
+ *
+ *
+ * @author Irfan Pyarali
+ */
//=============================================================================
+
#include "testS.h"
class GENERIC_SERVANT_Export test_i : public POA_test
{
public:
+ /// Constructor - takes a POA and a value parameter
test_i (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor - takes a POA and a value parameter
+ /// Returns the Default POA of this servant
PortableServer::POA_ptr _default_POA (void);
- // Returns the Default POA of this servant
+ /// A twoway operation.
void method (void);
- // A twoway operation.
+ /// A oneway operation.
void oneway_method (void);
- // A oneway operation.
+ /// A timed twoway operation.
void timed_method (CORBA::ULong timeout);
- // A timed twoway operation.
+ /// A timed twoway operation.
void timed_oneway_method (CORBA::ULong timeout);
- // A timed twoway operation.
+ /// Shutdown the ORB
void shutdown (void);
- // Shutdown the ORB
+ /// Sleep for some time.
void sleep (CORBA::ULong timeout,
const char *operation);
- // Sleep for some time.
protected:
+ /// Our ORB.
CORBA::ORB_var orb_;
- // Our ORB.
+ /// Our POA.
PortableServer::POA_var poa_;
- // Our POA.
};
diff --git a/TAO/tests/POA/Identity/Identity.cpp b/TAO/tests/POA/Identity/Identity.cpp
index 9d1e479b9b6..5d544812401 100644
--- a/TAO/tests/POA/Identity/Identity.cpp
+++ b/TAO/tests/POA/Identity/Identity.cpp
@@ -1,19 +1,18 @@
-// $Id$
-
-// ==================================================
-// = LIBRARY
-// TAO/test/POA/Identity
-//
-// = FILENAME
-// Identity.cpp
-//
-// = DESCRIPTION
-// This program demonstrates and tests how to move between id,
-// reference, and servants.
-//
-// = AUTHOR
-// Irfan Pyarali
-// ==================================================
+
+//=============================================================================
+/**
+ * @file Identity.cpp
+ *
+ * $Id$
+ *
+ * This program demonstrates and tests how to move between id,
+ * reference, and servants.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "tao/ORB_Core.h"
diff --git a/TAO/tests/POA/Loader/Servant_Activator.cpp b/TAO/tests/POA/Loader/Servant_Activator.cpp
index 869e07be10f..9f274cb60a4 100644
--- a/TAO/tests/POA/Loader/Servant_Activator.cpp
+++ b/TAO/tests/POA/Loader/Servant_Activator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/Loader
-//
-// = FILENAME
-// Servant_Activator.cpp
-//
-// = DESCRIPTION
-// Implementation of <ServantActivator>, which is used by a POA
-// with a RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Servant_Activator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of <ServantActivator>, which is used by a POA
+ * with a RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Servant_Activator.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/tests/POA/Loader/Servant_Activator.h b/TAO/tests/POA/Loader/Servant_Activator.h
index 2b00f10541a..845f66b2787 100644
--- a/TAO/tests/POA/Loader/Servant_Activator.h
+++ b/TAO/tests/POA/Loader/Servant_Activator.h
@@ -1,22 +1,19 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Activator.h
-//
-// = DESCRIPTION
-// Defines a <ServantActivator> class, which activates a servant by
-// obtaining it and associates it with an object on-demand.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Activator.h
+ *
+ * $Id$
+ *
+ * Defines a <ServantActivator> class, which activates a servant by
+ * obtaining it and associates it with an object on-demand.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVANT_ACTIVATOR_H
#define SERVANT_ACTIVATOR_H
@@ -41,65 +38,73 @@ class ServantActivator :
// This class associates an unassociated servant with an object in
// the POA Active Object Map.
public:
+ /**
+ * This typedef is used to typecast the void* obtained when finding
+ * a symbol in the dll. Invoking the function pointer obtained would
+ * get a servant.
+ */
typedef PortableServer::Servant
(*SERVANT_FACTORY) (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr poa,
CORBA::ORB_ptr orb);
- // This typedef is used to typecast the void* obtained when finding
- // a symbol in the dll. Invoking the function pointer obtained would
- // get a servant.
+ /**
+ * This typedef is used to obtain the garbage_collection_function symbol
+ * in the dll. Invoking the function pointer obtained would then destroy
+ * the servant.
+ */
typedef void
(*SERVANT_GARBAGE_COLLECTOR) (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr,
PortableServer::Servant servant);
- // This typedef is used to obtain the garbage_collection_function symbol
- // in the dll. Invoking the function pointer obtained would then destroy
- // the servant.
+ /// Initialization.
ServantActivator (CORBA::ORB_ptr orb,
const ACE_TCHAR *dllname,
const ACE_TCHAR *factory_function,
const ACE_TCHAR *garbage_collection_function);
- // Initialization.
+ /**
+ * This method is invoked by a POA with USE_SERVANT_MANAGER and
+ * RETAIN policies, whenever it receives a request for a
+ * test object that is not currently active. When an servant
+ * pointer corresponding to objectId is not found in the Active
+ * Object Map, the POA hands over the job of obtaining the servant
+ * to the Servant Manager. Depending upon whether the POA is created
+ * with RETAIN or NON_RETAIN as the servant_retention policy, the
+ * Servant Activator or the Servant Locator interface is invoked
+ * respectively.
+ */
virtual PortableServer::Servant incarnate (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr poa);
- // This method is invoked by a POA with USE_SERVANT_MANAGER and
- // RETAIN policies, whenever it receives a request for a
- // test object that is not currently active. When an servant
- // pointer corresponding to objectId is not found in the Active
- // Object Map, the POA hands over the job of obtaining the servant
- // to the Servant Manager. Depending upon whether the POA is created
- // with RETAIN or NON_RETAIN as the servant_retention policy, the
- // Servant Activator or the Servant Locator interface is invoked
- // respectively.
+ /**
+ * This method is invoked whenever a test object is
+ * deactivated. This occurs when the POA is destroyed or the Object
+ * is deactivated. When the POA is getting destroyed, it needs to
+ * deactivate every object in the Active Object Map and on that call
+ * the ServantActivator invokes this method which will destroy the
+ * servant associated with the object.
+ */
virtual void etherealize (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
PortableServer::Servant servant,
CORBA::Boolean cleanup_in_progress,
CORBA::Boolean remaining_activations);
- // This method is invoked whenever a test object is
- // deactivated. This occurs when the POA is destroyed or the Object
- // is deactivated. When the POA is getting destroyed, it needs to
- // deactivate every object in the Active Object Map and on that call
- // the ServantActivator invokes this method which will destroy the
- // servant associated with the object.
private:
+ /// The ACE_DLL object which performs the task of loading the dll
+ /// and accessing it.
ACE_DLL dll_;
- // The ACE_DLL object which performs the task of loading the dll
- // and accessing it.
+ /// The function pointer of factory_function type.
SERVANT_FACTORY servant_supplier_;
- // The function pointer of factory_function type.
+ /// The function pointer of garbage_collection_function type.
SERVANT_GARBAGE_COLLECTOR servant_garbage_collector_;
- // The function pointer of garbage_collection_function type.
+ /// A reference to the ORB.
CORBA::ORB_var orb_;
- // A reference to the ORB.
};
#endif /* SERVANT_ACTIVATOR_H */
diff --git a/TAO/tests/POA/Loader/Servant_Locator.cpp b/TAO/tests/POA/Loader/Servant_Locator.cpp
index 2e277cede45..7faaa0a429d 100644
--- a/TAO/tests/POA/Loader/Servant_Locator.cpp
+++ b/TAO/tests/POA/Loader/Servant_Locator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/Loader
-//
-// = FILENAME
-// Servant_Locator.cpp
-//
-// = DESCRIPTION
-// Implementation of ServantLocator class, used with a POA
-// having a NON_RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Locator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of ServantLocator class, used with a POA
+ * having a NON_RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Servant_Locator.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/tests/POA/Loader/Servant_Locator.h b/TAO/tests/POA/Loader/Servant_Locator.h
index 2c4c64a92a4..050856983b3 100644
--- a/TAO/tests/POA/Loader/Servant_Locator.h
+++ b/TAO/tests/POA/Loader/Servant_Locator.h
@@ -1,22 +1,19 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/Loader
-//
-// = FILENAME
-// Servant_Locator.h
-//
-// = DESCRIPTION
-// Defines a ServantLocator class , used with a POA having
-// a NON_RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Locator.h
+ *
+ * $Id$
+ *
+ * Defines a ServantLocator class , used with a POA having
+ * a NON_RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVANT_LOCATOR_H
#define SERVANT_LOCATOR_H
@@ -44,74 +41,82 @@ class ServantLocator :
// Manager. It is invoked when the POA has an USE_SERVANT_MANAGER
// policy and a servant_retention policy of NON_RETAIN type.
public:
+ /**
+ * This typedef is used to typecast the void* obtained when finding
+ * a symbol in the dll. Invoking the function pointer obtained would
+ * get a servant.
+ */
typedef PortableServer::Servant
(*SERVANT_FACTORY) (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr poa,
CORBA::ORB_ptr orb);
- // This typedef is used to typecast the void* obtained when finding
- // a symbol in the dll. Invoking the function pointer obtained would
- // get a servant.
+ /**
+ * This typedef is used to obtain the garbage_collection_function symbol
+ * in the dll. Invoking the function pointer obtained would then destroy
+ * the servant.
+ */
typedef void
(*SERVANT_GARBAGE_COLLECTOR) (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr,
PortableServer::Servant servant);
- // This typedef is used to obtain the garbage_collection_function symbol
- // in the dll. Invoking the function pointer obtained would then destroy
- // the servant.
+ /// Constructor.
ServantLocator (CORBA::ORB_ptr orb,
const ACE_TCHAR *dllname,
const ACE_TCHAR *factory_function,
const ACE_TCHAR *garbage_collection_function);
- // Constructor.
+ /**
+ * This method is invoked by a POA whenever it receives a request
+ * for test object that is not currently active. When the POA is
+ * created using the NON_RETAIN policy the Active Object Map is not
+ * maintained, in other words, an association between the ObjectId
+ * and the servant is not maintained. Hence every client request the
+ * servant has to be loaded. Note the operation argument. This
+ * argument specifies the operation to be invoked on the
+ * servant. The cookie helps in marking the servant. This marking is
+ * useful while destroying the servant.
+ */
virtual PortableServer::Servant preinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie &the_cookie);
- // This method is invoked by a POA whenever it receives a request
- // for test object that is not currently active. When the POA is
- // created using the NON_RETAIN policy the Active Object Map is not
- // maintained, in other words, an association between the ObjectId
- // and the servant is not maintained. Hence every client request the
- // servant has to be loaded. Note the operation argument. This
- // argument specifies the operation to be invoked on the
- // servant. The cookie helps in marking the servant. This marking is
- // useful while destroying the servant.
+ /**
+ * This method is invoked whenever a test servant completes a
+ * request. As the Servant Loactor interface is used when the POA
+ * doesnt maintain the Active Object Map, its necessary to get rid
+ * of the servant after the client request has been processed. The
+ * appropriate servant is destroyed by verifying the cookie.Again
+ * this method is invoked per client request.
+ */
virtual void postinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie the_cookie,
PortableServer::Servant the_servant);
- // This method is invoked whenever a test servant completes a
- // request. As the Servant Loactor interface is used when the POA
- // doesnt maintain the Active Object Map, its necessary to get rid
- // of the servant after the client request has been processed. The
- // appropriate servant is destroyed by verifying the cookie.Again
- // this method is invoked per client request.
private:
+ /// The name of the dll containing the servant.
ACE_CString dllname_;
- // The name of the dll containing the servant.
+ /// The symbol which on getting invoked will give us the servant
+ /// pointer.
ACE_CString create_symbol_;
- // The symbol which on getting invoked will give us the servant
- // pointer.
+ /// The ACE_DLL object which performs the task of loading the dll
+ /// and accessing it.
ACE_DLL dll_;
- // The ACE_DLL object which performs the task of loading the dll
- // and accessing it.
+ /// The function pointer of factory_function type.
SERVANT_FACTORY servant_supplier_;
- // The function pointer of factory_function type.
+ /// The function pointer of garbage_collection_function type.
SERVANT_GARBAGE_COLLECTOR servant_garbage_collector_;
- // The function pointer of garbage_collection_function type.
+ /// A reference to the ORB.
CORBA::ORB_var orb_;
- // A reference to the ORB.
};
#endif /* SERVANT_LOCATOR_H */
diff --git a/TAO/tests/POA/Loader/Server_Manager.h b/TAO/tests/POA/Loader/Server_Manager.h
index 84d347dc2b4..15db7a8549a 100644
--- a/TAO/tests/POA/Loader/Server_Manager.h
+++ b/TAO/tests/POA/Loader/Server_Manager.h
@@ -1,102 +1,103 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
//=============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/Loader
-//
-// = FILENAME
-// Server_Manager.h
-//
-// = DESCRIPTION
-// Helper class for the server application.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
+/**
+ * @file Server_Manager.h
+ *
+ * $Id$
+ *
+ * Helper class for the server application.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
//=============================================================================
+
#ifndef SERVER_MANAGER_H
#define SERVER_MANAGER_H
#include "Servant_Activator.h"
#include "Servant_Locator.h"
+/**
+ * @class Server_i
+ *
+ * @brief This class provides the server application with helper methods
+ *
+ * The various methods required by the server application for
+ * utilizing the ServantActivator and ServantLocator interfaces of
+ * the Servant Manager are implemented by this class. These
+ * include initialisation procedures of the ServantActivator and
+ * ServantLocator, and creation of POAs with emphasis on the
+ * servant retention policy.
+ */
class Server_i
{
- // = TITLE
- // This class provides the server application with helper methods
- //
- // = DESCRIPTION
- // The various methods required by the server application for
- // utilizing the ServantActivator and ServantLocator interfaces of
- // the Servant Manager are implemented by this class. These
- // include initialisation procedures of the ServantActivator and
- // ServantLocator, and creation of POAs with emphasis on the
- // servant retention policy.
public:
// = Initialization and termination methods.
+ /// Initialisation.
Server_i (void);
- // Initialisation.
+ /// Destruction.
~Server_i (void);
- // Destruction.
+ /// Initialisation of the ORB and poa.
int init (int argc, ACE_TCHAR **argv);
- // Initialisation of the ORB and poa.
+ /**
+ * This method creates a POA from the root_poa with emphasis being
+ * on the servant_retention_policy which decides the use of the
+ * ServantActivator or ServantLocator interfaces. The
+ * servent_retention_policy value is 1 for the RETAIN policy and 0
+ * for the NONRETAIN policy.
+ */
PortableServer::POA_ptr create_poa (const char* name,
int servant_retention_policy);
- // This method creates a POA from the root_poa with emphasis being
- // on the servant_retention_policy which decides the use of the
- // ServantActivator or ServantLocator interfaces. The
- // servent_retention_policy value is 1 for the RETAIN policy and 0
- // for the NONRETAIN policy.
+ /// A ServantActivator object is created and initialised.
int create_activator (PortableServer::POA_var first_poa);
- // A ServantActivator object is created and initialised.
+ /// A ServantActivator object is created and initialised.
int create_locator (PortableServer::POA_var second_poa);
- // A ServantActivator object is created and initialised.
+ /// The server is executed.
int run (void);
- // The server is executed.
private:
+ /// Parses the input arguments.
int parse_args (int argc, ACE_TCHAR **argv);
- // Parses the input arguments.
+ /// The IORs are written to a file for future use.
int write_iors_to_file (const char *first_ior,
const char *second_ior);
- // The IORs are written to a file for future use.
+ /// Default ior file.
ACE_TCHAR *ior_output_file_;
- // Default ior file.
+ /// The orb pointer.
CORBA::ORB_var orb_;
- // The orb pointer.
+ /// The poa policicies.
CORBA::PolicyList policies_;
- // The poa policicies.
+ /// The root_poa which is used for cretaing different child poas.
PortableServer::POA_var root_poa_;
- // The root_poa which is used for cretaing different child poas.
+ /// The poa_manager object.
PortableServer::POAManager_var poa_manager_;
- // The poa_manager object.
+ /// The object pointer used by the ServantActivator.
CORBA::Object_var first_test_;
- // The object pointer used by the ServantActivator.
+ /// The object pointer used by the Servant Locator.
CORBA::Object_var second_test_;
- // The object pointer used by the Servant Locator.
+ /// The servant activator object.
ServantActivator *servant_activator_;
- // The servant activator object.
+ /// The servant locator object.
ServantLocator *servant_locator_;
- // The servant locator object.
};
#endif /* SERVER_MANAGER_H */
diff --git a/TAO/tests/POA/Loader/server.cpp b/TAO/tests/POA/Loader/server.cpp
index 87bac3179a6..809eccba1fa 100644
--- a/TAO/tests/POA/Loader/server.cpp
+++ b/TAO/tests/POA/Loader/server.cpp
@@ -1,17 +1,17 @@
-// $Id$
-//============================================================================
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Server application to test the Servant Activator and Servant Locator.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Server application to test the Servant Activator and Servant Locator.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Server_Manager.h"
diff --git a/TAO/tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp b/TAO/tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp
index 3b556cafe75..98350ccd826 100644
--- a/TAO/tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp
+++ b/TAO/tests/POA/MT_Servant_Locator/MT_Servant_Locator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/MT_Servant_Locator
-//
-// = FILENAME
-// MT_Servant_Locator.cpp
-//
-// = DESCRIPTION
-// This program tests that multiple calls to the Servant Locator
-// can take place simultaneously.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file MT_Servant_Locator.cpp
+ *
+ * $Id$
+ *
+ * This program tests that multiple calls to the Servant Locator
+ * can take place simultaneously.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Task.h"
diff --git a/TAO/tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp b/TAO/tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp
index 01961ebc2ee..77a0ad2a2c0 100644
--- a/TAO/tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp
+++ b/TAO/tests/POA/Nested_Non_Servant_Upcalls/Nested_Non_Servant_Upcalls.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Nested_Non_Servant_Upcalls
-//
-// = FILENAME
-// Nested_Non_Servant_Upcalls.cpp
-//
-// = DESCRIPTION
-// This program tests that nested non-servant upcalls are handled
-// correctly.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Nested_Non_Servant_Upcalls.cpp
+ *
+ * $Id$
+ *
+ * This program tests that nested non-servant upcalls are handled
+ * correctly.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Task.h"
diff --git a/TAO/tests/POA/NewPOA/NewPOA.cpp b/TAO/tests/POA/NewPOA/NewPOA.cpp
index d340be024e4..3d503c35d19 100644
--- a/TAO/tests/POA/NewPOA/NewPOA.cpp
+++ b/TAO/tests/POA/NewPOA/NewPOA.cpp
@@ -1,25 +1,24 @@
-// $Id$
-
-// ==========================================================================
-// = LIBRARY
-// TAO/tests/POA/NewPOA
-//
-// = FILENAME
-// NewPOA.cpp
-//
-// = DESCRIPTION
-// This program demonstrates creation of new POAs, as children of the root POA or the
-// existing POA.
-// There are three new POA created in this example.
-// The hierarchy of POAs looks like this.
-//
-// /-->first_poa-->first_poa/second_poa
-// RootPOA--
-// \-->third_poa
-//
-// = AUTHOR
-// Irfan Pyarali
-// ========================================================================
+
+//=============================================================================
+/**
+ * @file NewPOA.cpp
+ *
+ * $Id$
+ *
+ * This program demonstrates creation of new POAs, as children of the root POA or the
+ * existing POA.
+ * There are three new POA created in this example.
+ * The hierarchy of POAs looks like this.
+ *
+ * /-->first_poa-->first_poa/second_poa
+ * RootPOA--
+ * \-->third_poa
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp b/TAO/tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp
index b63df5cebd5..3d862fd28db 100644
--- a/TAO/tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp
+++ b/TAO/tests/POA/Non_Servant_Upcalls/Non_Servant_Upcalls.cpp
@@ -1,23 +1,20 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Non_Servant_Upcalls
-//
-// = FILENAME
-// Non_Servant_Upcalls.cpp
-//
-// = DESCRIPTION
-// This program tests the users ability to make calls on a POA
-// during non-servant upcalls. In this example, a servant which
-// is being destroyed during because of a deactivate_object()
-// call, tries to deactivate another object in its destructor.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Non_Servant_Upcalls.cpp
+ *
+ * $Id$
+ *
+ * This program tests the users ability to make calls on a POA
+ * during non-servant upcalls. In this example, a servant which
+ * is being destroyed during because of a deactivate_object()
+ * call, tries to deactivate another object in its destructor.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
diff --git a/TAO/tests/POA/Object_Reactivation/Object_Reactivation.cpp b/TAO/tests/POA/Object_Reactivation/Object_Reactivation.cpp
index 67835cf92cf..f497a31d384 100644
--- a/TAO/tests/POA/Object_Reactivation/Object_Reactivation.cpp
+++ b/TAO/tests/POA/Object_Reactivation/Object_Reactivation.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Object_Reactivation
-//
-// = FILENAME
-// Object_Reactivation.cpp
-//
-// = DESCRIPTION
-// This program tests the reactivation of a servant that has been
-// deactivated but not removed from the Active Object Map yet.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Object_Reactivation.cpp
+ *
+ * $Id$
+ *
+ * This program tests the reactivation of a servant that has been
+ * deactivated but not removed from the Active Object Map yet.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Task.h"
diff --git a/TAO/tests/POA/On_Demand_Activation/Servant_Activator.cpp b/TAO/tests/POA/On_Demand_Activation/Servant_Activator.cpp
index 6e3519eb492..3f0aa24d8e2 100644
--- a/TAO/tests/POA/On_Demand_Activation/Servant_Activator.cpp
+++ b/TAO/tests/POA/On_Demand_Activation/Servant_Activator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/On_Demand_Activation/Servant_Activator
-//
-// = FILENAME
-// Servant_Activator.cpp
-//
-// = DESCRIPTION
-// Implementation of ServantActivator, which is used by a POA with
-// a RETAIN policy.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Activator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of ServantActivator, which is used by a POA with
+ * a RETAIN policy.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "Servant_Activator.h"
#include "test_i.h"
diff --git a/TAO/tests/POA/On_Demand_Activation/Servant_Activator.h b/TAO/tests/POA/On_Demand_Activation/Servant_Activator.h
index af28972deb1..5f455082704 100644
--- a/TAO/tests/POA/On_Demand_Activation/Servant_Activator.h
+++ b/TAO/tests/POA/On_Demand_Activation/Servant_Activator.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/On_Demand_Activation/Servant_Activator
-//
-// = FILENAME
-// Servant_Activator.h
-//
-// = DESCRIPTION
-// Defines a ServantActivator class.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Activator.h
+ *
+ * $Id$
+ *
+ * Defines a ServantActivator class.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
#include "tao/PortableServer/ServantActivatorC.h"
@@ -30,20 +27,22 @@ class ServantActivator :
public:
ServantActivator (CORBA::ORB_ptr orb);
+ /**
+ * This method is invoked by a POA with USE_SERVANT_MANAGER and
+ * RETAIN policies, whenever it receives a request for a test object
+ * that is not currently active.
+ */
PortableServer::Servant incarnate (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr poa);
- // This method is invoked by a POA with USE_SERVANT_MANAGER and
- // RETAIN policies, whenever it receives a request for a test object
- // that is not currently active.
+ /// This method is invoked whenever a test object is deactivated.
void etherealize (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
PortableServer::Servant servant,
CORBA::Boolean cleanup_in_progress,
CORBA::Boolean remaining_activations);
- // This method is invoked whenever a test object is deactivated.
private:
+ /// A reference to the ORB.
CORBA::ORB_var orb_;
- // A reference to the ORB.
};
diff --git a/TAO/tests/POA/On_Demand_Activation/Servant_Locator.cpp b/TAO/tests/POA/On_Demand_Activation/Servant_Locator.cpp
index 408a3652372..ed317299e10 100644
--- a/TAO/tests/POA/On_Demand_Activation/Servant_Locator.cpp
+++ b/TAO/tests/POA/On_Demand_Activation/Servant_Locator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/On_Demand_Activation/Servant_Locator
-//
-// = FILENAME
-// Servant_Locator.cpp
-//
-// = DESCRIPTION
-// Implementation of ServantLocator class , used with a POA
-// having a NON_RETAIN policy.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Servant_Locator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of ServantLocator class , used with a POA
+ * having a NON_RETAIN policy.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "Servant_Locator.h"
#include "test_i.h"
diff --git a/TAO/tests/POA/On_Demand_Activation/Servant_Locator.h b/TAO/tests/POA/On_Demand_Activation/Servant_Locator.h
index fb1460827ac..13c3e5857ab 100644
--- a/TAO/tests/POA/On_Demand_Activation/Servant_Locator.h
+++ b/TAO/tests/POA/On_Demand_Activation/Servant_Locator.h
@@ -1,22 +1,19 @@
// -*- C++ -*-
-// $Id$
-
-//================================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/On_Demand_Activation/Servant_Locator
-//
-// = FILENAME
-// Servant_Locator.h
-//
-// = DESCRIPTION
-// Defines a ServantLocator class, used with a POA having a
-// NON_RETAIN policy
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//==================================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Locator.h
+ *
+ * $Id$
+ *
+ * Defines a ServantLocator class, used with a POA having a
+ * NON_RETAIN policy
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
#include "tao/PortableServer/ServantLocatorC.h"
@@ -33,27 +30,27 @@ class ServantLocator :
// This class is used by a POA with USE_SERVANT_MANAGER and
// NON_RETAIN policy.
public:
+ /// constructor
ServantLocator (CORBA::ORB_ptr orb);
- // constructor
+ /// This method is invoked by a POA whenever it receives a request
+ /// for test object that is not currently active.
virtual PortableServer::Servant preinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie &the_cookie);
- // This method is invoked by a POA whenever it receives a request
- // for test object that is not currently active.
+ /// This method is invoked whenever a test servant completes a
+ /// request.
virtual void postinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie the_cookie,
PortableServer::Servant the_servant);
- // This method is invoked whenever a test servant completes a
- // request.
private:
+ /// Counter for number of invocations of this.
int counter_;
- // Counter for number of invocations of this.
CORBA::ORB_var orb_;
};
diff --git a/TAO/tests/POA/On_Demand_Activation/server.cpp b/TAO/tests/POA/On_Demand_Activation/server.cpp
index cc26214a8f1..ed72b90c473 100644
--- a/TAO/tests/POA/On_Demand_Activation/server.cpp
+++ b/TAO/tests/POA/On_Demand_Activation/server.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-//============================================================================
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Server to test the Servant Activator and Servant Locator for a POA.
-//
-// = AUTHOR
-// Irfan Pyarali <irfan@cs.wustl.edu>
-//
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Server to test the Servant Activator and Servant Locator for a POA.
+ *
+ *
+ * @author Irfan Pyarali <irfan@cs.wustl.edu>
+ */
//=============================================================================
+
#include "ace/streams.h"
#include "ace/Get_Opt.h"
#include "ace/SString.h"
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Activator.cpp b/TAO/tests/POA/On_Demand_Loading/Servant_Activator.cpp
index 05233a16914..8b79859a529 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Activator.cpp
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Activator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Activator.cpp
-//
-// = DESCRIPTION
-// Implementation of <ServantActivator_i>, which is used by a POA
-// with a RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Servant_Activator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of <ServantActivator_i>, which is used by a POA
+ * with a RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Servant_Activator.h"
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Activator.h b/TAO/tests/POA/On_Demand_Loading/Servant_Activator.h
index aeca82015f8..61259decad8 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Activator.h
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Activator.h
@@ -1,23 +1,20 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Activator.h
-//
-// = DESCRIPTION
-// Defines a <ServantActivator_i> class, which uses a
-// Servant_Manager to activate a servant by loading it and
-// associates it with an object on-demand.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file Servant_Activator.h
+ *
+ * $Id$
+ *
+ * Defines a <ServantActivator_i> class, which uses a
+ * Servant_Manager to activate a servant by loading it and
+ * associates it with an object on-demand.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVANT_ACTIVATOR_H
#define SERVANT_ACTIVATOR_H
@@ -38,44 +35,50 @@ class ServantActivator_i :
// This class associates an unassociated servant with an object in
// the POA Active Object Map.
public:
+ /// Initialization.
ServantActivator_i (CORBA::ORB_ptr orb);
- // Initialization.
+ /**
+ * This method is invoked by a POA with USE_SERVANT_MANAGER and
+ * RETAIN policies, whenever it receives a request for a test object
+ * that is not currently active. When an servant pointer
+ * corresponding to objectId is not found in the Active Object Map,
+ * the POA hands over the job of obtaining the servant to the
+ * Servant Manager. Depending upon whether the POA is created with
+ * RETAIN or NON_RETAIN as the servant_retention policy, the Servant
+ * Activator or the Servant Locator interface is invoked
+ * respectively.
+ */
virtual PortableServer::Servant incarnate (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr poa);
- // This method is invoked by a POA with USE_SERVANT_MANAGER and
- // RETAIN policies, whenever it receives a request for a test object
- // that is not currently active. When an servant pointer
- // corresponding to objectId is not found in the Active Object Map,
- // the POA hands over the job of obtaining the servant to the
- // Servant Manager. Depending upon whether the POA is created with
- // RETAIN or NON_RETAIN as the servant_retention policy, the Servant
- // Activator or the Servant Locator interface is invoked
- // respectively.
+ /**
+ * This method is invoked whenever a test servant is
+ * deactivated. This occurs when the POA is destroyed or the Object
+ * is deactivated. When the POA is getting destroyed, it needs to
+ * deactivate every object in the Active Object Map and on that call
+ * the ServantActivator invokes this method which will destroy the
+ * servant associated with the object.
+ */
virtual void etherealize (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
PortableServer::Servant servant,
CORBA::Boolean cleanup_in_progress,
CORBA::Boolean remaining_activations);
- // This method is invoked whenever a test servant is
- // deactivated. This occurs when the POA is destroyed or the Object
- // is deactivated. When the POA is getting destroyed, it needs to
- // deactivate every object in the Active Object Map and on that call
- // the ServantActivator invokes this method which will destroy the
- // servant associated with the object.
+ /// Returns an ObjectId when given a DLL name and the factory
+ /// function in the DLL that will create an appropriate Servant.
PortableServer::ObjectId_var create_dll_object_id (const char *dllname,
const char *factory_function);
- // Returns an ObjectId when given a DLL name and the factory
- // function in the DLL that will create an appropriate Servant.
private:
+ /**
+ * An ServantManager object that provides utility methods. The
+ * methods include obtaining the servant using an ACE_DLL object,
+ * destroying the servant and extracting the dllname and factory
+ * function from the ObjectId.
+ */
ServantManager_i servant_manager_;
- // An ServantManager object that provides utility methods. The
- // methods include obtaining the servant using an ACE_DLL object,
- // destroying the servant and extracting the dllname and factory
- // function from the ObjectId.
};
#endif /* SERVANT_ACTIVATOR_H */
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Locator.cpp b/TAO/tests/POA/On_Demand_Loading/Servant_Locator.cpp
index 1e690ea3378..2ba068c0267 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Locator.cpp
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Locator.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Locator.cpp
-//
-// = DESCRIPTION
-// Implementation of ServantLocator_i class, used with a POA
-// having a NON_RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Locator.cpp
+ *
+ * $Id$
+ *
+ * Implementation of ServantLocator_i class, used with a POA
+ * having a NON_RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Servant_Locator.h"
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Locator.h b/TAO/tests/POA/On_Demand_Loading/Servant_Locator.h
index f1a0b45c5f8..a75819b1bc1 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Locator.h
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Locator.h
@@ -1,22 +1,19 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-//================================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Locator.h
-//
-// = DESCRIPTION
-// Defines a ServantLocator_i class , used with a POA having
-// a NON_RETAIN policy.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//==================================================================================
+//=============================================================================
+/**
+ * @file Servant_Locator.h
+ *
+ * $Id$
+ *
+ * Defines a ServantLocator_i class , used with a POA having
+ * a NON_RETAIN policy.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVANT_LOCATOR_H
#define SERVANT_LOCATOR_H
@@ -41,45 +38,51 @@ class ServantLocator_i :
// Manager. It is invoked when the POA has an USE_SERVANT_MANAGER
// policy and a servant_retention policy of NON_RETAIN type.
public:
+ /// Constructor.
ServantLocator_i (CORBA::ORB_ptr orb);
- // Constructor.
+ /**
+ * This method is invoked by a POA whenever it receives a request
+ * for test object that is not currently active. When the POA is
+ * created using the NON_RETAIN policy the Active Object Map is not
+ * maintained, in other words, an association between the ObjectId
+ * and the servant is not maintained. Hence every client request the
+ * servant has to be loaded. Note the operation argument. This
+ * argument specifies the operation to be invoked on the
+ * servant. The cookie helps in marking the servant. This marking is
+ * useful while destroying the servant.
+ */
virtual PortableServer::Servant preinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie &the_cookie);
- // This method is invoked by a POA whenever it receives a request
- // for test object that is not currently active. When the POA is
- // created using the NON_RETAIN policy the Active Object Map is not
- // maintained, in other words, an association between the ObjectId
- // and the servant is not maintained. Hence every client request the
- // servant has to be loaded. Note the operation argument. This
- // argument specifies the operation to be invoked on the
- // servant. The cookie helps in marking the servant. This marking is
- // useful while destroying the servant.
+ /**
+ * This method is invoked whenever a test servant completes a
+ * request. As the Servant Loactor interface is used when the POA
+ * doesnt maintain the Active Object Map, its necessary to get rid
+ * of the servant after the client request has been processed. The
+ * appropriate servant is destroyed by verifying the cookie.Again
+ * this method is invoked per client request.
+ */
virtual void postinvoke (const PortableServer::ObjectId &oid,
PortableServer::POA_ptr adapter,
const char *operation,
PortableServer::ServantLocator::Cookie the_cookie,
PortableServer::Servant the_servant);
- // This method is invoked whenever a test servant completes a
- // request. As the Servant Loactor interface is used when the POA
- // doesnt maintain the Active Object Map, its necessary to get rid
- // of the servant after the client request has been processed. The
- // appropriate servant is destroyed by verifying the cookie.Again
- // this method is invoked per client request.
+ /// Returns an ObjectId when given an dll name and the factory method
+ /// to be invoked in the dll.
PortableServer::ObjectId_var create_dll_object_id (const char *dllname,
const char *factory_function);
- // Returns an ObjectId when given an dll name and the factory method
- // to be invoked in the dll.
private:
+ /**
+ * The <ServantManager_i> object that provides utility methods. The
+ * methods include obtaining the servant using an ACE_DLL object,
+ * destroying the servant and extracting the dllname and factory
+ * function from the ObjectId.
+ */
ServantManager_i servant_manager_;
- // The <ServantManager_i> object that provides utility methods. The
- // methods include obtaining the servant using an ACE_DLL object,
- // destroying the servant and extracting the dllname and factory
- // function from the ObjectId.
};
#endif /* SERVANT_LOCATOR_H */
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Manager.cpp b/TAO/tests/POA/On_Demand_Loading/Servant_Manager.cpp
index 761ff34b097..edff944b13b 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Manager.cpp
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Manager.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Manager.cpp
-//
-// = DESCRIPTION
-// Implementation of the helper class for the ServantActivator_i
-// and the ServantLocator_i.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Manager.cpp
+ *
+ * $Id$
+ *
+ * Implementation of the helper class for the ServantActivator_i
+ * and the ServantLocator_i.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Servant_Manager.h"
#include "tao/debug.h"
diff --git a/TAO/tests/POA/On_Demand_Loading/Servant_Manager.h b/TAO/tests/POA/On_Demand_Loading/Servant_Manager.h
index 2ada43d81ab..3177f0b3964 100644
--- a/TAO/tests/POA/On_Demand_Loading/Servant_Manager.h
+++ b/TAO/tests/POA/On_Demand_Loading/Servant_Manager.h
@@ -1,21 +1,18 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-
-//================================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Servant_Manager.h
-//
-// = DESCRIPTION
-// Helper class for <ServantActivator_i> and <ServantLoactor_i>.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//==================================================================================
+
+//=============================================================================
+/**
+ * @file Servant_Manager.h
+ *
+ * $Id$
+ *
+ * Helper class for <ServantActivator_i> and <ServantLoactor_i>.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef SERVANT_MANAGER_H
#define SERVANT_MANAGER_H
@@ -34,68 +31,75 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ServantManager_i
+ *
+ * @brief This class is the helper class for the ServantActivator_i and
+ * ServantLocator_i classes.
+ *
+ * The methods provided by this class are used by the ServantActivator_i
+ * and ServantLocator_i classes. This class contains the common methods
+ * needed by them.
+ */
class ServantManager_i
{
- // = TITLE
- // This class is the helper class for the ServantActivator_i and
- // ServantLocator_i classes.
- //
- // = DESCRIPTION
- // The methods provided by this class are used by the ServantActivator_i
- // and ServantLocator_i classes. This class contains the common methods
- // needed by them.
- //
public:
+ /// This typedef is used to typecast the void* obtained when finding
+ /// a symbol in the DLL.
typedef PortableServer::Servant
(*SERVANT_FACTORY) (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // This typedef is used to typecast the void* obtained when finding
- // a symbol in the DLL.
+ /// Initialization.
ServantManager_i (CORBA::ORB_ptr orb);
- // Initialization.
+ /// Destruction.
~ServantManager_i (void);
- // Destruction.
+ /**
+ * Returns an ObjectId when given an DLL name and the factory method
+ * to be invoked in the DLL. The application developer can initialise the
+ * ServantActivator object by providing the dllname and the factory function.
+ */
PortableServer::ObjectId_var create_dll_object_id (const char *libname,
const char *factory_function);
- // Returns an ObjectId when given an DLL name and the factory method
- // to be invoked in the DLL. The application developer can initialise the
- // ServantActivator object by providing the dllname and the factory function.
// @@ *done*Kirthika, please explain what this function is USED for, i.e.,
// who calls it and why?
+ /**
+ * Obtains a servant on activation by linking and loading the
+ * appropriate DLL and creating the servant object. The <str>
+ * argument is the ObjectId that contains the servant DLL name and
+ * the factory function name. The <long> argument is an
+ * servant-specific argument needed to create the servant for this
+ * particular use-case.
+ */
PortableServer::Servant obtain_servant (const ACE_TCHAR *str,
PortableServer::POA_ptr poa);
- // Obtains a servant on activation by linking and loading the
- // appropriate DLL and creating the servant object. The <str>
- // argument is the ObjectId that contains the servant DLL name and
- // the factory function name. The <long> argument is an
- // servant-specific argument needed to create the servant for this
- // particular use-case.
+ /// The servant is destroyed and the DLL that was dynamically linked
+ /// is closed.
void destroy_servant (PortableServer::Servant servant,
const PortableServer::ObjectId &oid);
- // The servant is destroyed and the DLL that was dynamically linked
- // is closed.
private:
+ /**
+ * Parse the string to obtain the DLL name and the factory function
+ * symbol that we will used to dynamically obtain the servant
+ * pointer.
+ */
void parse_string (const ACE_TCHAR *s);
- // Parse the string to obtain the DLL name and the factory function
- // symbol that we will used to dynamically obtain the servant
- // pointer.
+ /// A reference to the ORB.
CORBA::ORB_var orb_;
- // A reference to the ORB.
+ /// The name of the dll containing the servant.
ACE_TString dllname_;
- // The name of the dll containing the servant.
+ /// The symbol which on getting invoked will give us the servant
+ /// pointer.
ACE_TString create_symbol_;
- // The symbol which on getting invoked will give us the servant
- // pointer.
typedef ACE_Hash_Map_Manager_Ex<PortableServer::ObjectId,
ACE_DLL *,
@@ -104,10 +108,12 @@ public:
ACE_Null_Mutex>
SERVANT_MAP;
+ /**
+ * This is the hash map object. The hash map is used to provide
+ * an quick access to the dll object associated with every servant
+ * using the unique ObjectId as key.
+ */
SERVANT_MAP servant_map_;
- // This is the hash map object. The hash map is used to provide
- // an quick access to the dll object associated with every servant
- // using the unique ObjectId as key.
};
#endif /* SERVANT_MANAGER_H */
diff --git a/TAO/tests/POA/On_Demand_Loading/Server_Manager.h b/TAO/tests/POA/On_Demand_Loading/Server_Manager.h
index 21e8a733bf2..2aa642ce766 100644
--- a/TAO/tests/POA/On_Demand_Loading/Server_Manager.h
+++ b/TAO/tests/POA/On_Demand_Loading/Server_Manager.h
@@ -1,102 +1,103 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
//=============================================================================
-//
-// = LIBRARY
-// TAO/examples/POA/On_Demand_Loading
-//
-// = FILENAME
-// Server_Manager.h
-//
-// = DESCRIPTION
-// Helper class for the server application.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
+/**
+ * @file Server_Manager.h
+ *
+ * $Id$
+ *
+ * Helper class for the server application.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
//=============================================================================
+
#ifndef SERVER_MANAGER_H
#define SERVER_MANAGER_H
#include "Servant_Activator.h"
#include "Servant_Locator.h"
+/**
+ * @class Server_i
+ *
+ * @brief This class provides the server application with helper methods
+ *
+ * The various methods required by the server application for
+ * utilizing the ServantActivator and ServantLocator interfaces of
+ * the Servant Manager are implemented by this class. These
+ * include initialisation procedures of the ServantActivator and
+ * ServantLocator, and creation of POAs with emphasis on the
+ * servant retention policy.
+ */
class Server_i
{
- // = TITLE
- // This class provides the server application with helper methods
- //
- // = DESCRIPTION
- // The various methods required by the server application for
- // utilizing the ServantActivator and ServantLocator interfaces of
- // the Servant Manager are implemented by this class. These
- // include initialisation procedures of the ServantActivator and
- // ServantLocator, and creation of POAs with emphasis on the
- // servant retention policy.
public:
// = Initialization and termination methods.
+ /// Initialisation.
Server_i (void);
- // Initialisation.
+ /// Destruction.
~Server_i (void);
- // Destruction.
+ /// Initialisation of the ORB and poa.
int init (int argc, ACE_TCHAR **argv);
- // Initialisation of the ORB and poa.
+ /**
+ * This method creates a POA from the root_poa with emphasis being
+ * on the servant_retention_policy which decides the use of the
+ * ServantActivator or ServantLocator interfaces. The
+ * servent_retention_policy value is 1 for the RETAIN policy and 0
+ * for the NONRETAIN policy.
+ */
PortableServer::POA_ptr create_poa (const char* name,
int servant_retention_policy);
- // This method creates a POA from the root_poa with emphasis being
- // on the servant_retention_policy which decides the use of the
- // ServantActivator or ServantLocator interfaces. The
- // servent_retention_policy value is 1 for the RETAIN policy and 0
- // for the NONRETAIN policy.
+ /// A ServantActivator object is created and initialised.
int create_activator (PortableServer::POA_var first_poa);
- // A ServantActivator object is created and initialised.
+ /// A ServantActivator object is created and initialised.
int create_locator (PortableServer::POA_var second_poa);
- // A ServantActivator object is created and initialised.
+ /// The server is executed.
int run (void);
- // The server is executed.
private:
+ /// Parses the input arguments.
int parse_args (int argc, ACE_TCHAR **argv);
- // Parses the input arguments.
+ /// The IORs are written to a file for future use.
int write_iors_to_file (const char *first_ior,
const char *second_ior);
- // The IORs are written to a file for future use.
+ /// Default ior file.
ACE_TCHAR *ior_output_file_;
- // Default ior file.
+ /// The orb pointer.
CORBA::ORB_var orb_;
- // The orb pointer.
+ /// The poa policicies.
CORBA::PolicyList policies_;
- // The poa policicies.
+ /// The root_poa which is used for cretaing different child poas.
PortableServer::POA_var root_poa_;
- // The root_poa which is used for cretaing different child poas.
+ /// The poa_manager object.
PortableServer::POAManager_var poa_manager_;
- // The poa_manager object.
+ /// The object pointer used by the ServantActivator.
CORBA::Object_var first_test_;
- // The object pointer used by the ServantActivator.
+ /// The object pointer used by the Servant Locator.
CORBA::Object_var second_test_;
- // The object pointer used by the Servant Locator.
+ /// The servant activator object.
ServantActivator_i *servant_activator_impl_;
- // The servant activator object.
+ /// The servant locator object.
ServantLocator_i *servant_locator_impl_;
- // The servant locator object.
};
#endif /* SERVER_MANAGER_H */
diff --git a/TAO/tests/POA/On_Demand_Loading/server.cpp b/TAO/tests/POA/On_Demand_Loading/server.cpp
index 87bac3179a6..809eccba1fa 100644
--- a/TAO/tests/POA/On_Demand_Loading/server.cpp
+++ b/TAO/tests/POA/On_Demand_Loading/server.cpp
@@ -1,17 +1,17 @@
-// $Id$
-//============================================================================
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// Server application to test the Servant Activator and Servant Locator.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * Server application to test the Servant Activator and Servant Locator.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "Server_Manager.h"
diff --git a/TAO/tests/POA/POAManagerFactory/POAManagerFactory.cpp b/TAO/tests/POA/POAManagerFactory/POAManagerFactory.cpp
index e0363485974..478e8a81e27 100644
--- a/TAO/tests/POA/POAManagerFactory/POAManagerFactory.cpp
+++ b/TAO/tests/POA/POAManagerFactory/POAManagerFactory.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/POAManagerFactory
-//
-// = FILENAME
-// POAManagerFactory.cpp
-//
-// = DESCRIPTION
-// This program tests Root_POA::the_POAManagerFactory and
-// the POAManagerFactory interfaces such as create_POAManager(),
-// list () and find ().
-//
-// = AUTHOR
-// Yan Dai
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file POAManagerFactory.cpp
+ *
+ * $Id$
+ *
+ * This program tests Root_POA::the_POAManagerFactory and
+ * the POAManagerFactory interfaces such as create_POAManager(),
+ * list () and find ().
+ *
+ *
+ * @author Yan Dai
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/AnyTypeCode/Any.h"
diff --git a/TAO/tests/POA/POA_BiDir/POA_BiDir.cpp b/TAO/tests/POA/POA_BiDir/POA_BiDir.cpp
index f0c0cf2ae87..2fd60b0a6e6 100644
--- a/TAO/tests/POA/POA_BiDir/POA_BiDir.cpp
+++ b/TAO/tests/POA/POA_BiDir/POA_BiDir.cpp
@@ -1,20 +1,19 @@
-// $Id$
-
-// ==========================================================================
-// = LIBRARY
-// TAO/example/POA/POA_BiDir
-//
-// = FILENAME
-// POA_BiDir.cpp
-//
-// = DESCRIPTION
-// This program is an extension of $TAO_ROOT/example/POA/NewPOA. In
-// the many POA's created this example adds a BiDirGIOP policy to
-// one of the POA's.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-// ========================================================================
+
+//=============================================================================
+/**
+ * @file POA_BiDir.cpp
+ *
+ * $Id$
+ *
+ * This program is an extension of $TAO_ROOT/example/POA/NewPOA. In
+ * the many POA's created this example adds a BiDirGIOP policy to
+ * one of the POA's.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/POA/POA_Destruction/POA_Destruction.cpp b/TAO/tests/POA/POA_Destruction/POA_Destruction.cpp
index 46efabbc309..38df305afdb 100644
--- a/TAO/tests/POA/POA_Destruction/POA_Destruction.cpp
+++ b/TAO/tests/POA/POA_Destruction/POA_Destruction.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/POA_Destruction
-//
-// = FILENAME
-// POA_Destruction.cpp
-//
-// = DESCRIPTION
-// This program tests the destruction of a POA while there is an
-// upcall in progress.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file POA_Destruction.cpp
+ *
+ * $Id$
+ *
+ * This program tests the destruction of a POA while there is an
+ * upcall in progress.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
diff --git a/TAO/tests/POA/Persistent_ID/client.cpp b/TAO/tests/POA/Persistent_ID/client.cpp
index 136db7d10fb..ce3e525ea0c 100644
--- a/TAO/tests/POA/Persistent_ID/client.cpp
+++ b/TAO/tests/POA/Persistent_ID/client.cpp
@@ -1,18 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a client implementation.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a client implementation.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "testC.h"
diff --git a/TAO/tests/POA/Persistent_ID/server.cpp b/TAO/tests/POA/Persistent_ID/server.cpp
index c7983c80a58..4ec3caaa473 100644
--- a/TAO/tests/POA/Persistent_ID/server.cpp
+++ b/TAO/tests/POA/Persistent_ID/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Persistent_ID
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// In this example of using Persistent IDs.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * In this example of using Persistent IDs.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/SString.h"
@@ -32,8 +29,8 @@ public:
void method (void);
//FUZZ: disable check_for_lack_ACE_OS
+ ///FUZZ: enable check_for_lack_ACE_OS
void shutdown (void);
- //FUZZ: enable check_for_lack_ACE_OS
test_ptr create_POA (void);
diff --git a/TAO/tests/POA/Policies/Policies.cpp b/TAO/tests/POA/Policies/Policies.cpp
index d1a228faa12..38751511447 100644
--- a/TAO/tests/POA/Policies/Policies.cpp
+++ b/TAO/tests/POA/Policies/Policies.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Policies
-//
-// = FILENAME
-// Policies.cpp
-//
-// = DESCRIPTION
-// This program tests the construction of POA policies, both
-// through the generic ORB::create_policy interface and the
-// PortableServer specific interfaces.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Policies.cpp
+ *
+ * $Id$
+ *
+ * This program tests the construction of POA policies, both
+ * through the generic ORB::create_policy interface and the
+ * PortableServer specific interfaces.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/AnyTypeCode/Any.h"
diff --git a/TAO/tests/POA/Reference_Counted_Servant/server.cpp b/TAO/tests/POA/Reference_Counted_Servant/server.cpp
index 872efdd678a..73ec73fae99 100644
--- a/TAO/tests/POA/Reference_Counted_Servant/server.cpp
+++ b/TAO/tests/POA/Reference_Counted_Servant/server.cpp
@@ -1,23 +1,20 @@
-// $Id$
-
-// ================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Reference_Counted_Servant
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This example shows how to use reference counted servants to
-// automatically manage dynamic memory for servants.
-// Stubs/Skeletons and client code is available in
-// ../Generic_Servant.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This example shows how to use reference counted servants to
+ * automatically manage dynamic memory for servants.
+ * Stubs/Skeletons and client code is available in
+ * ../Generic_Servant.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "test_i.h"
@@ -34,9 +31,9 @@ class reference_counted_test_i :
public virtual test_i
{
public:
+ /// Constructor - takes a POA and a value parameter
reference_counted_test_i (CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa);
- // Constructor - takes a POA and a value parameter
};
reference_counted_test_i::reference_counted_test_i (CORBA::ORB_ptr orb,
diff --git a/TAO/tests/POA/RootPOA/RootPOA.cpp b/TAO/tests/POA/RootPOA/RootPOA.cpp
index 0ef28b67e72..be973d012ad 100644
--- a/TAO/tests/POA/RootPOA/RootPOA.cpp
+++ b/TAO/tests/POA/RootPOA/RootPOA.cpp
@@ -1,22 +1,18 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/RootPOA
-//
-//
-// = FILENAME
-// RootPOA.cpp
-//
-// = DESCRIPTION
-// This program gets the name of the Root POA and prints it out on
-// the standard output.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file RootPOA.cpp
+ *
+ * $Id$
+ *
+ * This program gets the name of the Root POA and prints it out on
+ * the standard output.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/PortableServer/PortableServer.h"
diff --git a/TAO/tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp b/TAO/tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp
index 80da9e7ac83..504889b7319 100644
--- a/TAO/tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp
+++ b/TAO/tests/POA/Single_Threaded_POA/Single_Threaded_POA.cpp
@@ -1,23 +1,20 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/Single_Threaded_POA
-//
-// = FILENAME
-// Single_Threaded_POA.cpp
-//
-// = DESCRIPTION
-// This program tests to make sure that two threads cannot call
-// servants in a single threaded POA simultaneously. At the same
-// time, it makes sure that a servant can call itself or other
-// servants in the same POA while in an upcall.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Single_Threaded_POA.cpp
+ *
+ * $Id$
+ *
+ * This program tests to make sure that two threads cannot call
+ * servants in a single threaded POA simultaneously. At the same
+ * time, it makes sure that a servant can call itself or other
+ * servants in the same POA while in an upcall.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Task.h"
diff --git a/TAO/tests/POA/TIE/client.cpp b/TAO/tests/POA/TIE/client.cpp
index a27ecab5cd2..c572f480427 100644
--- a/TAO/tests/POA/TIE/client.cpp
+++ b/TAO/tests/POA/TIE/client.cpp
@@ -1,18 +1,17 @@
-// $Id$
-
-//===========================================================================
-//
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a simple client implementation.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//===========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a simple client implementation.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/streams.h"
#include "ace/Get_Opt.h"
diff --git a/TAO/tests/POA/TIE/server.cpp b/TAO/tests/POA/TIE/server.cpp
index cf1d3a368b8..95491670ee4 100644
--- a/TAO/tests/POA/TIE/server.cpp
+++ b/TAO/tests/POA/TIE/server.cpp
@@ -1,18 +1,17 @@
-// $Id$
-
-// =========================================================================
-// = LIBRARY
-// TAO/tests/POA/TIE
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// In this example,
-//
-// = AUTHOR
-// Irfan Pyarali
-// =========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * In this example,
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/streams.h"
#include "ace/SString.h"
diff --git a/TAO/tests/POA/TIE/test_i.cpp b/TAO/tests/POA/TIE/test_i.cpp
index 4091bd8e9e7..016e58330fa 100644
--- a/TAO/tests/POA/TIE/test_i.cpp
+++ b/TAO/tests/POA/TIE/test_i.cpp
@@ -1,18 +1,17 @@
-// $Id$
-//===========================================================================
-//
-//
-// = FILENAME
-// test_i.cpp
-//
-// = DESCRIPTION
-// This is a simple test servant implementation
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//===========================================================================
+//=============================================================================
+/**
+ * @file test_i.cpp
+ *
+ * $Id$
+ *
+ * This is a simple test servant implementation
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "test_i.h"
diff --git a/TAO/tests/POA/TIE/test_i.h b/TAO/tests/POA/TIE/test_i.h
index 3450c129f8a..534b44c29f5 100644
--- a/TAO/tests/POA/TIE/test_i.h
+++ b/TAO/tests/POA/TIE/test_i.h
@@ -1,20 +1,19 @@
// -*- C++ -*-
-//
-// $Id$
//=============================================================================
-//
-// = FILENAME
-// test_i.h
-//
-// = DESCRIPTION
-// Defines implementation classes for the interfaces
-//
-// = AUTHOR
-// Irfan Pyarali
-//
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * Defines implementation classes for the interfaces
+ *
+ *
+ * @author Irfan Pyarali
+ */
//=============================================================================
+
#include "testS.h"
class Tie_i
@@ -51,8 +50,8 @@ protected:
CORBA::Long value_;
+ /// Default poa associated with this servant
PortableServer::POA_var poa_;
- // Default poa associated with this servant
};
class Outer_i
@@ -76,8 +75,8 @@ public:
CORBA::Long value_;
+ /// Default poa associated with this servant
PortableServer::POA_var poa_;
- // Default poa associated with this servant
};
class Inner_i
@@ -101,8 +100,8 @@ public:
CORBA::Long value_;
+ /// Default poa associated with this servant
PortableServer::POA_var poa_;
- // Default poa associated with this servant
};
};
};
diff --git a/TAO/tests/POA/wait_for_completion/wait_for_completion.cpp b/TAO/tests/POA/wait_for_completion/wait_for_completion.cpp
index c91fbc51fc9..c4a9224f105 100644
--- a/TAO/tests/POA/wait_for_completion/wait_for_completion.cpp
+++ b/TAO/tests/POA/wait_for_completion/wait_for_completion.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/POA/wait_for_completion
-//
-// = FILENAME
-// wait_for_completion.cpp
-//
-// = DESCRIPTION
-// This program tests the wait_for_completion feature of a POA.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file wait_for_completion.cpp
+ *
+ * $Id$
+ *
+ * This program tests the wait_for_completion feature of a POA.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testS.h"
diff --git a/TAO/tests/Param_Test/any.cpp b/TAO/tests/Param_Test/any.cpp
index ff7a8d498be..31468c2ceee 100644
--- a/TAO/tests/Param_Test/any.cpp
+++ b/TAO/tests/Param_Test/any.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// any.cpp
-//
-// = DESCRIPTION
-// tests Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file any.cpp
+ *
+ * $Id$
+ *
+ * tests Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "any.h"
diff --git a/TAO/tests/Param_Test/any.h b/TAO/tests/Param_Test/any.h
index 45358671fc4..5f999f95bfc 100644
--- a/TAO/tests/Param_Test/any.h
+++ b/TAO/tests/Param_Test/any.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// any.h
-//
-// = DESCRIPTION
-// Tests Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file any.h
+ *
+ * $Id$
+ *
+ * Tests Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_ANY_H
#define PARAM_TEST_ANY_H
@@ -27,11 +24,11 @@
class Test_Any
{
public:
+ /// ctor
Test_Any (void);
- // ctor
+ /// dtor
~Test_Any (void);
- // dtor
enum
{
@@ -47,51 +44,51 @@ public:
ANY_LAST_TEST_ITEM
};
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// Coffee object used to test Any with object.
Coffee_var cobj_;
- // Coffee object used to test Any with object.
+ /// test counter.
static size_t counter;
- // test counter.
+ /// in parameter
CORBA::Any in_;
- // in parameter
+ /// inout parameter
CORBA::Any inout_;
- // inout parameter
+ /// out parameter
CORBA::Any_var out_;
- // out parameter
+ /// return value
CORBA::Any_var ret_;
- // return value
};
#endif /* PARAM_TEST_ANY_H */
diff --git a/TAO/tests/Param_Test/anyop.cpp b/TAO/tests/Param_Test/anyop.cpp
index 85f7b07c264..34ca7c57376 100644
--- a/TAO/tests/Param_Test/anyop.cpp
+++ b/TAO/tests/Param_Test/anyop.cpp
@@ -1,19 +1,16 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// anyop.cpp
-//
-// = DESCRIPTION
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file anyop.cpp
+ *
+ * $Id$
+ *
+ * @brief
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "param_testC.h"
diff --git a/TAO/tests/Param_Test/bd_array_seq.cpp b/TAO/tests/Param_Test/bd_array_seq.cpp
index d66dad62149..b394fcad4a2 100644
--- a/TAO/tests/Param_Test/bd_array_seq.cpp
+++ b/TAO/tests/Param_Test/bd_array_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_array_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded array sequences
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_array_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded array sequences
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_array_seq.h"
diff --git a/TAO/tests/Param_Test/bd_array_seq.h b/TAO/tests/Param_Test/bd_array_seq.h
index 5c0c29c5e0f..1cbb42e1129 100644
--- a/TAO/tests/Param_Test/bd_array_seq.h
+++ b/TAO/tests/Param_Test/bd_array_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_array_seq.h
-//
-// = DESCRIPTION
-// Tests bounded array sequence
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_array_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded array sequence
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_ARRAY_SEQUENCE_H
#define PARAM_TEST_BOUNDED_ARRAY_SEQUENCE_H
@@ -28,60 +25,60 @@
class Test_Bounded_Array_Sequence
{
public:
+ /// ctor
Test_Bounded_Array_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_Array_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::Bounded_ArraySeq &s1,
const Param_Test::Bounded_ArraySeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::Bounded_ArraySeq &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_ArraySeq in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Bounded_ArraySeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_ArraySeq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_ArraySeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_ARRAY_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_long_seq.cpp b/TAO/tests/Param_Test/bd_long_seq.cpp
index 07f06dbe373..5b047e073b0 100644
--- a/TAO/tests/Param_Test/bd_long_seq.cpp
+++ b/TAO/tests/Param_Test/bd_long_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_long_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded long sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_long_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded long sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_long_seq.h"
diff --git a/TAO/tests/Param_Test/bd_long_seq.h b/TAO/tests/Param_Test/bd_long_seq.h
index caaae1236e3..aa2978f6f4d 100644
--- a/TAO/tests/Param_Test/bd_long_seq.h
+++ b/TAO/tests/Param_Test/bd_long_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_long_seq.h
-//
-// = DESCRIPTION
-// Tests bounded long sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_long_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded long sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_LONG_SEQUENCE_H
#define PARAM_TEST_BOUNDED_LONG_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Bounded_Long_Sequence
{
public:
+ /// ctor
Test_Bounded_Long_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_Long_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_Long_Seq_var in_;
- // in parameter
+ /// inout parameter
Param_Test::Bounded_Long_Seq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_Long_Seq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_Long_Seq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_LONG_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_short_seq.cpp b/TAO/tests/Param_Test/bd_short_seq.cpp
index 5b207561047..08899259432 100644
--- a/TAO/tests/Param_Test/bd_short_seq.cpp
+++ b/TAO/tests/Param_Test/bd_short_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_short_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded short sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_short_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded short sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_short_seq.h"
diff --git a/TAO/tests/Param_Test/bd_short_seq.h b/TAO/tests/Param_Test/bd_short_seq.h
index 9794e21de32..1ca0b16bc65 100644
--- a/TAO/tests/Param_Test/bd_short_seq.h
+++ b/TAO/tests/Param_Test/bd_short_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_short_seq.h
-//
-// = DESCRIPTION
-// Tests bounded short sequence
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_short_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded short sequence
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_SHORT_SEQUENCE_H
#define PARAM_TEST_BOUNDED_SHORT_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Bounded_Short_Sequence
{
public:
+ /// ctor
Test_Bounded_Short_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_Short_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_Short_Seq_var in_;
- // in parameter
+ /// inout parameter
Param_Test::Bounded_Short_Seq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_Short_Seq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_Short_Seq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_SHORT_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_str_seq.cpp b/TAO/tests/Param_Test/bd_str_seq.cpp
index 237d57eff85..b6bab477d37 100644
--- a/TAO/tests/Param_Test/bd_str_seq.cpp
+++ b/TAO/tests/Param_Test/bd_str_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_str_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded string sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_str_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded string sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_str_seq.h"
diff --git a/TAO/tests/Param_Test/bd_str_seq.h b/TAO/tests/Param_Test/bd_str_seq.h
index 2abe9954fb6..9e9994fefab 100644
--- a/TAO/tests/Param_Test/bd_str_seq.h
+++ b/TAO/tests/Param_Test/bd_str_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_str_seq.h
-//
-// = DESCRIPTION
-// Tests bounded sequences of strings
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_str_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded sequences of strings
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_STRING_SEQUENCE_H
#define PARAM_TEST_BOUNDED_STRING_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Bounded_String_Sequence
{
public:
+ /// ctor
Test_Bounded_String_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_String_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_StrSeq_var in_;
- // in parameter
+ /// inout parameter
Param_Test::Bounded_StrSeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_StrSeq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_StrSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_STRING_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_string.cpp b/TAO/tests/Param_Test/bd_string.cpp
index ab03ecd1557..ace0459c1a9 100644
--- a/TAO/tests/Param_Test/bd_string.cpp
+++ b/TAO/tests/Param_Test/bd_string.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_string.cpp
-//
-// = DESCRIPTION
-// tests bounded strings
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_string.cpp
+ *
+ * $Id$
+ *
+ * tests bounded strings
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_string.h"
diff --git a/TAO/tests/Param_Test/bd_string.h b/TAO/tests/Param_Test/bd_string.h
index 8019f18aecb..156dea3e0a2 100644
--- a/TAO/tests/Param_Test/bd_string.h
+++ b/TAO/tests/Param_Test/bd_string.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_string.h
-//
-// = DESCRIPTION
-// Tests bounded string
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_string.h
+ *
+ * $Id$
+ *
+ * Tests bounded string
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_STRING_H
#define PARAM_TEST_BOUNDED_STRING_H
@@ -27,51 +24,51 @@
class Test_Bounded_String
{
public:
+ /// ctor
Test_Bounded_String (void);
- // ctor
+ /// dtor
~Test_Bounded_String (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
char *in_;
- // in parameter
+ /// inout parameter
char *inout_;
- // inout parameter
+ /// out parameter
char *out_;
- // out parameter
+ /// return value
char *ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_STRING_H */
diff --git a/TAO/tests/Param_Test/bd_struct_seq.cpp b/TAO/tests/Param_Test/bd_struct_seq.cpp
index 105fa20143f..2e7aa0cc9d5 100644
--- a/TAO/tests/Param_Test/bd_struct_seq.cpp
+++ b/TAO/tests/Param_Test/bd_struct_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_struct_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded struct sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_struct_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded struct sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_struct_seq.h"
diff --git a/TAO/tests/Param_Test/bd_struct_seq.h b/TAO/tests/Param_Test/bd_struct_seq.h
index dc640977d8f..576fde32ae7 100644
--- a/TAO/tests/Param_Test/bd_struct_seq.h
+++ b/TAO/tests/Param_Test/bd_struct_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_struct_seq.h
-//
-// = DESCRIPTION
-// Tests bounded struct sequence
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_struct_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded struct sequence
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_STRUCT_SEQUENCE_H
#define PARAM_TEST_BOUNDED_STRUCT_SEQUENCE_H
@@ -28,60 +25,60 @@
class Test_Bounded_Struct_Sequence
{
public:
+ /// ctor
Test_Bounded_Struct_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_Struct_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::Bounded_StructSeq &s1,
const Param_Test::Bounded_StructSeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::Bounded_StructSeq &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_StructSeq in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Bounded_StructSeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_StructSeq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_StructSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_STRUCT_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_wstr_seq.cpp b/TAO/tests/Param_Test/bd_wstr_seq.cpp
index b390aa1e5b3..49542b3a0a1 100644
--- a/TAO/tests/Param_Test/bd_wstr_seq.cpp
+++ b/TAO/tests/Param_Test/bd_wstr_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_wstr_seq.cpp
-//
-// = DESCRIPTION
-// tests bounded wide string sequences
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_wstr_seq.cpp
+ *
+ * $Id$
+ *
+ * tests bounded wide string sequences
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_wstr_seq.h"
diff --git a/TAO/tests/Param_Test/bd_wstr_seq.h b/TAO/tests/Param_Test/bd_wstr_seq.h
index 0f0c6b9f7e6..1cec415071e 100644
--- a/TAO/tests/Param_Test/bd_wstr_seq.h
+++ b/TAO/tests/Param_Test/bd_wstr_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_wstr_seq.h
-//
-// = DESCRIPTION
-// Tests bounded sequences of wide strings
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_wstr_seq.h
+ *
+ * $Id$
+ *
+ * Tests bounded sequences of wide strings
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_WSTRING_SEQUENCE_H
#define PARAM_TEST_BOUNDED_WSTRING_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Bounded_WString_Sequence
{
public:
+ /// ctor
Test_Bounded_WString_Sequence (void);
- // ctor
+ /// dtor
~Test_Bounded_WString_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Bounded_WStrSeq_var in_;
- // in parameter
+ /// inout parameter
Param_Test::Bounded_WStrSeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Bounded_WStrSeq_var out_;
- // out parameter
+ /// return value
Param_Test::Bounded_WStrSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_WSTRING_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/bd_wstring.cpp b/TAO/tests/Param_Test/bd_wstring.cpp
index 190e0bc0e06..3f99a121445 100644
--- a/TAO/tests/Param_Test/bd_wstring.cpp
+++ b/TAO/tests/Param_Test/bd_wstring.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_wstring.cpp
-//
-// = DESCRIPTION
-// tests bounded wide strings
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_wstring.cpp
+ *
+ * $Id$
+ *
+ * tests bounded wide strings
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "helper.h"
#include "bd_wstring.h"
diff --git a/TAO/tests/Param_Test/bd_wstring.h b/TAO/tests/Param_Test/bd_wstring.h
index 4e7719f272a..ae10a6f65d6 100644
--- a/TAO/tests/Param_Test/bd_wstring.h
+++ b/TAO/tests/Param_Test/bd_wstring.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// bd_wstring.h
-//
-// = DESCRIPTION
-// Tests bounded wide string
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file bd_wstring.h
+ *
+ * $Id$
+ *
+ * Tests bounded wide string
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BOUNDED_WSTRING_H
#define PARAM_TEST_BOUNDED_WSTRING_H
@@ -27,51 +24,51 @@
class Test_Bounded_WString
{
public:
+ /// ctor
Test_Bounded_WString (void);
- // ctor
+ /// dtor
~Test_Bounded_WString (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::WChar *in_;
- // in parameter
+ /// inout parameter
CORBA::WChar *inout_;
- // inout parameter
+ /// out parameter
CORBA::WChar *out_;
- // out parameter
+ /// return value
CORBA::WChar *ret_;
- // return value
};
#endif /* PARAM_TEST_BOUNDED_WSTRING_H */
diff --git a/TAO/tests/Param_Test/big_union.cpp b/TAO/tests/Param_Test/big_union.cpp
index 95957f37815..929acbbe2bd 100644
--- a/TAO/tests/Param_Test/big_union.cpp
+++ b/TAO/tests/Param_Test/big_union.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// big_union.cpp
-//
-// = DESCRIPTION
-// tests Big_Unions
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file big_union.cpp
+ *
+ * $Id$
+ *
+ * tests Big_Unions
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "big_union.h"
diff --git a/TAO/tests/Param_Test/big_union.h b/TAO/tests/Param_Test/big_union.h
index fc304337279..429705fb282 100644
--- a/TAO/tests/Param_Test/big_union.h
+++ b/TAO/tests/Param_Test/big_union.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// big_union.h
-//
-// = DESCRIPTION
-// Tests Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file big_union.h
+ *
+ * $Id$
+ *
+ * Tests Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_BIG_UNION_H
#define PARAM_TEST_BIG_UNION_H
@@ -27,61 +24,61 @@
class Test_Big_Union
{
public:
+ /// ctor
Test_Big_Union (void);
- // ctor
+ /// dtor
~Test_Big_Union (void);
- // dtor
enum {
BIG_UNION_N_BRANCHES = 12
};
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// Coffee object used to test Big_Union with object.
Coffee_var cobj_;
- // Coffee object used to test Big_Union with object.
+ /// test counter.
static size_t counter;
- // test counter.
+ /// in parameter
Param_Test::Big_Union in_;
- // in parameter
+ /// inout parameter
Param_Test::Big_Union inout_;
- // inout parameter
+ /// out parameter
Param_Test::Big_Union_var out_;
- // out parameter
+ /// return value
Param_Test::Big_Union_var ret_;
- // return value
};
#endif /* PARAM_TEST_BIG_UNION_H */
diff --git a/TAO/tests/Param_Test/client.cpp b/TAO/tests/Param_Test/client.cpp
index 21e69f30770..1745c426aa7 100644
--- a/TAO/tests/Param_Test/client.cpp
+++ b/TAO/tests/Param_Test/client.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This file contains the implementation of the client-side of the
-// Param_Test application.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This file contains the implementation of the client-side of the
+ * Param_Test application.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef CLIENT_CPP
#define CLIENT_CPP
diff --git a/TAO/tests/Param_Test/client.h b/TAO/tests/Param_Test/client.h
index 8e9e0ec58d7..05bcee0d1e0 100644
--- a/TAO/tests/Param_Test/client.h
+++ b/TAO/tests/Param_Test/client.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// client.h
-//
-// = DESCRIPTION
-// Header file for the Param_Test client application.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * Header file for the Param_Test client application.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_CLIENT_H
#define PARAM_TEST_CLIENT_H
@@ -25,18 +21,20 @@
#include "param_testC.h"
#include "results.h"
+/**
+ * @class Param_Test_Client
+ *
+ * @brief Param_Test_Client
+ *
+ * This class declares an interface to run the example client for
+ * Param_Test CORBA server. All the complexity for initializing
+ * the client is hidden in the class. Just the run () interface
+ * is needed. The template class does the specific work of making
+ * the request of the desired data type
+ */
template <class T>
class Param_Test_Client
{
- // = TITLE
- // Param_Test_Client
- //
- // = DESCRIPTION
- // This class declares an interface to run the example client for
- // Param_Test CORBA server. All the complexity for initializing
- // the client is hidden in the class. Just the run () interface
- // is needed. The template class does the specific work of making
- // the request of the desired data type
public:
typedef T TEST_OBJECT;
@@ -47,24 +45,24 @@ public:
~Param_Test_Client (void);
+ /// run the SII test
int run_sii_test (void);
- // run the SII test
+ /// run the DII test
int run_dii_test (void);
- // run the DII test
private:
+ /// underlying ORB
CORBA::ORB_ptr orb_;
- // underlying ORB
+ /// param test object reference
Param_Test_ptr param_test_;
- // param test object reference
+ /// object doing the actual work
TEST_OBJECT *test_object_;
- // object doing the actual work
+ /// results
Results results_;
- // results
};
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
diff --git a/TAO/tests/Param_Test/complex_any.cpp b/TAO/tests/Param_Test/complex_any.cpp
index 90fc23de6f7..4520c5e5e31 100644
--- a/TAO/tests/Param_Test/complex_any.cpp
+++ b/TAO/tests/Param_Test/complex_any.cpp
@@ -1,20 +1,19 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// complex_any.cpp
-//
-// = DESCRIPTION
-// tests complex Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale, Jeff Parsons, Frank Buschmann
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file complex_any.cpp
+ *
+ * $Id$
+ *
+ * tests complex Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ * @author Jeff Parsons
+ * @author Frank Buschmann
+ */
+//=============================================================================
+
#include "helper.h"
#include "complex_any.h"
diff --git a/TAO/tests/Param_Test/complex_any.h b/TAO/tests/Param_Test/complex_any.h
index 7eb861c2223..2d8ed898466 100644
--- a/TAO/tests/Param_Test/complex_any.h
+++ b/TAO/tests/Param_Test/complex_any.h
@@ -1,20 +1,19 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// complex_any.h
-//
-// = DESCRIPTION
-// Tests complex Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale, Jeff Parsons, Frank Buschmann
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file complex_any.h
+ *
+ * $Id$
+ *
+ * Tests complex Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ * @author Jeff Parsons
+ * @author Frank Buschmann
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_COMPLEX_ANY_H
#define PARAM_TEST_COMPLEX_ANY_H
@@ -27,58 +26,58 @@
class Test_Complex_Any
{
public:
+ /// ctor
Test_Complex_Any (void);
- // ctor
+ /// dtor
~Test_Complex_Any (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// test counter.
static size_t counter;
- // test counter.
+ /// in parameter
CORBA::Any in_;
- // in parameter
+ /// inout parameter
CORBA::Any inout_;
- // inout parameter
+ /// out parameter
CORBA::Any_var out_;
- // out parameter
+ /// return value
CORBA::Any_var ret_;
- // return value
+ /// Compares the sequence extracted from in_ to one of the others.
CORBA::Boolean comp_engine (const CORBA::AnySeq *in_seq,
const CORBA::AnySeq *comp_seq);
- // Compares the sequence extracted from in_ to one of the others.
};
#endif /* PARAM_TEST_COMPLEX_ANY_H */
diff --git a/TAO/tests/Param_Test/driver.cpp b/TAO/tests/Param_Test/driver.cpp
index d56ccbf0d66..1217a092551 100644
--- a/TAO/tests/Param_Test/driver.cpp
+++ b/TAO/tests/Param_Test/driver.cpp
@@ -1,20 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// driver.cpp
-//
-// = DESCRIPTION
-// Driver program
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file driver.cpp
+ *
+ * $Id$
+ *
+ * Driver program
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "client.h"
#include "driver.h"
diff --git a/TAO/tests/Param_Test/driver.h b/TAO/tests/Param_Test/driver.h
index 73f054c6765..df6ab513691 100644
--- a/TAO/tests/Param_Test/driver.h
+++ b/TAO/tests/Param_Test/driver.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// driver.h
-//
-// = DESCRIPTION
-// Header file for the driver program. The driver is a singleton.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file driver.h
+ *
+ * $Id$
+ *
+ * Header file for the driver program. The driver is a singleton.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef DRIVER_H
#define DRIVER_H
@@ -23,30 +19,32 @@
#include "options.h"
#include "param_testC.h"
+/**
+ * @class Driver
+ *
+ * @brief Driver
+ *
+ * Driver program for the client
+ */
class Driver
{
- // = TITLE
- // Driver
- //
- // = DESCRIPTION
- // Driver program for the client
public:
// = Constructor and destructor.
Driver (void);
~Driver (void);
+ /// Initialize the driver object
int init (int argc, ACE_TCHAR **argv);
- // Initialize the driver object
+ /// Execute client example code.
int run (void);
- // Execute client example code.
private:
+ /// underlying ORB (we do not own it)
CORBA::ORB_var orb_;
- // underlying ORB (we do not own it)
+ /// object reference (we do not own it)
Param_Test_var objref_;
- // object reference (we do not own it)
};
#endif /* !defined */
diff --git a/TAO/tests/Param_Test/except.cpp b/TAO/tests/Param_Test/except.cpp
index fb3f66bc8eb..decc97863f3 100644
--- a/TAO/tests/Param_Test/except.cpp
+++ b/TAO/tests/Param_Test/except.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// except.cpp
-//
-// = DESCRIPTION
-// tests exception
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file except.cpp
+ *
+ * $Id$
+ *
+ * tests exception
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#include "helper.h"
#include "except.h"
diff --git a/TAO/tests/Param_Test/except.h b/TAO/tests/Param_Test/except.h
index b8bf8c3e9e4..acfd4b1d1cc 100644
--- a/TAO/tests/Param_Test/except.h
+++ b/TAO/tests/Param_Test/except.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// except.h
-//
-// = DESCRIPTION
-// Tests system and user exceptions
-//
-// = AUTHORS
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file except.h
+ *
+ * $Id$
+ *
+ * Tests system and user exceptions
+ *
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_EXCEPTION_H
#define PARAM_TEST_EXCEPTION_H
@@ -24,54 +21,54 @@
class Test_Exception
{
public:
+ /// ctor
Test_Exception (void);
- // ctor
+ /// dtor
~Test_Exception (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::ULong in_;
- // in parameter
+ /// inout parameter
CORBA::ULong inout_;
- // inout parameter
+ /// out parameter
CORBA::ULong out_;
- // out parameter
+ /// return value
CORBA::ULong ret_;
- // return value
+ /// Current iterations.
CORBA::ULong iterations_;
- // Current iterations.
};
#endif /* PARAM_TEST_EXCEPTION_H */
diff --git a/TAO/tests/Param_Test/fixed_array.cpp b/TAO/tests/Param_Test/fixed_array.cpp
index 695dec6bb4f..ebec9775c7a 100644
--- a/TAO/tests/Param_Test/fixed_array.cpp
+++ b/TAO/tests/Param_Test/fixed_array.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// fixed_array.cpp
-//
-// = DESCRIPTION
-// tests fixed size arrays
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file fixed_array.cpp
+ *
+ * $Id$
+ *
+ * tests fixed size arrays
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "fixed_array.h"
diff --git a/TAO/tests/Param_Test/fixed_array.h b/TAO/tests/Param_Test/fixed_array.h
index 4e69fe59287..ff4626a020b 100644
--- a/TAO/tests/Param_Test/fixed_array.h
+++ b/TAO/tests/Param_Test/fixed_array.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// fixed_array.h
-//
-// = DESCRIPTION
-// Tests fixed size array
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file fixed_array.h
+ *
+ * $Id$
+ *
+ * Tests fixed size array
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_FIXED_ARRAY_H
#define PARAM_TEST_FIXED_ARRAY_H
@@ -27,58 +24,58 @@
class Test_Fixed_Array
{
public:
+ /// ctor
Test_Fixed_Array (void);
- // ctor
+ /// dtor
~Test_Fixed_Array (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// compare arrays
CORBA::Boolean compare (const Param_Test::Fixed_Array_slice *a1,
const Param_Test::Fixed_Array_slice *a2);
- // compare arrays
+ /// print an array
void print (const Param_Test::Fixed_Array_slice *a);
- // print an array
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Fixed_Array in_;
- // in parameter
+ /// inout parameter
Param_Test::Fixed_Array inout_;
- // inout parameter
+ /// out parameter
Param_Test::Fixed_Array out_;
- // out parameter
+ /// return value
Param_Test::Fixed_Array_var ret_;
- // return value
};
#endif /* PARAM_TEST_FIXED_ARRAY_H */
diff --git a/TAO/tests/Param_Test/fixed_struct.cpp b/TAO/tests/Param_Test/fixed_struct.cpp
index 827e4919892..b2c4e67281b 100644
--- a/TAO/tests/Param_Test/fixed_struct.cpp
+++ b/TAO/tests/Param_Test/fixed_struct.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// fixed_struct.cpp
-//
-// = DESCRIPTION
-// tests fixed sized structs
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file fixed_struct.cpp
+ *
+ * $Id$
+ *
+ * tests fixed sized structs
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "fixed_struct.h"
diff --git a/TAO/tests/Param_Test/fixed_struct.h b/TAO/tests/Param_Test/fixed_struct.h
index 07836d0cd7e..fc4bf1115bb 100644
--- a/TAO/tests/Param_Test/fixed_struct.h
+++ b/TAO/tests/Param_Test/fixed_struct.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// fixed_struct.h
-//
-// = DESCRIPTION
-// Tests fixed size structs
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file fixed_struct.h
+ *
+ * $Id$
+ *
+ * Tests fixed size structs
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_FIXED_STRUCT_H
#define PARAM_TEST_FIXED_STRUCT_H
@@ -27,51 +24,51 @@
class Test_Fixed_Struct
{
public:
+ /// ctor
Test_Fixed_Struct (void);
- // ctor
+ /// dtor
~Test_Fixed_Struct (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Fixed_Struct in_;
- // in parameter
+ /// inout parameter
Param_Test::Fixed_Struct inout_;
- // inout parameter
+ /// out parameter
Param_Test::Fixed_Struct out_;
- // out parameter
+ /// return value
Param_Test::Fixed_Struct ret_;
- // return value
};
#endif /* PARAM_TEST_FIXED_STRUCT_H */
diff --git a/TAO/tests/Param_Test/helper.cpp b/TAO/tests/Param_Test/helper.cpp
index 649d74fed7d..2aee194703e 100644
--- a/TAO/tests/Param_Test/helper.cpp
+++ b/TAO/tests/Param_Test/helper.cpp
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// helper.cpp
-//
-// = DESCRIPTION
-// Defines a helper class that can generate values for the parameters used
-// for the Param_Test example
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file helper.cpp
+ *
+ * $Id$
+ *
+ * Defines a helper class that can generate values for the parameters used
+ * for the Param_Test example
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ace/OS_NS_ctype.h"
diff --git a/TAO/tests/Param_Test/helper.h b/TAO/tests/Param_Test/helper.h
index b8c9c8b14d0..41deb1a44e8 100644
--- a/TAO/tests/Param_Test/helper.h
+++ b/TAO/tests/Param_Test/helper.h
@@ -1,21 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// helper.h
-//
-// = DESCRIPTION
-// Defines a helper class that can generate values for the parameters used
-// for the Param_Test example
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file helper.h
+ *
+ * $Id$
+ *
+ * Defines a helper class that can generate values for the parameters used
+ * for the Param_Test example
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef HELPER_H
#define HELPER_H
@@ -27,11 +24,11 @@
class Generator
{
public:
+ /// constructor
Generator (void);
- // constructor
+ /// destructor
~Generator (void);
- // destructor
CORBA::Short gen_short (void);
CORBA::Long gen_long (void);
diff --git a/TAO/tests/Param_Test/multdim_array.cpp b/TAO/tests/Param_Test/multdim_array.cpp
index 78df23b73d2..b1aa1a8d701 100644
--- a/TAO/tests/Param_Test/multdim_array.cpp
+++ b/TAO/tests/Param_Test/multdim_array.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// multidim_array.cpp
-//
-// = DESCRIPTION
-// tests multidimensional fixed size arrays
-//
-// = AUTHORS
-// Bala
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file multidim_array.cpp
+ *
+ * $Id$
+ *
+ * tests multidimensional fixed size arrays
+ *
+ *
+ * @author Bala
+ */
+//=============================================================================
+
#include "helper.h"
#include "multdim_array.h"
diff --git a/TAO/tests/Param_Test/multdim_array.h b/TAO/tests/Param_Test/multdim_array.h
index 0539bf803e7..b275ef78145 100644
--- a/TAO/tests/Param_Test/multdim_array.h
+++ b/TAO/tests/Param_Test/multdim_array.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// multdim_array.h
-//
-// = DESCRIPTION
-// Tests multi dimensional array
-//
-// = AUTHORS
-// Bala
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file multdim_array.h
+ *
+ * $Id$
+ *
+ * Tests multi dimensional array
+ *
+ *
+ * @author Bala
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_MULTDIM_ARRAY_H
#define PARAM_TEST_MULTDIM_ARRAY_H
@@ -27,58 +24,58 @@
class Test_Multdim_Array
{
public:
+ /// ctor
Test_Multdim_Array (void);
- // ctor
+ /// dtor
~Test_Multdim_Array (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// compare arrays
CORBA::Boolean compare (const Param_Test::Multdim_Array_slice *a1,
const Param_Test::Multdim_Array_slice *a2);
- // compare arrays
+ /// print an array
void print (const Param_Test::Multdim_Array_slice *a);
- // print an array
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Multdim_Array_var in_;
- // in parameter
+ /// inout parameter
Param_Test::Multdim_Array_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Multdim_Array_var out_;
- // out parameter
+ /// return value
Param_Test::Multdim_Array_var ret_;
- // return value
};
#endif /* PARAM_TEST_MULTDIM_ARRAY_H */
diff --git a/TAO/tests/Param_Test/nested_struct.cpp b/TAO/tests/Param_Test/nested_struct.cpp
index 97c873ad215..e8a8805109e 100644
--- a/TAO/tests/Param_Test/nested_struct.cpp
+++ b/TAO/tests/Param_Test/nested_struct.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// nested_struct.cpp
-//
-// = DESCRIPTION
-// tests nested structs
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file nested_struct.cpp
+ *
+ * $Id$
+ *
+ * tests nested structs
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "nested_struct.h"
diff --git a/TAO/tests/Param_Test/nested_struct.h b/TAO/tests/Param_Test/nested_struct.h
index a22145e958c..10044dfd3e0 100644
--- a/TAO/tests/Param_Test/nested_struct.h
+++ b/TAO/tests/Param_Test/nested_struct.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// nested_struct.h
-//
-// = DESCRIPTION
-// Tests nested structures
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file nested_struct.h
+ *
+ * $Id$
+ *
+ * Tests nested structures
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_NESTED_STRUCT_H
#define PARAM_TEST_NESTED_STRUCT_H
@@ -28,52 +25,52 @@
class Test_Nested_Struct
{
public:
+ /// ctor
Test_Nested_Struct (void);
- // ctor
+ /// dtor
~Test_Nested_Struct (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Nested_Struct in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Nested_Struct_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Nested_Struct_var out_;
- // out parameter
+ /// return value
Param_Test::Nested_Struct_var ret_;
- // return value
};
#endif /* PARAM_TEST_NESTED_STRUCT_H */
diff --git a/TAO/tests/Param_Test/objref.cpp b/TAO/tests/Param_Test/objref.cpp
index d9e170c60b0..4d35cecd7ac 100644
--- a/TAO/tests/Param_Test/objref.cpp
+++ b/TAO/tests/Param_Test/objref.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// objref.cpp
-//
-// = DESCRIPTION
-// tests object references
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file objref.cpp
+ *
+ * $Id$
+ *
+ * tests object references
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "objref.h"
diff --git a/TAO/tests/Param_Test/objref.h b/TAO/tests/Param_Test/objref.h
index a6d491eb90e..bcbbc908007 100644
--- a/TAO/tests/Param_Test/objref.h
+++ b/TAO/tests/Param_Test/objref.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// objref.h
-//
-// = DESCRIPTION
-// Tests object references
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file objref.h
+ *
+ * $Id$
+ *
+ * Tests object references
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_OBJREF_H
#define PARAM_TEST_OBJREF_H
@@ -27,51 +24,51 @@
class Test_ObjRef
{
public:
+ /// ctor
Test_ObjRef (void);
- // ctor
+ /// dtor
~Test_ObjRef (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Coffee_var in_;
- // in parameter
+ /// inout parameter
Coffee_var inout_;
- // inout parameter
+ /// out parameter
Coffee_var out_;
- // out parameter
+ /// return value
Coffee_var ret_;
- // return value
};
#endif /* PARAM_TEST_OBJREF_H */
diff --git a/TAO/tests/Param_Test/objref_struct.cpp b/TAO/tests/Param_Test/objref_struct.cpp
index 96c00e84b5b..bb9bc19af57 100644
--- a/TAO/tests/Param_Test/objref_struct.cpp
+++ b/TAO/tests/Param_Test/objref_struct.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// objref_struct.cpp
-//
-// = DESCRIPTION
-// test structures containing object references.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file objref_struct.cpp
+ *
+ * $Id$
+ *
+ * test structures containing object references.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "objref_struct.h"
diff --git a/TAO/tests/Param_Test/objref_struct.h b/TAO/tests/Param_Test/objref_struct.h
index e9f7164f903..0f8335c0506 100644
--- a/TAO/tests/Param_Test/objref_struct.h
+++ b/TAO/tests/Param_Test/objref_struct.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// objref_struct.h
-//
-// = DESCRIPTION
-// Tests variable sized structures
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file objref_struct.h
+ *
+ * $Id$
+ *
+ * Tests variable sized structures
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_OBJREF_STRUCT_H
#define PARAM_TEST_OBJREF_STRUCT_H
@@ -28,52 +25,52 @@
class Test_Objref_Struct
{
public:
+ /// ctor
Test_Objref_Struct (void);
- // ctor
+ /// dtor
~Test_Objref_Struct (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Objref_Struct in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Objref_Struct_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Objref_Struct_var out_;
- // out parameter
+ /// return value
Param_Test::Objref_Struct_var ret_;
- // return value
};
#endif /* PARAM_TEST_OBJREF_STRUCT_H */
diff --git a/TAO/tests/Param_Test/options.cpp b/TAO/tests/Param_Test/options.cpp
index 95bae137fc2..1193e8a64d0 100644
--- a/TAO/tests/Param_Test/options.cpp
+++ b/TAO/tests/Param_Test/options.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// options.cpp
-//
-// = DESCRIPTION
-// Options for the Param_Test application
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file options.cpp
+ *
+ * $Id$
+ *
+ * Options for the Param_Test application
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "options.h"
#include "tao/debug.h"
diff --git a/TAO/tests/Param_Test/options.h b/TAO/tests/Param_Test/options.h
index 07ae447ca70..ca17dcba529 100644
--- a/TAO/tests/Param_Test/options.h
+++ b/TAO/tests/Param_Test/options.h
@@ -1,21 +1,17 @@
-// -*- c++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// options.h
-//
-// = DESCRIPTION
-// Options for the Param_Test application
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file options.h
+ *
+ * $Id$
+ *
+ * Options for the Param_Test application
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef OPTIONS_H
#define OPTIONS_H
@@ -80,54 +76,54 @@ public:
DII
};
+ /// constructor
Options (void);
- // constructor
+ /// destructor
~Options (void);
- // destructor
+ /// Parses the arguments passed on the command line.
int parse_args (int argc, ACE_TCHAR **argv);
- // Parses the arguments passed on the command line.
+ /// return the IOR for the servant
char const * param_test_ior (void) const;
- // return the IOR for the servant
+ /// what test to run
TEST_TYPE test_type (void);
- // what test to run
+ /// whether to use SII or DII
INVOKE_TYPE invoke_type (void);
- // whether to use SII or DII
+ /// number of times to run the test
CORBA::ULong loop_count (void);
- // number of times to run the test
+ /// whether debug option is on or not
CORBA::Boolean debug (void) const;
- // whether debug option is on or not
+ /// If we should request the server to shutdown.
CORBA::Boolean shutdown (void) const;
- // If we should request the server to shutdown.
private:
+ /// Function to read the servant IOR from a file.
int read_ior (ACE_TCHAR *filename);
- // Function to read the servant IOR from a file.
+ /// IOR for the servant
CORBA::String_var ior_;
- // IOR for the servant
+ /// what test to run
TEST_TYPE test_type_;
- // what test to run
+ /// whether SII or DII
INVOKE_TYPE invoke_type_;
- // whether SII or DII
+ /// Number of times to do the "test_*" operations.
CORBA::ULong loop_count_;
- // Number of times to do the "test_*" operations.
+ /// debugging output values
CORBA::Boolean debug_;
- // debugging output values
+ /// server shutdown flag.
CORBA::Boolean shutdown_;
- // server shutdown flag.
};
typedef ACE_Singleton<Options, TAO_SYNCH_RECURSIVE_MUTEX> OPTIONS;
diff --git a/TAO/tests/Param_Test/param_test_i.cpp b/TAO/tests/Param_Test/param_test_i.cpp
index 4d6e31cf1b4..aa822a4f573 100644
--- a/TAO/tests/Param_Test/param_test_i.cpp
+++ b/TAO/tests/Param_Test/param_test_i.cpp
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// param_test_i.cpp
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file param_test_i.cpp
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "param_test_i.h"
diff --git a/TAO/tests/Param_Test/param_test_i.h b/TAO/tests/Param_Test/param_test_i.h
index 321df2bb9b3..478253046dd 100644
--- a/TAO/tests/Param_Test/param_test_i.h
+++ b/TAO/tests/Param_Test/param_test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// param_test_i.h
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file param_test_i.h
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_I_H
#define PARAM_TEST_I_H
@@ -23,77 +20,81 @@ class Coffee_i : public POA_Coffee
{
public:
+ /// constructor
Coffee_i (const char *name);
- // constructor
+ /// destructor
~Coffee_i (void);
- // destructor
// =methods for the attribute
+ /// get attribute
virtual Coffee::Desc * description (void);
- // get attribute
+ /// set attribute
virtual void description (const Coffee::Desc &description);
- // set attribute
private:
+ /// my description
CORBA::String_var name_;
- // my description
};
// the implementation of the Param_test interface
+/**
+ * @class Param_Test_i
+ *
+ * @brief Param_Test_i
+ *
+ * Implementation of the Param_Test test suite.
+ */
class Param_Test_i : public POA_Param_Test
{
- // = TITLE
- // Param_Test_i
- // = DESCRIPTION
- // Implementation of the Param_Test test suite.
public:
+ /// Constructor
Param_Test_i (const char *coffee_name,
CORBA::ORB_ptr orb);
- // Constructor
+ /// Destructor
~Param_Test_i (void);
- // Destructor
+ /// test for shorts
virtual CORBA::Short test_short (CORBA::Short s1,
CORBA::Short &s2,
CORBA::Short_out s3);
- // test for shorts
+ /// test for unsigned long long
virtual CORBA::ULongLong test_ulonglong (CORBA::ULongLong s1,
CORBA::ULongLong &s2,
CORBA::ULongLong_out s3);
- // test for unsigned long long
+ /// test for unbounded strings
virtual char *test_unbounded_string (const char *s1,
char *&s2,
CORBA::String_out s3);
- // test for unbounded strings
+ /// test for bounded strings
virtual char *test_bounded_string (const char *s1,
char *&s2,
CORBA::String_out s3);
- // test for bounded strings
+ /// test for unbounded wstrings
virtual CORBA::WChar *test_unbounded_wstring (const CORBA::WChar *ws1,
CORBA::WChar *&ws2,
CORBA::WString_out ws3);
- // test for unbounded wstrings
+ /// test for bounded wstrings
virtual CORBA::WChar *test_bounded_wstring (const CORBA::WChar *ws1,
CORBA::WChar *&ws2,
CORBA::WString_out ws3);
- // test for bounded wstrings
+ /// test for fixed structures
virtual Param_Test::Fixed_Struct
test_fixed_struct (const Param_Test::Fixed_Struct &s1,
Param_Test::Fixed_Struct &s2,
Param_Test::Fixed_Struct_out s3);
- // test for fixed structures
// = Start of sequences tests...
+ /// = End of sequences tests....
virtual CORBA::LongSeq * test_long_sequence (
const CORBA::LongSeq & s1,
CORBA::LongSeq & s2,
@@ -158,64 +159,63 @@ public:
const CORBA::AnySeq & s1,
CORBA::AnySeq & s2,
CORBA::AnySeq_out s3);
- // = End of sequences tests....
+ /// test for variable structs
virtual Param_Test::Var_Struct *
test_var_struct (const Param_Test::Var_Struct &s1,
Param_Test::Var_Struct &s2,
Param_Test::Var_Struct_out s3);
- // test for variable structs
+ /// test for nested structs
virtual Param_Test::Nested_Struct *
test_nested_struct (const Param_Test::Nested_Struct &s1,
Param_Test::Nested_Struct &s2,
Param_Test::Nested_Struct_out s3);
- // test for nested structs
+ /// test for recursive structs
virtual Param_Test::Recursive_Struct *
test_recursive_struct (const Param_Test::Recursive_Struct &rs1,
Param_Test::Recursive_Struct &rs2,
Param_Test::Recursive_Struct_out rs3);
- // test for recursive structs
virtual Param_Test::Objref_Struct *
test_objref_struct (const Param_Test::Objref_Struct &s1,
Param_Test::Objref_Struct &s2,
Param_Test::Objref_Struct_out s3);
+ /// make a coffee object
virtual Coffee_ptr
make_coffee (void);
- // make a coffee object
+ /// test for object references
virtual Coffee_ptr
test_objref (Coffee_ptr o1,
Coffee_ptr &o2,
Coffee_out o3);
- // test for object references
+ /// test for typecodes
virtual CORBA::TypeCode_ptr
test_typecode (CORBA::TypeCode_ptr t1,
CORBA::TypeCode_ptr &o2,
CORBA::TypeCode_out o3);
- // test for typecodes
+ /// test for Anys
virtual CORBA::Any *
test_any (const CORBA::Any &a1,
CORBA::Any &a2,
CORBA::Any_out a3);
- // test for Anys
+ /// test for fixed size arrays
virtual Param_Test::Fixed_Array_slice *
test_fixed_array (const Param_Test::Fixed_Array a1,
Param_Test::Fixed_Array a2,
Param_Test::Fixed_Array_out a3);
- // test for fixed size arrays
+ /// test for arrays of variable types
virtual Param_Test::Var_Array_slice *
test_var_array (const Param_Test::Var_Array a1,
Param_Test::Var_Array a2,
Param_Test::Var_Array_out a3);
- // test for arrays of variable types
virtual CORBA::ULong test_exception (CORBA::ULong s1,
CORBA::ULong& s2,
@@ -251,17 +251,19 @@ public:
private:
+ /// Remember out ORB.
CORBA::ORB_var orb_;
- // Remember out ORB.
+ /// the coffee object reference we maintain
Coffee_i obj_;
- // the coffee object reference we maintain
+ /**
+ * Called by test_exception. This will avoid the compiler
+ * warning that test_exception is throwing an exception
+ * not in its THROW_SPEC, but still test TAO's
+ * conversion of such an exception to UNKNOWN.
+ */
void throw_badboy (void);
- // Called by test_exception. This will avoid the compiler
- // warning that test_exception is throwing an exception
- // not in its THROW_SPEC, but still test TAO's
- // conversion of such an exception to UNKNOWN.
};
#endif /* PARAM_TEST_I_H */
diff --git a/TAO/tests/Param_Test/recursive_struct.cpp b/TAO/tests/Param_Test/recursive_struct.cpp
index fdf662388f0..e6bcb00611a 100644
--- a/TAO/tests/Param_Test/recursive_struct.cpp
+++ b/TAO/tests/Param_Test/recursive_struct.cpp
@@ -1,20 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// recursive_struct.cpp
-//
-// = DESCRIPTION
-// test structure that contains a sequence of itself
-//
-// = AUTHORS
-// Aniruddha Gokhale, Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file recursive_struct.cpp
+ *
+ * $Id$
+ *
+ * test structure that contains a sequence of itself
+ *
+ *
+ * @author Aniruddha Gokhale
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "recursive_struct.h"
diff --git a/TAO/tests/Param_Test/recursive_struct.h b/TAO/tests/Param_Test/recursive_struct.h
index 77d1ee7dabc..89aaf25746b 100644
--- a/TAO/tests/Param_Test/recursive_struct.h
+++ b/TAO/tests/Param_Test/recursive_struct.h
@@ -1,20 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// recursive_struct.h
-//
-// = DESCRIPTION
-// Tests a structure that contains a sequence of itself
-//
-// = AUTHORS
-// Aniruddha Gokhale, Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file recursive_struct.h
+ *
+ * $Id$
+ *
+ * Tests a structure that contains a sequence of itself
+ *
+ *
+ * @author Aniruddha Gokhale
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_RECURSIVE_STRUCT_H
#define PARAM_TEST_RECURSIVE_STRUCT_H
@@ -29,61 +27,61 @@
class Test_Recursive_Struct
{
public:
+ /// ctor
Test_Recursive_Struct (void);
- // ctor
+ /// dtor
~Test_Recursive_Struct (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Recursive_Struct in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Recursive_Struct_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Recursive_Struct_var out_;
- // out parameter
+ /// return value
Param_Test::Recursive_Struct_var ret_;
- // return value
+ /// helper function for init_parameters
void deep_init (Param_Test::Recursive_Struct &rs,
Generator *gen,
CORBA::ULong level);
- // helper function for init_parameters
+ /// helper function for check_validity
CORBA::Boolean deep_check (const Param_Test::Recursive_Struct &in_struct,
const Param_Test::Recursive_Struct &test_struct);
- // helper function for check_validity
};
#endif /* PARAM_TEST_RECURSIVE_STRUCT_H */
diff --git a/TAO/tests/Param_Test/recursive_union.cpp b/TAO/tests/Param_Test/recursive_union.cpp
index bd9497fda0f..8353cabdde8 100644
--- a/TAO/tests/Param_Test/recursive_union.cpp
+++ b/TAO/tests/Param_Test/recursive_union.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// recursive_union.cpp
-//
-// = DESCRIPTION
-// test union that contains a sequence of itself
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file recursive_union.cpp
+ *
+ * $Id$
+ *
+ * test union that contains a sequence of itself
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "recursive_union.h"
diff --git a/TAO/tests/Param_Test/recursive_union.h b/TAO/tests/Param_Test/recursive_union.h
index 6f41e85292c..995a0c49c17 100644
--- a/TAO/tests/Param_Test/recursive_union.h
+++ b/TAO/tests/Param_Test/recursive_union.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// recursive_union.h
-//
-// = DESCRIPTION
-// Tests a union that contains a sequence of itself
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file recursive_union.h
+ *
+ * $Id$
+ *
+ * Tests a union that contains a sequence of itself
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_RECURSIVE_UNION_H
#define PARAM_TEST_RECURSIVE_UNION_H
@@ -29,68 +26,68 @@
class Test_Recursive_Union
{
public:
+ /// ctor
Test_Recursive_Union (void);
- // ctor
+ /// dtor
~Test_Recursive_Union (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Recursive_Union in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Recursive_Union_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Recursive_Union_var out_;
- // out parameter
+ /// return value
Param_Test::Recursive_Union_var ret_;
- // return value
void deep_init (Param_Test::Recursive_Union &u,
Generator *gen,
CORBA::ULong level);
+ /// helper functions for init_parameters
void deep_init_nested (Param_Test::nested_rec_union &nu,
Generator *gen,
CORBA::ULong level);
- // helper functions for init_parameters
CORBA::Boolean deep_check (const Param_Test::Recursive_Union &in_union,
const Param_Test::Recursive_Union &test_union);
+ /// helper functions for check_validity
CORBA::Boolean deep_check_nested (const Param_Test::nested_rec_union &in,
const Param_Test::nested_rec_union &test);
- // helper functions for check_validity
};
#endif /* PARAM_TEST_RECURSIVE_UNION_H */
diff --git a/TAO/tests/Param_Test/results.cpp b/TAO/tests/Param_Test/results.cpp
index 14a1f8d1ab5..179a4adef02 100644
--- a/TAO/tests/Param_Test/results.cpp
+++ b/TAO/tests/Param_Test/results.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// results.cpp
-//
-// = DESCRIPTION
-// Printing the results
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file results.cpp
+ *
+ * $Id$
+ *
+ * Printing the results
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "results.h"
#include "tao/debug.h"
diff --git a/TAO/tests/Param_Test/results.h b/TAO/tests/Param_Test/results.h
index e04e26e5f3c..65c490debd4 100644
--- a/TAO/tests/Param_Test/results.h
+++ b/TAO/tests/Param_Test/results.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// results.h
-//
-// = DESCRIPTION
-// Printing the results
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file results.h
+ *
+ * $Id$
+ *
+ * Printing the results
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef RESULTS_H
#define RESULTS_H
@@ -38,51 +35,51 @@ TAO_END_VERSIONED_NAMESPACE_DECL
class Results
{
public:
+ /// ctor
Results (void);
- // ctor
+ /// destructor
~Results (void);
- // destructor
+ /// prints the time stats
void print_stats (void);
- // prints the time stats
+ /// print the exception
void print_exception (const char *call_name);
- // print the exception
+ /// start timing
void start_timer (void);
- // start timing
+ /// stop timing
void stop_timer (void);
- // stop timing
+ /// return call count
CORBA::ULong call_count (void);
- // return call count
+ /// set the call count
void call_count (CORBA::ULong);
- // set the call count
+ /// return the error count
CORBA::ULong error_count (void);
- // return the error count
+ /// set error count
void error_count (CORBA::ULong);
- // set error count
+ /// set the number of times the test will be run
void iterations (CORBA::ULong iters);
- // set the number of times the test will be run
private:
+ /// # of calls made to functions
CORBA::ULong call_count_;
- // # of calls made to functions
+ /// # of errors incurred in the lifetime of the application.
CORBA::ULong error_count_;
- // # of errors incurred in the lifetime of the application.
+ /// for timing the test
ACE_Profile_Timer timer_;
- // for timing the test
+ /// holds the elapsed time for each iteration
ACE_Profile_Timer::ACE_Elapsed_Time *elapsed_time_;
- // holds the elapsed time for each iteration
};
#endif /* RESULTS_H */
diff --git a/TAO/tests/Param_Test/server.cpp b/TAO/tests/Param_Test/server.cpp
index a0b565b900a..757cb9b435c 100644
--- a/TAO/tests/Param_Test/server.cpp
+++ b/TAO/tests/Param_Test/server.cpp
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// server.cpp
-//
-// = AUTHOR
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "param_test_i.h"
#include "tao/Codeset/Codeset.h"
diff --git a/TAO/tests/Param_Test/short.cpp b/TAO/tests/Param_Test/short.cpp
index 364f37a49c1..6bf5cacc815 100644
--- a/TAO/tests/Param_Test/short.cpp
+++ b/TAO/tests/Param_Test/short.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// short.cpp
-//
-// = DESCRIPTION
-// tests shorts
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file short.cpp
+ *
+ * $Id$
+ *
+ * tests shorts
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "short.h"
diff --git a/TAO/tests/Param_Test/short.h b/TAO/tests/Param_Test/short.h
index 2396e70663f..c4f3025a71b 100644
--- a/TAO/tests/Param_Test/short.h
+++ b/TAO/tests/Param_Test/short.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// short.h
-//
-// = DESCRIPTION
-// Tests shorts
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file short.h
+ *
+ * $Id$
+ *
+ * Tests shorts
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_SHORT_H
#define PARAM_TEST_SHORT_H
@@ -27,51 +24,51 @@
class Test_Short
{
public:
+ /// ctor
Test_Short (void);
- // ctor
+ /// dtor
~Test_Short (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::Short in_;
- // in parameter
+ /// inout parameter
CORBA::Short inout_;
- // inout parameter
+ /// out parameter
CORBA::Short out_;
- // out parameter
+ /// return value
CORBA::Short ret_;
- // return value
};
#endif /* PARAM_TEST_SHORT_H */
diff --git a/TAO/tests/Param_Test/small_union.cpp b/TAO/tests/Param_Test/small_union.cpp
index 7b94bf5c72e..173476c4041 100644
--- a/TAO/tests/Param_Test/small_union.cpp
+++ b/TAO/tests/Param_Test/small_union.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// small_union.cpp
-//
-// = DESCRIPTION
-// tests Small_Unions
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file small_union.cpp
+ *
+ * $Id$
+ *
+ * tests Small_Unions
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "small_union.h"
diff --git a/TAO/tests/Param_Test/small_union.h b/TAO/tests/Param_Test/small_union.h
index 8e3b1834cab..ad19888c6d7 100644
--- a/TAO/tests/Param_Test/small_union.h
+++ b/TAO/tests/Param_Test/small_union.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// small_union.h
-//
-// = DESCRIPTION
-// Tests Anys
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file small_union.h
+ *
+ * $Id$
+ *
+ * Tests Anys
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_SMALL_UNION_H
#define PARAM_TEST_SMALL_UNION_H
@@ -27,57 +24,57 @@
class Test_Small_Union
{
public:
+ /// ctor
Test_Small_Union (void);
- // ctor
+ /// dtor
~Test_Small_Union (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// Coffee object used to test Small_Union with object.
Coffee_var cobj_;
- // Coffee object used to test Small_Union with object.
+ /// test counter.
static size_t counter;
- // test counter.
+ /// in parameter
Param_Test::Small_Union in_;
- // in parameter
+ /// inout parameter
Param_Test::Small_Union inout_;
- // inout parameter
+ /// out parameter
Param_Test::Small_Union_var out_;
- // out parameter
+ /// return value
Param_Test::Small_Union_var ret_;
- // return value
};
#endif /* PARAM_TEST_SMALL_UNION_H */
diff --git a/TAO/tests/Param_Test/tests.h b/TAO/tests/Param_Test/tests.h
index c042cad74fa..4c1f4627ffb 100644
--- a/TAO/tests/Param_Test/tests.h
+++ b/TAO/tests/Param_Test/tests.h
@@ -1,20 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// tests.h
-//
-// = DESCRIPTION
-// All the test objects header files included here
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file tests.h
+ *
+ * $Id$
+ *
+ * All the test objects header files included here
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef TESTS_H
#define TESTS_H
diff --git a/TAO/tests/Param_Test/typecode.cpp b/TAO/tests/Param_Test/typecode.cpp
index 1261f4cdc04..4eb26c38662 100644
--- a/TAO/tests/Param_Test/typecode.cpp
+++ b/TAO/tests/Param_Test/typecode.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// typecode.cpp
-//
-// = DESCRIPTION
-// tests typecodes
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file typecode.cpp
+ *
+ * $Id$
+ *
+ * tests typecodes
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "typecode.h"
diff --git a/TAO/tests/Param_Test/typecode.h b/TAO/tests/Param_Test/typecode.h
index 1b4a2183f50..0f35979fa1f 100644
--- a/TAO/tests/Param_Test/typecode.h
+++ b/TAO/tests/Param_Test/typecode.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// typecode.h
-//
-// = DESCRIPTION
-// Tests typecodes
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file typecode.h
+ *
+ * $Id$
+ *
+ * Tests typecodes
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_TYPECODE_H
#define PARAM_TEST_TYPECODE_H
@@ -27,55 +24,55 @@
class Test_TypeCode
{
public:
+ /// ctor
Test_TypeCode (void);
- // ctor
+ /// dtor
~Test_TypeCode (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// place for selected typecode to stay during time
+ /// between init_parameters () and reset_parameters ().
CORBA::TypeCode_var tc_holder_;
- // place for selected typecode to stay during time
- // between init_parameters () and reset_parameters ().
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::TypeCode_var in_;
- // in parameter
+ /// inout parameter
CORBA::TypeCode_var inout_;
- // inout parameter
+ /// out parameter
CORBA::TypeCode_var out_;
- // out parameter
+ /// return value
CORBA::TypeCode_var ret_;
- // return value
};
#endif /* PARAM_TEST_TYPECODE_H */
diff --git a/TAO/tests/Param_Test/ub_any_seq.cpp b/TAO/tests/Param_Test/ub_any_seq.cpp
index 01a6c9bee6b..0c5b7c823b4 100644
--- a/TAO/tests/Param_Test/ub_any_seq.cpp
+++ b/TAO/tests/Param_Test/ub_any_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_any_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded Any sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_any_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded Any sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_any_seq.h"
diff --git a/TAO/tests/Param_Test/ub_any_seq.h b/TAO/tests/Param_Test/ub_any_seq.h
index c5431e8314c..4256a5e1f23 100644
--- a/TAO/tests/Param_Test/ub_any_seq.h
+++ b/TAO/tests/Param_Test/ub_any_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_any_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded Any sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_any_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded Any sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_ANY_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_ANY_SEQUENCE_H
@@ -27,59 +24,59 @@
class Test_AnySeq
{
public:
+ /// ctor
Test_AnySeq (void);
- // ctor
+ /// dtor
~Test_AnySeq (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const CORBA::AnySeq &s1,
const Param_Test::StructSeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const CORBA::AnySeq &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::AnySeq_var in_;
- // in parameter
+ /// inout parameter
CORBA::AnySeq_var inout_;
- // inout parameter
+ /// out parameter
CORBA::AnySeq_var out_;
- // out parameter
+ /// return value
CORBA::AnySeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_ANY_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_array_seq.cpp b/TAO/tests/Param_Test/ub_array_seq.cpp
index f9c657cee9e..20ceaf2992b 100644
--- a/TAO/tests/Param_Test/ub_array_seq.cpp
+++ b/TAO/tests/Param_Test/ub_array_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_array_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded array sequences
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_array_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded array sequences
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_array_seq.h"
diff --git a/TAO/tests/Param_Test/ub_array_seq.h b/TAO/tests/Param_Test/ub_array_seq.h
index 258c2531567..c12cbbe29f6 100644
--- a/TAO/tests/Param_Test/ub_array_seq.h
+++ b/TAO/tests/Param_Test/ub_array_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_array_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded array sequence
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_array_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded array sequence
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNED_ARRAY_SEQUENCE_H
#define PARAM_TEST_UNBOUNED_ARRAY_SEQUENCE_H
@@ -28,60 +25,60 @@
class Test_Array_Sequence
{
public:
+ /// ctor
Test_Array_Sequence (void);
- // ctor
+ /// dtor
~Test_Array_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::ArraySeq &s1,
const Param_Test::ArraySeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::ArraySeq &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::ArraySeq in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::ArraySeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::ArraySeq_var out_;
- // out parameter
+ /// return value
Param_Test::ArraySeq_var ret_;
- // return value
};
diff --git a/TAO/tests/Param_Test/ub_long_seq.cpp b/TAO/tests/Param_Test/ub_long_seq.cpp
index 6ee5226abb2..7e1fd4ff6dd 100644
--- a/TAO/tests/Param_Test/ub_long_seq.cpp
+++ b/TAO/tests/Param_Test/ub_long_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_long_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded long sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_long_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded long sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_long_seq.h"
diff --git a/TAO/tests/Param_Test/ub_long_seq.h b/TAO/tests/Param_Test/ub_long_seq.h
index 4787743e140..2025d919676 100644
--- a/TAO/tests/Param_Test/ub_long_seq.h
+++ b/TAO/tests/Param_Test/ub_long_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_long_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded long sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_long_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded long sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_LONG_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_LONG_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Long_Sequence
{
public:
+ /// ctor
Test_Long_Sequence (void);
- // ctor
+ /// dtor
~Test_Long_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::LongSeq_var in_;
- // in parameter
+ /// inout parameter
CORBA::LongSeq_var inout_;
- // inout parameter
+ /// out parameter
CORBA::LongSeq_var out_;
- // out parameter
+ /// return value
CORBA::LongSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_LONG_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_objref_seq.cpp b/TAO/tests/Param_Test/ub_objref_seq.cpp
index e67c601d3a8..561a210bdae 100644
--- a/TAO/tests/Param_Test/ub_objref_seq.cpp
+++ b/TAO/tests/Param_Test/ub_objref_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_objref_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded objref sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_objref_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded objref sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_objref_seq.h"
diff --git a/TAO/tests/Param_Test/ub_objref_seq.h b/TAO/tests/Param_Test/ub_objref_seq.h
index 21f3639dd08..f21cf35d34f 100644
--- a/TAO/tests/Param_Test/ub_objref_seq.h
+++ b/TAO/tests/Param_Test/ub_objref_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_objref_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded sequences of object references
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_objref_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded sequences of object references
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_OBJREF_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_OBJREF_SEQUENCE_H
@@ -28,59 +25,59 @@
class Test_ObjRef_Sequence
{
public:
+ /// ctor
Test_ObjRef_Sequence (void);
- // ctor
+ /// dtor
~Test_ObjRef_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::Coffee_Mix &s1,
const Param_Test::Coffee_Mix &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::Coffee_Mix &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Coffee_Mix in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Coffee_Mix_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Coffee_Mix_var out_;
- // out parameter
+ /// return value
Param_Test::Coffee_Mix_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_OBJREF_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_short_seq.cpp b/TAO/tests/Param_Test/ub_short_seq.cpp
index 2fca09af475..8cbecfbf23b 100644
--- a/TAO/tests/Param_Test/ub_short_seq.cpp
+++ b/TAO/tests/Param_Test/ub_short_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_short_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded short sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_short_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded short sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_short_seq.h"
diff --git a/TAO/tests/Param_Test/ub_short_seq.h b/TAO/tests/Param_Test/ub_short_seq.h
index a200873eadd..e69f052f50c 100644
--- a/TAO/tests/Param_Test/ub_short_seq.h
+++ b/TAO/tests/Param_Test/ub_short_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_short_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded short sequence
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_short_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded short sequence
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_SHORT_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_SHORT_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_Short_Sequence
{
public:
+ /// ctor
Test_Short_Sequence (void);
- // ctor
+ /// dtor
~Test_Short_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::ShortSeq_var in_;
- // in parameter
+ /// inout parameter
CORBA::ShortSeq_var inout_;
- // inout parameter
+ /// out parameter
CORBA::ShortSeq_var out_;
- // out parameter
+ /// return value
CORBA::ShortSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_SHORT_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_str_seq.cpp b/TAO/tests/Param_Test/ub_str_seq.cpp
index 813cd79d7ad..889f49a0e64 100644
--- a/TAO/tests/Param_Test/ub_str_seq.cpp
+++ b/TAO/tests/Param_Test/ub_str_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_str_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded string sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_str_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded string sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_str_seq.h"
diff --git a/TAO/tests/Param_Test/ub_str_seq.h b/TAO/tests/Param_Test/ub_str_seq.h
index b58373550da..516a5425a5a 100644
--- a/TAO/tests/Param_Test/ub_str_seq.h
+++ b/TAO/tests/Param_Test/ub_str_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_str_seq.h
-//
-// = DESCRIPTION
-// Tests sequences of strings
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_str_seq.h
+ *
+ * $Id$
+ *
+ * Tests sequences of strings
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_STRING_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_STRING_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_String_Sequence
{
public:
+ /// ctor
Test_String_Sequence (void);
- // ctor
+ /// dtor
~Test_String_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::StringSeq_var in_;
- // in parameter
+ /// inout parameter
CORBA::StringSeq_var inout_;
- // inout parameter
+ /// out parameter
CORBA::StringSeq_var out_;
- // out parameter
+ /// return value
CORBA::StringSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_STRING_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_string.cpp b/TAO/tests/Param_Test/ub_string.cpp
index 094ac32714d..1d00e993d15 100644
--- a/TAO/tests/Param_Test/ub_string.cpp
+++ b/TAO/tests/Param_Test/ub_string.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_string.cpp
-//
-// = DESCRIPTION
-// tests unbounded strings
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_string.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded strings
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_string.h"
diff --git a/TAO/tests/Param_Test/ub_string.h b/TAO/tests/Param_Test/ub_string.h
index 834c4bfbcb2..085b087b0ed 100644
--- a/TAO/tests/Param_Test/ub_string.h
+++ b/TAO/tests/Param_Test/ub_string.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// unbounded_string.h
-//
-// = DESCRIPTION
-// Tests unbounded string
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file unbounded_string.h
+ *
+ * $Id$
+ *
+ * Tests unbounded string
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_STRING_H
#define PARAM_TEST_UNBOUNDED_STRING_H
@@ -27,51 +24,51 @@
class Test_Unbounded_String
{
public:
+ /// ctor
Test_Unbounded_String (void);
- // ctor
+ /// dtor
~Test_Unbounded_String (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
char *in_;
- // in parameter
+ /// inout parameter
char *inout_;
- // inout parameter
+ /// out parameter
char *out_;
- // out parameter
+ /// return value
char *ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_STRING_H */
diff --git a/TAO/tests/Param_Test/ub_struct_seq.cpp b/TAO/tests/Param_Test/ub_struct_seq.cpp
index 99fac095c14..4535cb61991 100644
--- a/TAO/tests/Param_Test/ub_struct_seq.cpp
+++ b/TAO/tests/Param_Test/ub_struct_seq.cpp
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_struct_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded struct sequences
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_struct_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded struct sequences
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_struct_seq.h"
diff --git a/TAO/tests/Param_Test/ub_struct_seq.h b/TAO/tests/Param_Test/ub_struct_seq.h
index 7459c7892f1..2e8a5a3fe71 100644
--- a/TAO/tests/Param_Test/ub_struct_seq.h
+++ b/TAO/tests/Param_Test/ub_struct_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_struct_seq.h
-//
-// = DESCRIPTION
-// Tests unbounded struct sequence
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_struct_seq.h
+ *
+ * $Id$
+ *
+ * Tests unbounded struct sequence
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNED_STRUCT_SEQUENCE_H
#define PARAM_TEST_UNBOUNED_STRUCT_SEQUENCE_H
@@ -28,60 +25,60 @@
class Test_Struct_Sequence
{
public:
+ /// ctor
Test_Struct_Sequence (void);
- // ctor
+ /// dtor
~Test_Struct_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::StructSeq &s1,
const Param_Test::StructSeq &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::StructSeq &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::StructSeq in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::StructSeq_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::StructSeq_var out_;
- // out parameter
+ /// return value
Param_Test::StructSeq_var ret_;
- // return value
};
@@ -89,60 +86,60 @@ private:
class Test_Unbounded_Struct_Sequence
{
public:
+ /// ctor
Test_Unbounded_Struct_Sequence (void);
- // ctor
+ /// dtor
~Test_Unbounded_Struct_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
protected:
+ /// compare
CORBA::Boolean compare (const Param_Test::PathSpec &s1,
const Param_Test::PathSpec &s2);
- // compare
+ /// print individual sequence
void print_sequence (const Param_Test::PathSpec &s);
- // print individual sequence
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::PathSpec in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::PathSpec_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::PathSpec_var out_;
- // out parameter
+ /// return value
Param_Test::PathSpec_var ret_;
- // return value
};
diff --git a/TAO/tests/Param_Test/ub_wstr_seq.cpp b/TAO/tests/Param_Test/ub_wstr_seq.cpp
index c272d2fade4..7e768fff7de 100644
--- a/TAO/tests/Param_Test/ub_wstr_seq.cpp
+++ b/TAO/tests/Param_Test/ub_wstr_seq.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_wstr_seq.cpp
-//
-// = DESCRIPTION
-// tests unbounded wide string sequences
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_wstr_seq.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded wide string sequences
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_wstr_seq.h"
diff --git a/TAO/tests/Param_Test/ub_wstr_seq.h b/TAO/tests/Param_Test/ub_wstr_seq.h
index 5351240f41c..8e5254d366f 100644
--- a/TAO/tests/Param_Test/ub_wstr_seq.h
+++ b/TAO/tests/Param_Test/ub_wstr_seq.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_wstr_seq.h
-//
-// = DESCRIPTION
-// Tests sequences of wide strings
-//
-// = AUTHORS
-// Jeff Parsons
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_wstr_seq.h
+ *
+ * $Id$
+ *
+ * Tests sequences of wide strings
+ *
+ *
+ * @author Jeff Parsons
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_WSTRING_SEQUENCE_H
#define PARAM_TEST_UNBOUNDED_WSTRING_SEQUENCE_H
@@ -28,51 +25,51 @@
class Test_WString_Sequence
{
public:
+ /// ctor
Test_WString_Sequence (void);
- // ctor
+ /// dtor
~Test_WString_Sequence (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::WStringSeq_var in_;
- // in parameter
+ /// inout parameter
CORBA::WStringSeq_var inout_;
- // inout parameter
+ /// out parameter
CORBA::WStringSeq_var out_;
- // out parameter
+ /// return value
CORBA::WStringSeq_var ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_WSTRING_SEQUENCE_H */
diff --git a/TAO/tests/Param_Test/ub_wstring.cpp b/TAO/tests/Param_Test/ub_wstring.cpp
index 31c1c68f59f..370e9738381 100644
--- a/TAO/tests/Param_Test/ub_wstring.cpp
+++ b/TAO/tests/Param_Test/ub_wstring.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_wstring.cpp
-//
-// = DESCRIPTION
-// tests unbounded wide strings
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_wstring.cpp
+ *
+ * $Id$
+ *
+ * tests unbounded wide strings
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "helper.h"
#include "ub_wstring.h"
diff --git a/TAO/tests/Param_Test/ub_wstring.h b/TAO/tests/Param_Test/ub_wstring.h
index 0c11b453c98..66c38ee3769 100644
--- a/TAO/tests/Param_Test/ub_wstring.h
+++ b/TAO/tests/Param_Test/ub_wstring.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ub_wstring.h
-//
-// = DESCRIPTION
-// Tests unbounded wide string
-//
-// = AUTHORS
-// Jeff Parsons <parsons@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ub_wstring.h
+ *
+ * $Id$
+ *
+ * Tests unbounded wide string
+ *
+ *
+ * @author Jeff Parsons <parsons@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_UNBOUNDED_WSTRING_H
#define PARAM_TEST_UNBOUNDED_WSTRING_H
@@ -27,51 +24,51 @@
class Test_Unbounded_WString
{
public:
+ /// ctor
Test_Unbounded_WString (void);
- // ctor
+ /// dtor
~Test_Unbounded_WString (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::WChar *in_;
- // in parameter
+ /// inout parameter
CORBA::WChar *inout_;
- // inout parameter
+ /// out parameter
CORBA::WChar *out_;
- // out parameter
+ /// return value
CORBA::WChar *ret_;
- // return value
};
#endif /* PARAM_TEST_UNBOUNDED_WSTRING_H */
diff --git a/TAO/tests/Param_Test/ulonglong.cpp b/TAO/tests/Param_Test/ulonglong.cpp
index c35279edd6f..0156640958f 100644
--- a/TAO/tests/Param_Test/ulonglong.cpp
+++ b/TAO/tests/Param_Test/ulonglong.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ulonglong.cpp
-//
-// = DESCRIPTION
-// tests 64 bit longs
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ulonglong.cpp
+ *
+ * $Id$
+ *
+ * tests 64 bit longs
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "ulonglong.h"
diff --git a/TAO/tests/Param_Test/ulonglong.h b/TAO/tests/Param_Test/ulonglong.h
index c143ef00a70..e88464cf28f 100644
--- a/TAO/tests/Param_Test/ulonglong.h
+++ b/TAO/tests/Param_Test/ulonglong.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// ulonglong.h
-//
-// = DESCRIPTION
-// Tests 64bit unsigned longs.
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file ulonglong.h
+ *
+ * $Id$
+ *
+ * Tests 64bit unsigned longs.
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_ULONGLONG_H
#define PARAM_TEST_ULONGLONG_H
@@ -24,51 +21,51 @@
class Test_ULongLong
{
public:
+ /// ctor
Test_ULongLong (void);
- // ctor
+ /// dtor
~Test_ULongLong (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
CORBA::ULongLong in_;
- // in parameter
+ /// inout parameter
CORBA::ULongLong inout_;
- // inout parameter
+ /// out parameter
CORBA::ULongLong out_;
- // out parameter
+ /// return value
CORBA::ULongLong ret_;
- // return value
};
#endif /* PARAM_TEST_ULONGLONG_H */
diff --git a/TAO/tests/Param_Test/var_array.cpp b/TAO/tests/Param_Test/var_array.cpp
index 4bdba9856fc..daf31451008 100644
--- a/TAO/tests/Param_Test/var_array.cpp
+++ b/TAO/tests/Param_Test/var_array.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// var_array.cpp
-//
-// = DESCRIPTION
-// tests fixed size arrays
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file var_array.cpp
+ *
+ * $Id$
+ *
+ * tests fixed size arrays
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "var_array.h"
diff --git a/TAO/tests/Param_Test/var_array.h b/TAO/tests/Param_Test/var_array.h
index 1a9b4e5c08f..863345610a6 100644
--- a/TAO/tests/Param_Test/var_array.h
+++ b/TAO/tests/Param_Test/var_array.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// var_array.h
-//
-// = DESCRIPTION
-// Tests arrays whose base types are of variable size
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file var_array.h
+ *
+ * $Id$
+ *
+ * Tests arrays whose base types are of variable size
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_VAR_ARRAY_H
#define PARAM_TEST_VAR_ARRAY_H
@@ -27,58 +24,58 @@
class Test_Var_Array
{
public:
+ /// ctor
Test_Var_Array (void);
- // ctor
+ /// dtor
~Test_Var_Array (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// compare arrays
CORBA::Boolean compare (const Param_Test::Var_Array_slice *a1,
const Param_Test::Var_Array_slice *a2);
- // compare arrays
+ /// print an array
void print (const Param_Test::Var_Array_slice *a);
- // print an array
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Var_Array in_;
- // in parameter
+ /// inout parameter
Param_Test::Var_Array inout_;
- // inout parameter
+ /// out parameter
Param_Test::Var_Array_var out_;
- // out parameter
+ /// return value
Param_Test::Var_Array_var ret_;
- // return value
};
#endif /* PARAM_TEST_VAR_ARRAY_H */
diff --git a/TAO/tests/Param_Test/var_struct.cpp b/TAO/tests/Param_Test/var_struct.cpp
index a3d8fe30dc7..4dddf7fbfdf 100644
--- a/TAO/tests/Param_Test/var_struct.cpp
+++ b/TAO/tests/Param_Test/var_struct.cpp
@@ -1,20 +1,17 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// var_struct.cpp
-//
-// = DESCRIPTION
-// test variable sized structures
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file var_struct.cpp
+ *
+ * $Id$
+ *
+ * test variable sized structures
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#include "helper.h"
#include "var_struct.h"
diff --git a/TAO/tests/Param_Test/var_struct.h b/TAO/tests/Param_Test/var_struct.h
index 79f15ff4ded..dcc2f16d0c8 100644
--- a/TAO/tests/Param_Test/var_struct.h
+++ b/TAO/tests/Param_Test/var_struct.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Param_Test
-//
-// = FILENAME
-// var_struct.h
-//
-// = DESCRIPTION
-// Tests variable sized structures
-//
-// = AUTHORS
-// Aniruddha Gokhale
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file var_struct.h
+ *
+ * $Id$
+ *
+ * Tests variable sized structures
+ *
+ *
+ * @author Aniruddha Gokhale
+ */
+//=============================================================================
+
#ifndef PARAM_TEST_VAR_STRUCT_H
#define PARAM_TEST_VAR_STRUCT_H
@@ -28,52 +25,52 @@
class Test_Var_Struct
{
public:
+ /// ctor
Test_Var_Struct (void);
- // ctor
+ /// dtor
~Test_Var_Struct (void);
- // dtor
+ /// run the SII test
int run_sii_test (Param_Test_ptr objref);
- // run the SII test
+ /// return operation name
const char *opname (void) const;
- // return operation name
+ /// set values for parameters
int init_parameters (Param_Test_ptr objref);
- // set values for parameters
+ /// reset values for CORBA
int reset_parameters (void);
- // reset values for CORBA
+ /// check if results are valid
CORBA::Boolean check_validity (void);
- // check if results are valid
+ /// check if results are valid. This is used for DII results
CORBA::Boolean check_validity (CORBA::Request_ptr req);
- // check if results are valid. This is used for DII results
+ /// print all the values
void print_values (void);
- // print all the values
+ /// invoke DII request with appropriate exception handling.
void dii_req_invoke (CORBA::Request *);
- // invoke DII request with appropriate exception handling.
private:
+ /// operation name
char *opname_;
- // operation name
+ /// in parameter
Param_Test::Var_Struct in_;
- // in parameter
// these need memory management
+ /// inout parameter
Param_Test::Var_Struct_var inout_;
- // inout parameter
+ /// out parameter
Param_Test::Var_Struct_var out_;
- // out parameter
+ /// return value
Param_Test::Var_Struct_var ret_;
- // return value
};
#endif /* PARAM_TEST_VAR_STRUCT_H */
diff --git a/TAO/tests/Portable_Interceptors/Benchmark/test_i.h b/TAO/tests/Portable_Interceptors/Benchmark/test_i.h
index f6e15213c34..989976d0e32 100644
--- a/TAO/tests/Portable_Interceptors/Benchmark/test_i.h
+++ b/TAO/tests/Portable_Interceptors/Benchmark/test_i.h
@@ -1,36 +1,36 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Portable_Interceptors/Benchmark
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Nanbor Wang
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Nanbor Wang
+ */
+//=============================================================================
+
#ifndef TAO_INTERCEPTOR_TEST_I_H
#define TAO_INTERCEPTOR_TEST_I_H
#include "testS.h"
+/**
+ * @class Secure_Vault_i
+ *
+ * Implements the Secure_Vault interface in test.idl
+ */
class Secure_Vault_i : public POA_Test_Interceptors::Secure_Vault
{
- // = DESCRIPTION
- // Implements the Secure_Vault interface in test.idl
public:
+ /// ctor
Secure_Vault_i (CORBA::ORB_ptr orb);
- // ctor
virtual CORBA::Short ready (void);
+ /// Passwd sent in the service context list
virtual void authenticate (const char * user);
- // Passwd sent in the service context list
virtual CORBA::Long update_records (CORBA::Long id,
const Test_Interceptors::Secure_Vault::Record & val);
@@ -38,8 +38,8 @@ public:
virtual void shutdown (void);
private:
+ /// The ORB pointer (for shutdown.)
CORBA::ORB_var orb_;
- // The ORB pointer (for shutdown.)
};
#endif /* TAO_INTERCEPTOR_TEST_I_H */
diff --git a/TAO/tests/Portable_Interceptors/Collocated/Dynamic/test_i.h b/TAO/tests/Portable_Interceptors/Collocated/Dynamic/test_i.h
index 2ccfe475b5f..96d6a044e67 100644
--- a/TAO/tests/Portable_Interceptors/Collocated/Dynamic/test_i.h
+++ b/TAO/tests/Portable_Interceptors/Collocated/Dynamic/test_i.h
@@ -1,31 +1,31 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Portable_Interceptors/Dynamic
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Nanbor Wang
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Nanbor Wang
+ */
+//=============================================================================
+
#ifndef TAO_INTERCEPTOR_TEST_I_H
#define TAO_INTERCEPTOR_TEST_I_H
#include "testS.h"
+/**
+ * @class Visual_i
+ *
+ * Implements the Visual interface in test.idl
+ */
class Visual_i : public POA_Test_Interceptors::Visual
{
- // = DESCRIPTION
- // Implements the Visual interface in test.idl
public:
+ /// ctor
Visual_i (CORBA::ORB_ptr orb);
- // ctor
void normal (CORBA::Long arg);
@@ -40,8 +40,8 @@ public:
void shutdown (void);
private:
+ /// The ORB pointer (for shutdown.)
CORBA::ORB_var orb_;
- // The ORB pointer (for shutdown.)
};
#endif /* TAO_INTERCEPTOR_TEST_I_H */
diff --git a/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h b/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h
index 2ccfe475b5f..96d6a044e67 100644
--- a/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h
+++ b/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Collocated/test_i.h
@@ -1,31 +1,31 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Portable_Interceptors/Dynamic
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Nanbor Wang
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Nanbor Wang
+ */
+//=============================================================================
+
#ifndef TAO_INTERCEPTOR_TEST_I_H
#define TAO_INTERCEPTOR_TEST_I_H
#include "testS.h"
+/**
+ * @class Visual_i
+ *
+ * Implements the Visual interface in test.idl
+ */
class Visual_i : public POA_Test_Interceptors::Visual
{
- // = DESCRIPTION
- // Implements the Visual interface in test.idl
public:
+ /// ctor
Visual_i (CORBA::ORB_ptr orb);
- // ctor
void normal (CORBA::Long arg);
@@ -40,8 +40,8 @@ public:
void shutdown (void);
private:
+ /// The ORB pointer (for shutdown.)
CORBA::ORB_var orb_;
- // The ORB pointer (for shutdown.)
};
#endif /* TAO_INTERCEPTOR_TEST_I_H */
diff --git a/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h b/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h
index 2ccfe475b5f..96d6a044e67 100644
--- a/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h
+++ b/TAO/tests/Portable_Interceptors/Processing_Mode_Policy/Remote/test_i.h
@@ -1,31 +1,31 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Portable_Interceptors/Dynamic
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Nanbor Wang
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Nanbor Wang
+ */
+//=============================================================================
+
#ifndef TAO_INTERCEPTOR_TEST_I_H
#define TAO_INTERCEPTOR_TEST_I_H
#include "testS.h"
+/**
+ * @class Visual_i
+ *
+ * Implements the Visual interface in test.idl
+ */
class Visual_i : public POA_Test_Interceptors::Visual
{
- // = DESCRIPTION
- // Implements the Visual interface in test.idl
public:
+ /// ctor
Visual_i (CORBA::ORB_ptr orb);
- // ctor
void normal (CORBA::Long arg);
@@ -40,8 +40,8 @@ public:
void shutdown (void);
private:
+ /// The ORB pointer (for shutdown.)
CORBA::ORB_var orb_;
- // The ORB pointer (for shutdown.)
};
#endif /* TAO_INTERCEPTOR_TEST_I_H */
diff --git a/TAO/tests/QtTests/client.h b/TAO/tests/QtTests/client.h
index fedef24e6d1..c127b30a509 100644
--- a/TAO/tests/QtTests/client.h
+++ b/TAO/tests/QtTests/client.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch/Stopwatch_client
-//
-// = FILENAME
-// client.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file client.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _QT_CLIENT_H
#define _QT_CLIENT_H
@@ -28,38 +25,38 @@ class Client : public QObject
Q_OBJECT
public:
+ /// ctor
Client (CORBA::ORB_ptr orb,
QApplication &app);
- // ctor
+ ///Dtor..
~Client (void);
- //Dtor..
+ /// Adds the callbacks to the GUI underneath.....
void create_widgets (void);
- // Adds the callbacks to the GUI underneath.....
void show (void);
void parse_args (int argc, ACE_TCHAR *argv[]);
+ /// A box widget..
QVBox box_;
- // A box widget..
public slots:
+ /// Two slot handlers for the two widgets that we have
void remote_call (int val);
void shutdown_call (void);
- // Two slot handlers for the two widgets that we have
private:
+ /// A push button
QPushButton *push_button_;
- // A push button
+ /// A slider widget
QSlider *slider_;
- // A slider widget
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
LCD_Display_var server_;
diff --git a/TAO/tests/QtTests/test_i.h b/TAO/tests/QtTests/test_i.h
index f1d517adfa8..4c61fc41305 100644
--- a/TAO/tests/QtTests/test_i.h
+++ b/TAO/tests/QtTests/test_i.h
@@ -1,16 +1,13 @@
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/QtTests
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Bala Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Bala Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef _QT_TEST_I_H
#define _QT_TEST_I_H
@@ -24,13 +21,15 @@ class LCD_Display_imp : public QObject,
public POA_LCD_Display
{
+ /**
+ * = TITLE
+ * LCD_Display implementation class
+ *
+ * = DESCRIPTION
+ * Implements the LCD_Display interface in test.idl
+ *
+ */
Q_OBJECT
- // = TITLE
- // LCD_Display implementation class
- //
- // = DESCRIPTION
- // Implements the LCD_Display interface in test.idl
- //
public:
LCD_Display_imp (CORBA::ORB_ptr);
@@ -44,8 +43,8 @@ public:
void set_value (int val);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* SERVER_TEST_I_H */
diff --git a/TAO/tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h b/TAO/tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h
index fac5d84a433..cfdcb226bee 100644
--- a/TAO/tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h
+++ b/TAO/tests/RTCORBA/Diffserv/Custom_Network_Priority_Mapping.h
@@ -1,20 +1,17 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// Custom_Network_Priority_Mapping.h
-//
-// = DESCRIPTION
-// Declares the Custom_Network_Priority_Mapping interface,
-//
-// = AUTHOR
-// Yamuna Krishnamurthy (yamuna@oomworks.com)
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Custom_Network_Priority_Mapping.h
+ *
+ * $Id$
+ *
+ * Declares the Custom_Network_Priority_Mapping interface,
+ *
+ *
+ * @author Yamuna Krishnamurthy (yamuna@oomworks.com)
+ */
+//=============================================================================
+
#ifndef CUSTOM_NETWORK_PRIORITY_MAPPING_H
#define CUSTOM_NETWORK_PRIORITY_MAPPING_H
@@ -26,18 +23,18 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Custom_Network_Priority_Mapping
+ *
+ * @brief A simple implementation of the Network_Priority_Mapping interface
+ *
+ * This implementation uses custom mapping between the range of
+ * priorities for a given scheduling class (ACE_SCHED_OTHER,
+ * ACE_SCHED_FIFO, ACE_SCHED_RR) and the valid range of CORBA
+ * priorities (0...32767)
+ */
class Custom_Network_Priority_Mapping : public TAO_Network_Priority_Mapping
{
- //
- // = TITLE
- // A simple implementation of the Network_Priority_Mapping interface
- //
- // = DESCRIPTION
- // This implementation uses custom mapping between the range of
- // priorities for a given scheduling class (ACE_SCHED_OTHER,
- // ACE_SCHED_FIFO, ACE_SCHED_RR) and the valid range of CORBA
- // priorities (0...32767)
- //
public:
Custom_Network_Priority_Mapping (void);
diff --git a/TAO/tests/RTCORBA/Policies/Policies.cpp b/TAO/tests/RTCORBA/Policies/Policies.cpp
index cd8aebbdca2..78b61e238c8 100644
--- a/TAO/tests/RTCORBA/Policies/Policies.cpp
+++ b/TAO/tests/RTCORBA/Policies/Policies.cpp
@@ -1,22 +1,19 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/RTCORBA/Policies
-//
-// = FILENAME
-// Policies.cpp
-//
-// = DESCRIPTION
-// This program tests the construction of RTCORBA policies, both
-// through the generic ORB::create_policy interface and the
-// RTCORBA specific interfaces.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file Policies.cpp
+ *
+ * $Id$
+ *
+ * This program tests the construction of RTCORBA policies, both
+ * through the generic ORB::create_policy interface and the
+ * RTCORBA specific interfaces.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "tao/ORB.h"
#include "tao/RTCORBA/RTCORBA.h"
diff --git a/TAO/tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp b/TAO/tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp
index c6273d299e4..e06538fdc19 100644
--- a/TAO/tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp
+++ b/TAO/tests/RTCORBA/Profile_And_Endpoint_Selection/client.cpp
@@ -1,18 +1,17 @@
-// $Id$
-
-// ================================================================
-//
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a client implementation.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a client implementation.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/Task.h"
diff --git a/TAO/tests/Single_Read/test_i.h b/TAO/tests/Single_Read/test_i.h
index c1218fe34a2..fdf530e5931 100644
--- a/TAO/tests/Single_Read/test_i.h
+++ b/TAO/tests/Single_Read/test_i.h
@@ -1,31 +1,30 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Single_Read
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_SINGLE_READ_TEST_I_H
#define TAO_SINGLE_READ_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, const ACE_TCHAR *file_name);
- // ctor.
// = The test interface methods.
void method (CORBA::ULong request_number,
diff --git a/TAO/tests/Smart_Proxies/Benchmark/client.cpp b/TAO/tests/Smart_Proxies/Benchmark/client.cpp
index 7c47e77e00a..c3dcadc8f63 100644
--- a/TAO/tests/Smart_Proxies/Benchmark/client.cpp
+++ b/TAO/tests/Smart_Proxies/Benchmark/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxies/Benchmark
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "testC.h"
#include "Smart_Proxy_Impl.h"
@@ -55,8 +52,8 @@ class Marker
}
private:
+ /// Keep throughput statistics on a per-thread basis
ACE_Throughput_Stats throughput_;
- // Keep throughput statistics on a per-thread basis
};
diff --git a/TAO/tests/Smart_Proxies/Benchmark/server.cpp b/TAO/tests/Smart_Proxies/Benchmark/server.cpp
index e90ae97aacd..e1d7bede99d 100644
--- a/TAO/tests/Smart_Proxies/Benchmark/server.cpp
+++ b/TAO/tests/Smart_Proxies/Benchmark/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxies/Benchmark
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This is the server program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This is the server program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Get_Opt.h"
@@ -32,8 +29,8 @@ public:
CORBA::Long tickets (CORBA::Short number);
//FUZZ: disable check_for_lack_ACE_OS
+ ///FUZZ: enable check_for_lack_ACE_OS
void shutdown (void);
- //FUZZ: enable check_for_lack_ACE_OS
private:
CORBA::ORB_var orb_;
diff --git a/TAO/tests/Smart_Proxies/On_Demand/client.cpp b/TAO/tests/Smart_Proxies/On_Demand/client.cpp
index d546f5d4472..13cd632d504 100644
--- a/TAO/tests/Smart_Proxies/On_Demand/client.cpp
+++ b/TAO/tests/Smart_Proxies/On_Demand/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy/On_Demand
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#define ACE_BUILD_SVC_DLL
#include "ace/Get_Opt.h"
diff --git a/TAO/tests/Smart_Proxies/On_Demand/server.cpp b/TAO/tests/Smart_Proxies/On_Demand/server.cpp
index 6c16157ca8e..1da423a2ca8 100644
--- a/TAO/tests/Smart_Proxies/On_Demand/server.cpp
+++ b/TAO/tests/Smart_Proxies/On_Demand/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy/On_Demand
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This is the server program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This is the server program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Get_Opt.h"
@@ -30,8 +27,8 @@ public:
CORBA::Short method (CORBA::Short boo);
//FUZZ: disable check_for_lack_ACE_OS
+ ///FUZZ: enable check_for_lack_ACE_OS
void shutdown (void);
- //FUZZ: enable check_for_lack_ACE_OS
private:
CORBA::ORB_var orb_;
diff --git a/TAO/tests/Smart_Proxies/Policy/client.cpp b/TAO/tests/Smart_Proxies/Policy/client.cpp
index 0388d6bda1c..18858ee8601 100644
--- a/TAO/tests/Smart_Proxies/Policy/client.cpp
+++ b/TAO/tests/Smart_Proxies/Policy/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "ace/OS_NS_string.h"
diff --git a/TAO/tests/Smart_Proxies/Policy/server.cpp b/TAO/tests/Smart_Proxies/Policy/server.cpp
index 67460430a54..33a19e5aff6 100644
--- a/TAO/tests/Smart_Proxies/Policy/server.cpp
+++ b/TAO/tests/Smart_Proxies/Policy/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This is the server program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This is the server program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Get_Opt.h"
@@ -30,8 +27,8 @@ public:
CORBA::Short method (CORBA::Short boo);
//FUZZ: disable check_for_lack_ACE_OS
+ ///FUZZ: enable check_for_lack_ACE_OS
void shutdown (void);
- //FUZZ: enable check_for_lack_ACE_OS
private:
CORBA::ORB_var orb_;
diff --git a/TAO/tests/Smart_Proxies/client.cpp b/TAO/tests/Smart_Proxies/client.cpp
index 27d94548e78..2000a28b4b2 100644
--- a/TAO/tests/Smart_Proxies/client.cpp
+++ b/TAO/tests/Smart_Proxies/client.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is the client program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is the client program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "ace/Get_Opt.h"
#include "testC.h"
diff --git a/TAO/tests/Smart_Proxies/server.cpp b/TAO/tests/Smart_Proxies/server.cpp
index 6219a2a7c36..45705ad98aa 100644
--- a/TAO/tests/Smart_Proxies/server.cpp
+++ b/TAO/tests/Smart_Proxies/server.cpp
@@ -1,20 +1,17 @@
-// $Id$
-
-//========================================================================
-//
-// = LIBRARY
-// TAO/tests/Smart_Proxy
-//
-// = FILENAME
-// server.cpp
-//
-// = DESCRIPTION
-// This is the server program that tests TAO's Smart Proxy extension.
-//
-// = AUTHOR
-// Kirthika Parameswaran <kirthika@cs.wustl.edu>
-//
-//=========================================================================
+
+//=============================================================================
+/**
+ * @file server.cpp
+ *
+ * $Id$
+ *
+ * This is the server program that tests TAO's Smart Proxy extension.
+ *
+ *
+ * @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
#include "testS.h"
#include "ace/Get_Opt.h"
@@ -30,8 +27,8 @@ public:
CORBA::Short method (CORBA::Short boo);
//FUZZ: disable check_for_lack_ACE_OS
+ ///FUZZ: enable check_for_lack_ACE_OS
void shutdown (void);
- //FUZZ: enable check_for_lack_ACE_OS
private:
CORBA::ORB_var orb_;
diff --git a/TAO/tests/Strategies/simple_test_i.h b/TAO/tests/Strategies/simple_test_i.h
index c2680214a24..1077e9f1a54 100644
--- a/TAO/tests/Strategies/simple_test_i.h
+++ b/TAO/tests/Strategies/simple_test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tao/Strategies/tests/
-//
-// = FILENAME
-// simple_test_i.h
-//
-// = AUTHOR
-// Priyanka Gontla <pgontla@ece.uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file simple_test_i.h
+ *
+ * $Id$
+ *
+ * @author Priyanka Gontla <pgontla@ece.uci.edu>
+ */
+//=============================================================================
+
#ifndef TAO_STRATEGIES_TEST_I_H
#define TAO_STRATEGIES_TEST_I_H
#include "simple_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.
CORBA::Boolean print_status (void);
diff --git a/TAO/tests/Timed_Buffered_Oneways/client.cpp b/TAO/tests/Timed_Buffered_Oneways/client.cpp
index d97c21c98b9..bd6881ba7a4 100644
--- a/TAO/tests/Timed_Buffered_Oneways/client.cpp
+++ b/TAO/tests/Timed_Buffered_Oneways/client.cpp
@@ -1,18 +1,18 @@
-// $Id$
-
-// ================================================================
-//
-// = FILENAME
-// client.cpp
-//
-// = DESCRIPTION
-// This is a client that uses oneways with buffering constraints
-// and roundtrip timeout constraints.
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ================================================================
+
+//=============================================================================
+/**
+ * @file client.cpp
+ *
+ * $Id$
+ *
+ * This is a client that uses oneways with buffering constraints
+ * and roundtrip timeout constraints.
+ *
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#include "testC.h"
diff --git a/TAO/tests/Timed_Buffered_Oneways/test_i.h b/TAO/tests/Timed_Buffered_Oneways/test_i.h
index 6a8e13412fe..7dc48785cb1 100644
--- a/TAO/tests/Timed_Buffered_Oneways/test_i.h
+++ b/TAO/tests/Timed_Buffered_Oneways/test_i.h
@@ -1,32 +1,31 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Timed_Buffered_Oneways/
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Irfan Pyarali
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Irfan Pyarali
+ */
+//=============================================================================
+
#ifndef TAO_TIMED_BUFFERED_ONEWAYS_TEST_I_H
#define TAO_TIMED_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,
@@ -39,8 +38,8 @@ public:
void shutdown (CORBA::Long start_time);
private:
+ /// The ORB.
CORBA::ORB_var orb_;
- // The ORB.
};
#endif /* TAO_TIMED_BUFFERED_ONEWAYS_TEST_I_H */
diff --git a/TAO/tests/Timeout/test_i.h b/TAO/tests/Timeout/test_i.h
index 8c102e3a1b7..eb3d07084a5 100644
--- a/TAO/tests/Timeout/test_i.h
+++ b/TAO/tests/Timeout/test_i.h
@@ -1,34 +1,32 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Timeout
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Carlos O'Ryan
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan
+ */
+//=============================================================================
+
#ifndef TAO_TIMEOUT_TEST_I_H
#define TAO_TIMEOUT_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.
CORBA::Long echo (CORBA::Long x,
@@ -36,8 +34,8 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
};
#endif /* TAO_TIMEOUT_TEST_I_H */
diff --git a/TAO/tests/Xt_Stopwatch/Client.h b/TAO/tests/Xt_Stopwatch/Client.h
index 45162e4daf3..f2cecb0a0a1 100644
--- a/TAO/tests/Xt_Stopwatch/Client.h
+++ b/TAO/tests/Xt_Stopwatch/Client.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch/Stopwatch_client
-//
-// = FILENAME
-// Client.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Client.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CLIENT_H
#define CLIENT_H
@@ -26,35 +23,35 @@ class Client
{
public:
+ /// ctor
Client (CORBA::ORB_ptr orb);
- // ctor
+ ///Dtor..
~Client (void);
- //Dtor..
+ /// The callbacks
static void start_callback (Widget w,
XtPointer client_data,
XtPointer call_data);
static void stop_callback (Widget w,
XtPointer client_data,
XtPointer call_data);
- // The callbacks
+ /// The hooks...
void start_hook (void);
void stop_hook (void);
- // The hooks...
+ /// Adds the callbacks to the GUI underneath.....
void add_callback (Control &);
- // Adds the callbacks to the GUI underneath.....
void parse_args (int argc, ACE_TCHAR *argv[]);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// The server.
Stopwatch_var server_;
- // The server.
};
#endif /* CLIENT_H */
diff --git a/TAO/tests/Xt_Stopwatch/Control.h b/TAO/tests/Xt_Stopwatch/Control.h
index 0dea6b7eed9..4d57f38da39 100644
--- a/TAO/tests/Xt_Stopwatch/Control.h
+++ b/TAO/tests/Xt_Stopwatch/Control.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch/Stopwatch_client
-//
-// = FILENAME
-// Control.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Control.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef CONTROL_H
#define CONTROL_H
@@ -28,34 +25,34 @@
class Control
{
public:
+ /// Stopwatch constructor
Control (Widget &parent);
- // Stopwatch constructor
+ /// Destructor
virtual ~Control (void);
- // Destructor
+ /// Manage the widget
virtual void manage (void);
- // Manage the widget
+ /// Return the start widget
Widget& startwidget (void);
- // Return the start widget
+ /// Return the stop widget..
Widget& stopwidget (void);
- // Return the stop widget..
private:
+ /// A frame widget...
Widget frame_;
- // A frame widget...
+ /// A row column widget..
Widget rowcolumn_;
- // A row column widget..
+ /// Pushbutton Widget that is used to start the timer..
Widget startwidget_;
- // Pushbutton Widget that is used to start the timer..
+ /// Pushbutton widget that is used to stop the timer..
Widget stopwidget_;
- // Pushbutton widget that is used to stop the timer..
};
diff --git a/TAO/tests/Xt_Stopwatch/Stopwatch_display.h b/TAO/tests/Xt_Stopwatch/Stopwatch_display.h
index 984d90b4d35..3b98e23a4c4 100644
--- a/TAO/tests/Xt_Stopwatch/Stopwatch_display.h
+++ b/TAO/tests/Xt_Stopwatch/Stopwatch_display.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch/Stopwatch_server
-//
-// = FILENAME
-// Stopwatch.h
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Stopwatch.h
+ *
+ * $Id$
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef STOPWATCH_H
#define STOPWATCH_H
@@ -26,24 +23,24 @@ class Stopwatch_display
{
public:
+ /// Stopwatch_display constructor
Stopwatch_display (Widget &parent);
- // Stopwatch_display constructor
+ /// Destructor
virtual ~Stopwatch_display (void);
- // Destructor
+ /// Manage the widget
virtual void manage (void);
- // Manage the widget
+ /// Change the displayed time
void set_time (CORBA::Float value);
- // Change the displayed time
private:
+ /// A frame widget...
Widget frame_;
- // A frame widget...
+ /// Label Widget that is used to display time..
Widget label_;
- // Label Widget that is used to display time..
};
diff --git a/TAO/tests/Xt_Stopwatch/test_i.h b/TAO/tests/Xt_Stopwatch/test_i.h
index 539a82b16e0..10135d3652e 100644
--- a/TAO/tests/Xt_Stopwatch/test_i.h
+++ b/TAO/tests/Xt_Stopwatch/test_i.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch
-//
-// = FILENAME
-// test_i.h
-//
-// = AUTHOR
-// Bala
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file test_i.h
+ *
+ * $Id$
+ *
+ * @author Bala
+ */
+//=============================================================================
+
#ifndef SERVER_TEST_I_H
#define SERVER_TEST_I_H
@@ -20,17 +17,18 @@
#include "timer.h"
+/**
+ * @class Stopwatch_imp
+ *
+ * @brief Stopwatch implementation class
+ *
+ * Implements the Stopwatch interface in test.idl
+ */
class Stopwatch_imp : public POA_Stopwatch
{
- // = TITLE
- // Stopwatch implementation class
- //
- // = DESCRIPTION
- // Implements the Stopwatch interface in test.idl
- //
public:
+ /// ctor
Stopwatch_imp (CORBA::ORB_ptr, Timer_imp *);
- // ctor
// = The Simple_Server methods.
void start (void);
@@ -40,11 +38,11 @@ public:
void shutdown (void);
private:
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// Hold the timer object...
Timer_imp *timer_;
- // Hold the timer object...
};
#endif /* SERVER_TEST_I_H */
diff --git a/TAO/tests/Xt_Stopwatch/timer.h b/TAO/tests/Xt_Stopwatch/timer.h
index 1708bbc8428..e96d6c614f8 100644
--- a/TAO/tests/Xt_Stopwatch/timer.h
+++ b/TAO/tests/Xt_Stopwatch/timer.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch
-//
-// = FILENAME
-// timer.h
-//
-// = AUTHOR
-// Bala <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file timer.h
+ *
+ * $Id$
+ *
+ * @author Bala <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TIMER_H
#define TIMER_H
@@ -26,49 +23,49 @@ class Timer_imp
{
public:
+ /// Constructor
Timer_imp (XtAppContext &,
CORBA::Long,
Stopwatch_display *);
- // Constructor
+ /// Destructor
virtual ~Timer_imp ();
- // Destructor
+ /// Resets, and starts the clock ticking
void start (void);
- // Resets, and starts the clock ticking
+ /// Stops the clock
void stop (void);
- // Stops the clock
+ /// Returns time since timer started
CORBA::Float elapsed_time (void);
- // Returns time since timer started
private:
+ /// Static member function used for TimeOut callback.
static void tick_callback (XtPointer,
XtIntervalId *);
- // Static member function used for TimeOut callback.
+ /// Called every interval_ milliseconds
void tick (void);
- // Called every interval_ milliseconds
+ /// Called at each clock tick...
virtual void report_time (CORBA::Float);
- // Called at each clock tick...
+ /// A copy of the stopwatch object
Stopwatch_display *stopwatch_;
- // A copy of the stopwatch object
+ /// Current number of ticks
CORBA::Long counter_;
- // Current number of ticks
+ /// Time in milliseconds between updates
CORBA::Long interval_;
- // Time in milliseconds between updates
+ /// Identifier of current TimeOut
XtIntervalId id_;
- // Identifier of current TimeOut
+ /// Required by Xt functions
XtAppContext app_;
- // Required by Xt functions
};
diff --git a/TAO/utils/catior/Catior_i.cpp b/TAO/utils/catior/Catior_i.cpp
index 122363bf237..5e7b348c523 100644
--- a/TAO/utils/catior/Catior_i.cpp
+++ b/TAO/utils/catior/Catior_i.cpp
@@ -1,24 +1,18 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/Utils/catior
-//
-// = FILENAME
-// Catior_i.cpp
-//
-// = DESCRIPTION
-// Reads stringified IORs and outputs the encoded information.
-//
-// = AUTHORS
-// Jeff Hopper <jrhopper@cts.com>
-// SCIOP and Tagged component modifications by:
-// Jason Cohen, Lockheed Martin ATL <jcohen@atl.lmco.com>
-// Split into a separate library by:
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Catior_i.cpp
+ *
+ * $Id$
+ *
+ * Reads stringified IORs and outputs the encoded information.
+ *
+ *
+ * @author Jeff Hopper <jrhopper@cts.com> SCIOP and Tagged component modifications by: Jason Cohen
+ * @author Lockheed Martin ATL <jcohen@atl.lmco.com> Split into a separate library by: Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#include "Catior_i.h"
#include "tao/Messaging_PolicyValueC.h"
diff --git a/TAO/utils/catior/Catior_i.h b/TAO/utils/catior/Catior_i.h
index c3750189c26..dc15b9f9bfb 100644
--- a/TAO/utils/catior/Catior_i.h
+++ b/TAO/utils/catior/Catior_i.h
@@ -1,27 +1,21 @@
-// $Id$
#ifndef CATIOR_I_H
#define CATIOR_I_H
-// ============================================================================
-//
-// = LIBRARY
-// TAO/Utils/catior
-//
-// = FILENAME
-// Catior_i.h
-//
-// = DESCRIPTION
-// Reads stringified IORs and outputs the encoded information.
-//
-// = AUTHORS
-// Jeff Hopper <jrhopper@cts.com>
-// SCIOP and Tagged component modifications by:
-// Jason Cohen, Lockheed Martin ATL <jcohen@atl.lmco.com>
-// Split into a separate library by:
-// Chad Elliott <elliott_c@ociweb.com>
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Catior_i.h
+ *
+ * $Id$
+ *
+ * Reads stringified IORs and outputs the encoded information.
+ *
+ *
+ * @author Jeff Hopper <jrhopper@cts.com> SCIOP and Tagged component modifications by: Jason Cohen
+ * @author Lockheed Martin ATL <jcohen@atl.lmco.com> Split into a separate library by: Chad Elliott <elliott_c@ociweb.com>
+ */
+//=============================================================================
+
#include "catior_export.h"
#include "ace/String_Base.h"
diff --git a/TAO/utils/nslist/nsadd.cpp b/TAO/utils/nslist/nsadd.cpp
index 265aff18561..31a65458e84 100644
--- a/TAO/utils/nslist/nsadd.cpp
+++ b/TAO/utils/nslist/nsadd.cpp
@@ -1,22 +1,18 @@
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// utils
-//
-// = FILENAME
-// nsadd.cpp
-//
-// = DESCRIPTION
-// Naming Service add utility
-//
-// = AUTHOR
-// Carlos O'Ryan
-// enhanced Nov 6, 2002 Paul Caffrey <denginere@hotmail.com>
-// redone Jun 21 2006 Simon Massey <sma@prismtech.com>
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file nsadd.cpp
+ *
+ * $Id$
+ *
+ * Naming Service add utility
+ *
+ *
+ * @author Carlos O'Ryan enhanced Nov 6
+ * @author 2002 Paul Caffrey <denginere@hotmail.com> redone Jun 21 2006 Simon Massey <sma@prismtech.com>
+ */
+//=============================================================================
+
#include "orbsvcs/CosNamingC.h"
#include "ace/Log_Msg.h"
diff --git a/TAO/utils/nslist/nsdel.cpp b/TAO/utils/nslist/nsdel.cpp
index 9f6fdae2315..d5d66818015 100644
--- a/TAO/utils/nslist/nsdel.cpp
+++ b/TAO/utils/nslist/nsdel.cpp
@@ -1,22 +1,19 @@
-// $Id$
-// ================================================================
-//
-// = LIBRARY
-// utils
-//
-// = FILENAME
-// nsdel.cpp
-//
-// = DESCRIPTION
-// Naming Service del utility
-//
-// = AUTHOR
-// Carlos O'Ryan <coryan@uci.edu>
-// enhanced Jan 15, 2001 Paul Caffrey <denginere@hotmail.com>
-// redone Jun 21, 2006 Simon Massey <sma@prismtech.com>
-//
-// ================================================================
+//=============================================================================
+/**
+ * @file nsdel.cpp
+ *
+ * $Id$
+ *
+ * Naming Service del utility
+ *
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu> enhanced Jan 15
+ * @author 2001 Paul Caffrey <denginere@hotmail.com> redone Jun 21
+ * @author 2006 Simon Massey <sma@prismtech.com>
+ */
+//=============================================================================
+
#include "orbsvcs/CosNamingC.h"
#include "orbsvcs/Time_Utilities.h"