diff options
| author | Johnny Willemsen <jwillemsen@remedy.nl> | 2011-03-24 13:16:05 +0000 |
|---|---|---|
| committer | Johnny Willemsen <jwillemsen@remedy.nl> | 2011-03-24 13:16:05 +0000 |
| commit | d55f4b979a3b2e7c650778e2abd38972556db231 (patch) | |
| tree | 5bb72d5f3dfa2bc68544c387f81f06b9d77ac00c | |
| parent | f306443c73889b0cd923f8e521abf3e270aa92be (diff) | |
| download | ATCD-d55f4b979a3b2e7c650778e2abd38972556db231.tar.gz | |
Thu Mar 24 13:10:02 UTC 2011 Johnny Willemsen <jwillemsen@remedy.nl>
* tests/ACE_Init_Test.h:
* tests/ACE_Init_Test_Resource.h:
* tests/ACE_Init_Test_StdAfx.h:
* tests/Aio_Platform_Test.cpp:
* tests/Atomic_Op_Test.cpp:
* tests/Auto_Event_Test.cpp:
* tests/Auto_IncDec_Test.cpp:
* tests/Barrier_Test.cpp:
* tests/Based_Pointer_Test.cpp:
* tests/Based_Pointer_Test_Lib.cpp:
* tests/Basic_Types_Test.cpp:
* tests/Bound_Ptr_Test.h:
* tests/Buffer_Stream_Test.cpp:
* tests/Bug_2434_Regression_Test.cpp:
* tests/Bug_2653_Regression_Test.cpp:
* tests/Bug_2659_Regression_Test.cpp:
* tests/Bug_3539_Regression_Test.cpp:
* tests/Bug_3729_Regression_Test.cpp:
* tests/CDR_Array_Test.cpp:
* tests/CDR_File_Test.cpp:
* tests/CDR_Test.cpp:
* tests/Cache_Map_Manager_Test.h:
* tests/Cache_Map_Manager_Test.cpp:
* tests/Cached_Accept_Conn_Test.h:
* tests/Cached_Accept_Conn_Test.cpp:
* tests/Cached_Allocator_Test.cpp:
* tests/Cached_Conn_Test.h:
* tests/Cached_Conn_Test.cpp:
* tests/Capabilities_Test.cpp:
* tests/Codecs_Test.cpp:
* tests/Collection_Test.h:
* tests/Collection_Test.cpp:
* tests/Config_Test.h:
* tests/Config_Test.cpp:
* tests/Conn_Test.h:
* tests/Conn_Test.cpp:
* tests/DLL_Test.cpp:
* tests/DLL_Test_Impl.h:
* tests/DLL_Test_Impl.cpp:
* tests/DLList_Test.cpp:
* tests/Dirent_Test.cpp:
* tests/Dynamic_Priority_Test.cpp:
* tests/Dynamic_Test.cpp:
* tests/Enum_Interfaces_Test.cpp:
* tests/FIFO_Test.cpp:
* tests/FlReactor_Test.cpp:
* tests/Framework_Component_DLL.h:
* tests/Framework_Component_DLL.cpp:
* tests/Framework_Component_Test.h:
* tests/Future_Set_Test.cpp:
* tests/Future_Test.cpp:
* tests/Handle_Set_Test.cpp:
* tests/Hash_Map_Bucket_Iterator_Test.cpp:
* tests/Hash_Map_Manager_Test.cpp:
* tests/Hash_Multi_Map_Manager_Test.cpp:
* tests/High_Res_Timer_Test.cpp:
* tests/INET_Addr_Test.cpp:
* tests/IOStream_Test.cpp:
* tests/Intrusive_Auto_Ptr_Test.cpp:
* tests/Lazy_Map_Manager_Test.cpp:
* tests/Log_Msg_Backend_Test.cpp:
* tests/Log_Msg_Test.cpp:
* tests/Logging_Strategy_Test.cpp:
* tests/MEM_Stream_Test.h:
* tests/MEM_Stream_Test.cpp:
* tests/MM_Shared_Memory_Test.cpp:
* tests/MT_NonBlocking_Connect_Test.cpp:
* tests/MT_Reactor_Timer_Test.h:
* tests/MT_Reactor_Timer_Test.cpp:
* tests/MT_Reactor_Upcall_Test.cpp:
* tests/MT_Reference_Counted_Event_Handler_Test.cpp:
* tests/MT_Reference_Counted_Notify_Test.cpp:
* tests/MT_SOCK_Test.cpp:
* tests/Main.cpp:
* tests/Malloc_Test.h:
* tests/Malloc_Test.cpp:
* tests/Manual_Event_Test.cpp:
* tests/Map_Manager_Test.cpp:
* tests/Map_Test.h:
* tests/Map_Test.cpp:
* tests/Max_Default_Port_Test.h:
* tests/Max_Default_Port_Test.cpp:
* tests/Mem_Map_Test.cpp:
* tests/Message_Block_Test.cpp:
* tests/Message_Queue_Notifications_Test.cpp:
* tests/Message_Queue_Test.cpp:
* tests/Message_Queue_Test_Ex.cpp:
* tests/Missing_Svc_Conf_Test.cpp:
* tests/Multihomed_INET_Addr_Test.cpp:
* tests/Multihomed_INET_Addr_Test_IPV6.cpp:
* tests/NDDS_Timer_Test.cpp:
* tests/Naming_Test.cpp:
* tests/Network_Adapters_Test.h:
* tests/Network_Adapters_Test.cpp:
* tests/New_Fail_Test.cpp:
* tests/NonBlocking_Conn_Test.h:
* tests/NonBlocking_Conn_Test.cpp:
* tests/Notify_Performance_Test.cpp:
* tests/Object_Manager_Flipping_Test.cpp:
* tests/Object_Manager_Test.cpp:
* tests/Obstack_Test.cpp:
* tests/OrdMultiSet_Test.cpp:
* tests/Pipe_Test.cpp:
* tests/Priority_Buffer_Test.cpp:
* tests/Priority_Reactor_Test.h:
* tests/Priority_Reactor_Test.cpp:
* tests/Priority_Task_Test.cpp:
* tests/Proactor_Test.h:
* tests/Proactor_Timer_Test.cpp:
* tests/Process_Env_Test.cpp:
* tests/Process_Manager_Test.cpp:
* tests/Process_Manual_Event_Test.cpp:
* tests/Process_Mutex_Test.cpp:
* tests/Process_Semaphore_Test.cpp:
* tests/Process_Strategy_Test.h:
* tests/Process_Strategy_Test.cpp:
* tests/Process_Test.cpp:
* tests/QtReactor_Test.cpp:
* tests/RB_Tree_Test.h:
* tests/RB_Tree_Test.cpp:
* tests/RW_Process_Mutex_Test.cpp:
* tests/Reactor_Dispatch_Order_Test.cpp:
* tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp:
* tests/Reactor_Exceptions_Test.cpp:
* tests/Reactor_Fairness_Test.h:
* tests/Reactor_Fairness_Test.cpp:
* tests/Reactor_Notify_Test.cpp:
* tests/Reactor_Performance_Test.h:
* tests/Reactor_Performance_Test.cpp:
* tests/Reactor_Registration_Test.cpp:
* tests/Reactor_Timer_Test.cpp:
* tests/Reactors_Test.cpp:
* tests/Reader_Writer_Test.cpp:
* tests/Recursive_Condition_Bug_Test.cpp:
* tests/Recursive_Condition_Test.cpp:
* tests/Recursive_Mutex_Test.cpp:
* tests/Refcounted_Auto_Ptr_Test.h:
* tests/Refcounted_Event_Handler_Test_DevPoll.cpp:
* tests/Reference_Counted_Event_Handler_Test.cpp:
* tests/Reverse_Lock_Test.cpp:
* tests/SOCK_Connector_Test.cpp:
* tests/SOCK_Dgram_Bcast_Test.cpp:
* tests/SOCK_Dgram_Test.cpp:
* tests/SOCK_Netlink_Test.cpp:
* tests/SOCK_SEQPACK_SCTP_Test.cpp:
* tests/SOCK_Send_Recv_Test.cpp:
* tests/SOCK_Test.cpp:
* tests/SPIPE_Test.cpp:
* tests/SSL/Main.cpp:
* tests/SSL/SSL_Asynch_Stream_Test.cpp:
* tests/SSL/Thread_Pool_Reactor_SSL_Test.h:
* tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp:
* tests/SString_Test.cpp:
* tests/SV_Shared_Memory_Test.cpp:
* tests/Semaphore_Test.cpp:
* tests/Sig_Handlers_Test.cpp:
* tests/Signal_Test.cpp:
* tests/Sigset_Ops_Test.cpp:
* tests/Simple_Message_Block_Test.cpp:
* tests/Singleton_Test.cpp:
* tests/Svc_Handler_Test.cpp:
* tests/TP_Reactor_Test.h:
* tests/TP_Reactor_Test.cpp:
* tests/TSS_Static_Test.cpp:
* tests/TSS_Test.cpp:
* tests/TSS_Test_Errno.h:
* tests/Task_Ex_Test.cpp:
* tests/Task_Test.cpp:
* tests/Thread_Attrs_Test.cpp:
* tests/Thread_Creation_Threshold_Test.cpp:
* tests/Thread_Manager_Test.cpp:
* tests/Thread_Mutex_Test.cpp:
* tests/Thread_Pool_Reactor_Resume_Test.h:
* tests/Thread_Pool_Reactor_Resume_Test.cpp:
* tests/Thread_Pool_Reactor_Test.h:
* tests/Thread_Pool_Reactor_Test.cpp:
* tests/Thread_Pool_Test.cpp:
* tests/Time_Service_Test.cpp:
* tests/Time_Value_Test.cpp:
* tests/Timeprobe_Test.cpp:
* tests/Timer_Cancellation_Test.cpp:
* tests/Timer_Queue_Reference_Counting_Test.cpp:
* tests/Timer_Queue_Test.cpp:
* tests/TkReactor_Test.cpp:
* tests/Tokens_Test.cpp:
* tests/UPIPE_SAP_Test.cpp:
* tests/UUID_Test.cpp:
* tests/Unbounded_Set_Test.cpp:
* tests/Unload_libACE.cpp:
* tests/Upgradable_RW_Test.h:
* tests/Upgradable_RW_Test.cpp:
* tests/Vector_Test.cpp:
* tests/WFMO_Reactor_Test.cpp:
* tests/XtAthenaReactor_Test.cpp:
* tests/XtMotifReactor_Test.cpp:
Converted to doxygen style of documentation
196 files changed, 4167 insertions, 4782 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog index 71a196f1895..535e31a2dfe 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,202 @@ +Thu Mar 24 13:10:02 UTC 2011 Johnny Willemsen <jwillemsen@remedy.nl> + + * tests/ACE_Init_Test.h: + * tests/ACE_Init_Test_Resource.h: + * tests/ACE_Init_Test_StdAfx.h: + * tests/Aio_Platform_Test.cpp: + * tests/Atomic_Op_Test.cpp: + * tests/Auto_Event_Test.cpp: + * tests/Auto_IncDec_Test.cpp: + * tests/Barrier_Test.cpp: + * tests/Based_Pointer_Test.cpp: + * tests/Based_Pointer_Test_Lib.cpp: + * tests/Basic_Types_Test.cpp: + * tests/Bound_Ptr_Test.h: + * tests/Buffer_Stream_Test.cpp: + * tests/Bug_2434_Regression_Test.cpp: + * tests/Bug_2653_Regression_Test.cpp: + * tests/Bug_2659_Regression_Test.cpp: + * tests/Bug_3539_Regression_Test.cpp: + * tests/Bug_3729_Regression_Test.cpp: + * tests/CDR_Array_Test.cpp: + * tests/CDR_File_Test.cpp: + * tests/CDR_Test.cpp: + * tests/Cache_Map_Manager_Test.h: + * tests/Cache_Map_Manager_Test.cpp: + * tests/Cached_Accept_Conn_Test.h: + * tests/Cached_Accept_Conn_Test.cpp: + * tests/Cached_Allocator_Test.cpp: + * tests/Cached_Conn_Test.h: + * tests/Cached_Conn_Test.cpp: + * tests/Capabilities_Test.cpp: + * tests/Codecs_Test.cpp: + * tests/Collection_Test.h: + * tests/Collection_Test.cpp: + * tests/Config_Test.h: + * tests/Config_Test.cpp: + * tests/Conn_Test.h: + * tests/Conn_Test.cpp: + * tests/DLL_Test.cpp: + * tests/DLL_Test_Impl.h: + * tests/DLL_Test_Impl.cpp: + * tests/DLList_Test.cpp: + * tests/Dirent_Test.cpp: + * tests/Dynamic_Priority_Test.cpp: + * tests/Dynamic_Test.cpp: + * tests/Enum_Interfaces_Test.cpp: + * tests/FIFO_Test.cpp: + * tests/FlReactor_Test.cpp: + * tests/Framework_Component_DLL.h: + * tests/Framework_Component_DLL.cpp: + * tests/Framework_Component_Test.h: + * tests/Future_Set_Test.cpp: + * tests/Future_Test.cpp: + * tests/Handle_Set_Test.cpp: + * tests/Hash_Map_Bucket_Iterator_Test.cpp: + * tests/Hash_Map_Manager_Test.cpp: + * tests/Hash_Multi_Map_Manager_Test.cpp: + * tests/High_Res_Timer_Test.cpp: + * tests/INET_Addr_Test.cpp: + * tests/IOStream_Test.cpp: + * tests/Intrusive_Auto_Ptr_Test.cpp: + * tests/Lazy_Map_Manager_Test.cpp: + * tests/Log_Msg_Backend_Test.cpp: + * tests/Log_Msg_Test.cpp: + * tests/Logging_Strategy_Test.cpp: + * tests/MEM_Stream_Test.h: + * tests/MEM_Stream_Test.cpp: + * tests/MM_Shared_Memory_Test.cpp: + * tests/MT_NonBlocking_Connect_Test.cpp: + * tests/MT_Reactor_Timer_Test.h: + * tests/MT_Reactor_Timer_Test.cpp: + * tests/MT_Reactor_Upcall_Test.cpp: + * tests/MT_Reference_Counted_Event_Handler_Test.cpp: + * tests/MT_Reference_Counted_Notify_Test.cpp: + * tests/MT_SOCK_Test.cpp: + * tests/Main.cpp: + * tests/Malloc_Test.h: + * tests/Malloc_Test.cpp: + * tests/Manual_Event_Test.cpp: + * tests/Map_Manager_Test.cpp: + * tests/Map_Test.h: + * tests/Map_Test.cpp: + * tests/Max_Default_Port_Test.h: + * tests/Max_Default_Port_Test.cpp: + * tests/Mem_Map_Test.cpp: + * tests/Message_Block_Test.cpp: + * tests/Message_Queue_Notifications_Test.cpp: + * tests/Message_Queue_Test.cpp: + * tests/Message_Queue_Test_Ex.cpp: + * tests/Missing_Svc_Conf_Test.cpp: + * tests/Multihomed_INET_Addr_Test.cpp: + * tests/Multihomed_INET_Addr_Test_IPV6.cpp: + * tests/NDDS_Timer_Test.cpp: + * tests/Naming_Test.cpp: + * tests/Network_Adapters_Test.h: + * tests/Network_Adapters_Test.cpp: + * tests/New_Fail_Test.cpp: + * tests/NonBlocking_Conn_Test.h: + * tests/NonBlocking_Conn_Test.cpp: + * tests/Notify_Performance_Test.cpp: + * tests/Object_Manager_Flipping_Test.cpp: + * tests/Object_Manager_Test.cpp: + * tests/Obstack_Test.cpp: + * tests/OrdMultiSet_Test.cpp: + * tests/Pipe_Test.cpp: + * tests/Priority_Buffer_Test.cpp: + * tests/Priority_Reactor_Test.h: + * tests/Priority_Reactor_Test.cpp: + * tests/Priority_Task_Test.cpp: + * tests/Proactor_Test.h: + * tests/Proactor_Timer_Test.cpp: + * tests/Process_Env_Test.cpp: + * tests/Process_Manager_Test.cpp: + * tests/Process_Manual_Event_Test.cpp: + * tests/Process_Mutex_Test.cpp: + * tests/Process_Semaphore_Test.cpp: + * tests/Process_Strategy_Test.h: + * tests/Process_Strategy_Test.cpp: + * tests/Process_Test.cpp: + * tests/QtReactor_Test.cpp: + * tests/RB_Tree_Test.h: + * tests/RB_Tree_Test.cpp: + * tests/RW_Process_Mutex_Test.cpp: + * tests/Reactor_Dispatch_Order_Test.cpp: + * tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp: + * tests/Reactor_Exceptions_Test.cpp: + * tests/Reactor_Fairness_Test.h: + * tests/Reactor_Fairness_Test.cpp: + * tests/Reactor_Notify_Test.cpp: + * tests/Reactor_Performance_Test.h: + * tests/Reactor_Performance_Test.cpp: + * tests/Reactor_Registration_Test.cpp: + * tests/Reactor_Timer_Test.cpp: + * tests/Reactors_Test.cpp: + * tests/Reader_Writer_Test.cpp: + * tests/Recursive_Condition_Bug_Test.cpp: + * tests/Recursive_Condition_Test.cpp: + * tests/Recursive_Mutex_Test.cpp: + * tests/Refcounted_Auto_Ptr_Test.h: + * tests/Refcounted_Event_Handler_Test_DevPoll.cpp: + * tests/Reference_Counted_Event_Handler_Test.cpp: + * tests/Reverse_Lock_Test.cpp: + * tests/SOCK_Connector_Test.cpp: + * tests/SOCK_Dgram_Bcast_Test.cpp: + * tests/SOCK_Dgram_Test.cpp: + * tests/SOCK_Netlink_Test.cpp: + * tests/SOCK_SEQPACK_SCTP_Test.cpp: + * tests/SOCK_Send_Recv_Test.cpp: + * tests/SOCK_Test.cpp: + * tests/SPIPE_Test.cpp: + * tests/SSL/Main.cpp: + * tests/SSL/SSL_Asynch_Stream_Test.cpp: + * tests/SSL/Thread_Pool_Reactor_SSL_Test.h: + * tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp: + * tests/SString_Test.cpp: + * tests/SV_Shared_Memory_Test.cpp: + * tests/Semaphore_Test.cpp: + * tests/Sig_Handlers_Test.cpp: + * tests/Signal_Test.cpp: + * tests/Sigset_Ops_Test.cpp: + * tests/Simple_Message_Block_Test.cpp: + * tests/Singleton_Test.cpp: + * tests/Svc_Handler_Test.cpp: + * tests/TP_Reactor_Test.h: + * tests/TP_Reactor_Test.cpp: + * tests/TSS_Static_Test.cpp: + * tests/TSS_Test.cpp: + * tests/TSS_Test_Errno.h: + * tests/Task_Ex_Test.cpp: + * tests/Task_Test.cpp: + * tests/Thread_Attrs_Test.cpp: + * tests/Thread_Creation_Threshold_Test.cpp: + * tests/Thread_Manager_Test.cpp: + * tests/Thread_Mutex_Test.cpp: + * tests/Thread_Pool_Reactor_Resume_Test.h: + * tests/Thread_Pool_Reactor_Resume_Test.cpp: + * tests/Thread_Pool_Reactor_Test.h: + * tests/Thread_Pool_Reactor_Test.cpp: + * tests/Thread_Pool_Test.cpp: + * tests/Time_Service_Test.cpp: + * tests/Time_Value_Test.cpp: + * tests/Timeprobe_Test.cpp: + * tests/Timer_Cancellation_Test.cpp: + * tests/Timer_Queue_Reference_Counting_Test.cpp: + * tests/Timer_Queue_Test.cpp: + * tests/TkReactor_Test.cpp: + * tests/Tokens_Test.cpp: + * tests/UPIPE_SAP_Test.cpp: + * tests/UUID_Test.cpp: + * tests/Unbounded_Set_Test.cpp: + * tests/Unload_libACE.cpp: + * tests/Upgradable_RW_Test.h: + * tests/Upgradable_RW_Test.cpp: + * tests/Vector_Test.cpp: + * tests/WFMO_Reactor_Test.cpp: + * tests/XtAthenaReactor_Test.cpp: + * tests/XtMotifReactor_Test.cpp: + Converted to doxygen style of documentation + Wed Mar 23 18:36:19 UTC 2011 Johnny Willemsen <jwillemsen@remedy.nl> * bin/fuzz.pl: diff --git a/ACE/tests/ACE_Init_Test.h b/ACE/tests/ACE_Init_Test.h index 3916ff61b6f..af27d99905c 100644 --- a/ACE/tests/ACE_Init_Test.h +++ b/ACE/tests/ACE_Init_Test.h @@ -1,21 +1,18 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// ACE_Init_Test.h -// -// = DESCRIPTION -// Main header file for the ACE_INIT_TEST application. -// -// = AUTHOR -// Steve Huston <shuston@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file ACE_Init_Test.h + * + * $Id$ + * + * Main header file for the ACE_INIT_TEST application. + * + * + * @author Steve Huston <shuston@cs.wustl.edu> + */ +//============================================================================= + #ifndef AFX_ACE_INIT_TEST_H__64FDC9FE_F7F9_11D2_89B6_00A024CC68DB__INCLUDED_ #define AFX_ACE_INIT_TEST_H__64FDC9FE_F7F9_11D2_89B6_00A024CC68DB__INCLUDED_ @@ -30,10 +27,13 @@ #include "ACE_Init_Test_Resource.h" // main symbols +/** + * @class CACE_Init_TestApp + * + * @brief See ACE_Init_Test.cpp for the implementation of this class + */ class CACE_Init_TestApp : public CWinApp { - // = TITLE - // See ACE_Init_Test.cpp for the implementation of this class public: CACE_Init_TestApp (void); @@ -41,8 +41,8 @@ public: // ClassWizard generated virtual function overrides //{{AFX_VIRTUAL(CACE_Init_TestApp) public: + ///}}AFX_VIRTUAL virtual BOOL InitInstance(); - //}}AFX_VIRTUAL // Implementation diff --git a/ACE/tests/ACE_Init_Test_Resource.h b/ACE/tests/ACE_Init_Test_Resource.h index 830d123178d..604c0bc03ff 100644 --- a/ACE/tests/ACE_Init_Test_Resource.h +++ b/ACE/tests/ACE_Init_Test_Resource.h @@ -1,21 +1,18 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// ACE_Init_Test_Resource.h -// -// = DESCRIPTION -// Header file for the ACE_INIT_TEST application. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ +//============================================================================= +/** + * @file ACE_Init_Test_Resource.h + * + * $Id$ + * + * Header file for the ACE_INIT_TEST application. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + //{{NO_DEPENDENCIES}} // Microsoft Visual C++ generated include file. diff --git a/ACE/tests/ACE_Init_Test_StdAfx.h b/ACE/tests/ACE_Init_Test_StdAfx.h index 9aa682148ef..8c121c562dc 100644 --- a/ACE/tests/ACE_Init_Test_StdAfx.h +++ b/ACE/tests/ACE_Init_Test_StdAfx.h @@ -1,23 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// ACE_Init_Test_StdAfx.h -// -// = DESCRIPTION -// stdafx.h : include file for standard system include files, -// or project specific include files that are used frequently, but -// are changed infrequently -// -// = AUTHOR -// Steve Huston <shuston@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file ACE_Init_Test_StdAfx.h + * + * $Id$ + * + * stdafx.h : include file for standard system include files, + * or project specific include files that are used frequently, but + * are changed infrequently + * + * + * @author Steve Huston <shuston@cs.wustl.edu> + */ +//============================================================================= + #ifndef AFX_STDAFX_H__64FDCA02_F7F9_11D2_89B6_00A024CC68DB__INCLUDED_ #define AFX_STDAFX_H__64FDCA02_F7F9_11D2_89B6_00A024CC68DB__INCLUDED_ diff --git a/ACE/tests/Aio_Platform_Test.cpp b/ACE/tests/Aio_Platform_Test.cpp index 0713fe1d7ac..969c3aa6de5 100644 --- a/ACE/tests/Aio_Platform_Test.cpp +++ b/ACE/tests/Aio_Platform_Test.cpp @@ -1,22 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = FILENAME -// aio_platform_test.cpp -// -// = DESCRITPTION -// Testing the platform for POSIX Asynchronous I/O. Basically -// prints the predefined constants and also checks for their run -// time values. If this test succeeds further tests at -// $ACE_ROOT/examples/Reactor/Proactor can be used to test the -// features further. -// -// = AUTHOR -// Programming for the Real World. Bill O. GallMeister. Modified -// by Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ===================================================================== + +//============================================================================= +/** + * @file Aio_Platform_Test.cpp + * + * Testing the platform for POSIX Asynchronous I/O. Basically + * prints the predefined constants and also checks for their run + * time values. If this test succeeds further tests at + * $ACE_ROOT/examples/Reactor/Proactor can be used to test the + * features further. + * + * $Id$ + * + * @author Programming for the Real World. Bill O. GallMeister. Modified by Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/Atomic_Op_Test.cpp b/ACE/tests/Atomic_Op_Test.cpp index c59fe00c576..98a30d27cce 100644 --- a/ACE/tests/Atomic_Op_Test.cpp +++ b/ACE/tests/Atomic_Op_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Atomic_Op_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the Atomic Operations Class in ACE. -// On platforms like Win32, ACE uses template specialization to -// use native implementations provided by the OS to accelarate -// these operations. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Atomic_Op_Test.cpp + * + * $Id$ + * + * This is a simple test of the Atomic Operations Class in ACE. + * On platforms like Win32, ACE uses template specialization to + * use native implementations provided by the OS to accelarate + * these operations. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/Auto_Event_Test.cpp b/ACE/tests/Auto_Event_Test.cpp index 28a3977b914..beeae1d7b4c 100644 --- a/ACE/tests/Auto_Event_Test.cpp +++ b/ACE/tests/Auto_Event_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Auto_Event Test -// -// = DESCRIPTION -// This test verifies the functionality of the <ACE_Auto_Event> -// implementation. -// -// = AUTHOR -// Martin Corino <mcorino@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Auto_Event_Test.cpp + * + * $Id$ + * + * This test verifies the functionality of the <ACE_Auto_Event> + * implementation. + * + * + * @author Martin Corino <mcorino@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Auto_Event.h" diff --git a/ACE/tests/Auto_IncDec_Test.cpp b/ACE/tests/Auto_IncDec_Test.cpp index 7311f9db76d..2ead05cd008 100644 --- a/ACE/tests/Auto_IncDec_Test.cpp +++ b/ACE/tests/Auto_IncDec_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -//============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Auto_IncDec_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the Auto Increment/Decrement Class in -// ACE. -// -// = AUTHOR -// Edan Ayal <EdanA@cti2.com> -// -//============================================================================ + +//============================================================================= +/** + * @file Auto_IncDec_Test.cpp + * + * $Id$ + * + * This is a simple test of the Auto Increment/Decrement Class in + * ACE. + * + * + * @author Edan Ayal <EdanA@cti2.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Auto_IncDec_T.h" diff --git a/ACE/tests/Barrier_Test.cpp b/ACE/tests/Barrier_Test.cpp index dfd4727a15a..ff507d71e9e 100644 --- a/ACE/tests/Barrier_Test.cpp +++ b/ACE/tests/Barrier_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Barrier_Test.cpp -// -// = DESCRIPTION -// This program illustrates how the ACE barrier synchronization -// mechanisms work. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Barrier_Test.cpp + * + * $Id$ + * + * This program illustrates how the ACE barrier synchronization + * mechanisms work. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Barrier.h" diff --git a/ACE/tests/Based_Pointer_Test.cpp b/ACE/tests/Based_Pointer_Test.cpp index b877108f7ca..faf136cfff0 100644 --- a/ACE/tests/Based_Pointer_Test.cpp +++ b/ACE/tests/Based_Pointer_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Based_Pointer_Test.cpp -// -// = DESCRIPTION -// This test check the Based_Pointer and Based_Pointer_repository classes. -// -// = AUTHOR -// Steve Williams <steve@telxio> -// -// ============================================================================ + +//============================================================================= +/** + * @file Based_Pointer_Test.cpp + * + * $Id$ + * + * This test check the Based_Pointer and Based_Pointer_repository classes. + * + * + * @author Steve Williams <steve@telxio> + */ +//============================================================================= + #include "test_config.h" #include "ace/DLL.h" diff --git a/ACE/tests/Based_Pointer_Test_Lib.cpp b/ACE/tests/Based_Pointer_Test_Lib.cpp index 146ff126ddc..24c586be925 100644 --- a/ACE/tests/Based_Pointer_Test_Lib.cpp +++ b/ACE/tests/Based_Pointer_Test_Lib.cpp @@ -1,20 +1,17 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Based_Pointer_Test_Lib.cpp -// -// = DESCRIPTION -// This test confirms the function of the Based_Pointer_Repository -// -// = AUTHOR -// Steve Williams <steve@telxio> -// -// ============================================================================ +//============================================================================= +/** + * @file Based_Pointer_Test_Lib.cpp + * + * $Id$ + * + * This test confirms the function of the Based_Pointer_Repository + * + * + * @author Steve Williams <steve@telxio> + */ +//============================================================================= + #include "ace/ACE.h" #include "ace/svc_export.h" diff --git a/ACE/tests/Basic_Types_Test.cpp b/ACE/tests/Basic_Types_Test.cpp index c3ff6dce504..64c5b49ff00 100644 --- a/ACE/tests/Basic_Types_Test.cpp +++ b/ACE/tests/Basic_Types_Test.cpp @@ -1,20 +1,16 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Basic_Types_Test.cpp -// -// = DESCRIPTION -// Checks the #defines in ace/Basic_Types.h, and a few other basics. -// -// = AUTHOR -// David L. Levine <levine@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Basic_Types_Test.cpp + * + * $Id$ + * + * Checks the #defines in ace/Basic_Types.h, and a few other basics. + * + * + * @author David L. Levine <levine@cs.wustl.edu> + */ +//============================================================================= + #include "ace/config-all.h" // Don't use the ACE version accessors in class ACE, so that we can diff --git a/ACE/tests/Bound_Ptr_Test.h b/ACE/tests/Bound_Ptr_Test.h index 9b72c7863d1..a45f5557e60 100644 --- a/ACE/tests/Bound_Ptr_Test.h +++ b/ACE/tests/Bound_Ptr_Test.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bound_Ptr_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// @author Christopher Kohlhoff <chris@kohlhoff.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Bound_Ptr_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author @author Christopher Kohlhoff <chris@kohlhoff.com> + */ +//============================================================================= + #ifndef ACE_TESTS_BOUND_PTR_TEST_H #define ACE_TESTS_BOUND_PTR_TEST_H diff --git a/ACE/tests/Buffer_Stream_Test.cpp b/ACE/tests/Buffer_Stream_Test.cpp index 715d6d97b9f..424ca2dff29 100644 --- a/ACE/tests/Buffer_Stream_Test.cpp +++ b/ACE/tests/Buffer_Stream_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Buffer_Stream_Test.cpp -// -// = DESCRIPTION -// This program illustrates an implementation of the classic -// "bounded buffer" program using an ASX STREAM containing two -// Modules. Each ACE_Module contains two Tasks. Each ACE_Task -// contains a ACE_Message_Queue and a pointer to a -// ACE_Thread_Manager. Note how the use of these reusable -// components reduces the reliance on global variables. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Buffer_Stream_Test.cpp + * + * $Id$ + * + * This program illustrates an implementation of the classic + * "bounded buffer" program using an ASX STREAM containing two + * Modules. Each ACE_Module contains two Tasks. Each ACE_Task + * contains a ACE_Message_Queue and a pointer to a + * ACE_Thread_Manager. Note how the use of these reusable + * components reduces the reliance on global variables. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Stream.h" @@ -38,48 +35,57 @@ typedef ACE_Stream<ACE_MT_SYNCH> MT_Stream; typedef ACE_Module<ACE_MT_SYNCH> MT_Module; typedef ACE_Task<ACE_MT_SYNCH> MT_Task; +/** + * @class Common_Task + * + * @brief Methods that are common to the Supplier and consumer. + */ class Common_Task : public MT_Task - // = TITLE - // Methods that are common to the Supplier and consumer. { public: Common_Task (void) {} //FUZZ: disable check_for_lack_ACE_OS // = ACE_Task hooks. + ///FUZZ: enable check_for_lack_ACE_OS virtual int open (void * = 0); virtual int close (u_long = 0); - //FUZZ: enable check_for_lack_ACE_OS }; +/** + * @class Supplier + * + * @brief Define the Supplier interface. + */ class Supplier : public Common_Task -// = TITLE -// Define the Supplier interface. { public: Supplier (void) {} + /// Read data from stdin and pass to consumer. virtual int svc (void); - // Read data from stdin and pass to consumer. }; +/** + * @class Consumer + * + * @brief Define the Consumer interface. + */ class Consumer : public Common_Task - // = TITLE - // Define the Consumer interface. { public: Consumer (void) {} + /// Enqueue the message on the ACE_Message_Queue for subsequent + /// handling in the svc() method. virtual int put (ACE_Message_Block *mb, ACE_Time_Value *tv = 0); - // Enqueue the message on the ACE_Message_Queue for subsequent - // handling in the svc() method. + /// Receive message from Supplier and print to stdout. virtual int svc (void); - // Receive message from Supplier and print to stdout. private: + /// Amount of time to wait for a timeout. ACE_Time_Value timeout_; - // Amount of time to wait for a timeout. }; // Spawn off a new thread. diff --git a/ACE/tests/Bug_2434_Regression_Test.cpp b/ACE/tests/Bug_2434_Regression_Test.cpp index a0fe2cb84af..8f6af24548a 100644 --- a/ACE/tests/Bug_2434_Regression_Test.cpp +++ b/ACE/tests/Bug_2434_Regression_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bug_2434_Regression_Test.cpp -// -// = DESCRIPTION -// This is a simple test of ACE_Time_Value. No command line arguments -// are needed to run the test. It also tests the ACE_U_LongLong class. -// Because ACE_U_LongLong is used for ACE_hrtime_t on some platforms, -// this seems like a reasonable place to test it. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and David Levine <levine@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Bug_2434_Regression_Test.cpp + * + * $Id$ + * + * This is a simple test of ACE_Time_Value. No command line arguments + * are needed to run the test. It also tests the ACE_U_LongLong class. + * Because ACE_U_LongLong is used for ACE_hrtime_t on some platforms, + * this seems like a reasonable place to test it. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and David Levine <levine@cs.wustl.edu> + */ +//============================================================================= + // Note, for this test the config.h file *must* come first! #include "ace/config-all.h" diff --git a/ACE/tests/Bug_2653_Regression_Test.cpp b/ACE/tests/Bug_2653_Regression_Test.cpp index 60f898da537..96f53f130f3 100644 --- a/ACE/tests/Bug_2653_Regression_Test.cpp +++ b/ACE/tests/Bug_2653_Regression_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bug_2653_Regression_Test.cpp -// -// = DESCRIPTION -// This bug occurs when schedule_wakeup is called for a handle that does -// not already have an event handler registered. This can happen quite -// legitimately in multithreaded applications where one thread schedules -// the wakeup while another thread is handling the closure of the -// connection and unregistering. -// -// = AUTHOR -// Phil Mesnier <mesnier_p@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Bug_2653_Regression_Test.cpp + * + * $Id$ + * + * This bug occurs when schedule_wakeup is called for a handle that does + * not already have an event handler registered. This can happen quite + * legitimately in multithreaded applications where one thread schedules + * the wakeup while another thread is handling the closure of the + * connection and unregistering. + * + * + * @author Phil Mesnier <mesnier_p@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Bug_2659_Regression_Test.cpp b/ACE/tests/Bug_2659_Regression_Test.cpp index 10be56ada27..d5a06913a41 100644 --- a/ACE/tests/Bug_2659_Regression_Test.cpp +++ b/ACE/tests/Bug_2659_Regression_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bug_2659_Regression_Test.cpp -// -// = DESCRIPTION -// Reproduces the problems reported in bug 2659: -// http://deuce.doc.wustl.edu/bugzilla/show_bug.cgi?id=2659 -// -// = AUTHOR -// Ciju John <johnc at ociweb> -// -// ============================================================================ + +//============================================================================= +/** + * @file Bug_2659_Regression_Test.cpp + * + * $Id$ + * + * Reproduces the problems reported in bug 2659: + * http://deuce.doc.wustl.edu/bugzilla/show_bug.cgi?id=2659 + * + * + * @author Ciju John <johnc at ociweb> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/Bug_3539_Regression_Test.cpp b/ACE/tests/Bug_3539_Regression_Test.cpp index 3fd0bcfdedd..469a5403de3 100644 --- a/ACE/tests/Bug_3539_Regression_Test.cpp +++ b/ACE/tests/Bug_3539_Regression_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bug_3539_Regression_Test.cpp -// -// = DESCRIPTION -// This test is similar to TSS_Test but it's a bit simpler and it uses -// ACE_TSS in a main() thread. It uses TSS_Test_Errno.h. -// -// = AUTHOR -// Vladimir Zykov <vz@prismtech.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Bug_3539_Regression_Test.cpp + * + * $Id$ + * + * This test is similar to TSS_Test but it's a bit simpler and it uses + * ACE_TSS in a main() thread. It uses TSS_Test_Errno.h. + * + * + * @author Vladimir Zykov <vz@prismtech.com> + */ +//============================================================================= + #include "test_config.h" #include "TSS_Test_Errno.h" diff --git a/ACE/tests/Bug_3729_Regression_Test.cpp b/ACE/tests/Bug_3729_Regression_Test.cpp index 05d6f5ef7f4..49f1bfe253c 100644 --- a/ACE/tests/Bug_3729_Regression_Test.cpp +++ b/ACE/tests/Bug_3729_Regression_Test.cpp @@ -1,13 +1,13 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Bug_3729_Regression_Test.cpp -// ============================================================================ + +//============================================================================= +/** + * @file Bug_3729_Regression_Test.cpp + * + * $Id$ + * + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/CDR_Array_Test.cpp b/ACE/tests/CDR_Array_Test.cpp index 38e7163fabe..d3690a37b62 100644 --- a/ACE/tests/CDR_Array_Test.cpp +++ b/ACE/tests/CDR_Array_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// CDR_Array_Test.cpp -// -// = DESCRIPTION -// Checks ACE_OutputCDR::write_XX_array. -// Checks ACE_InputCDR::read_XX_array. -// Checks operator<< and operator>> for CDR Streams in -// each of the basic CDR types. -// Gives a measure of the speed of the ACE CDR streams wrt those -// operations. -// -// = AUTHORS -// Cristian Ferretti <cristian_ferretti@yahoo.com> -// -// ============================================================================ +//============================================================================= +/** + * @file CDR_Array_Test.cpp + * + * $Id$ + * + * Checks ACE_OutputCDR::write_XX_array. + * Checks ACE_InputCDR::read_XX_array. + * Checks operator<< and operator>> for CDR Streams in + * each of the basic CDR types. + * Gives a measure of the speed of the ACE CDR streams wrt those + * operations. + * + * + * @author Cristian Ferretti <cristian_ferretti@yahoo.com> + */ +//============================================================================= + // For measuring time, choose your method: // Define: diff --git a/ACE/tests/CDR_File_Test.cpp b/ACE/tests/CDR_File_Test.cpp index 548a8a66cb6..12fd23f425b 100644 --- a/ACE/tests/CDR_File_Test.cpp +++ b/ACE/tests/CDR_File_Test.cpp @@ -1,22 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// CDR_File_Test.cpp -// -// = DESCRIPTION -// Checks the functionality of the ACE CDR streams used for file -// I/O. -// -// = AUTHORS -// Giga Giguashvili <gregoryg@ParadigmGeo.com> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file CDR_File_Test.cpp + * + * $Id$ + * + * Checks the functionality of the ACE CDR streams used for file + * I/O. + * + * + * @author Giga Giguashvili <gregoryg@ParadigmGeo.com> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_Memory.h" @@ -36,34 +32,37 @@ #if !defined (ACE_LACKS_IOSTREAM_TOTALLY) +/** + * @class CDR_Test + * + * @brief Simple class that's used to read and write CDR streams. + */ class CDR_Test { - // = TITLE - // Simple class that's used to read and write CDR streams. + /// Output the state of a <CDR_Test> object to the <ostream>. friend ostream& operator << (ostream &os, const CDR_Test &t); - // Output the state of a <CDR_Test> object to the <ostream>. + /// Convert the state of this object into an <ACE_OutputCDR>. friend void operator << (ACE_OutputCDR &os, const CDR_Test &t); - // Convert the state of this object into an <ACE_OutputCDR>. + /// Convert the <ACE_InputCDR> into the state of this object. friend void operator >> (ACE_InputCDR &is, CDR_Test &); - // Convert the <ACE_InputCDR> into the state of this object. public: + /// Default constructor. CDR_Test (void); - // Default constructor. + /// Constructor. CDR_Test (ACE_CDR::Char o, ACE_CDR::Short s, ACE_CDR::Long w, ACE_CDR::ULongLong lw, ACE_CDR::Float f, ACE_CDR::Double d); - // Constructor. + /// Compare <rhs> for equality with <this>. bool operator == (const CDR_Test &rhs) const; - // Compare <rhs> for equality with <this>. private: ACE_CDR::Char char_; diff --git a/ACE/tests/CDR_Test.cpp b/ACE/tests/CDR_Test.cpp index 19df22a0adc..f47360fe321 100644 --- a/ACE/tests/CDR_Test.cpp +++ b/ACE/tests/CDR_Test.cpp @@ -1,22 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// CDR_Test.cpp -// -// = DESCRIPTION -// Checks the functionality of the ACE CDR streams. -// -// = AUTHORS -// Istvan Buki <istvan.buki@euronet.be> and -// Jeff Parsons <parsons@cs.wustl.edu> and -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file CDR_Test.cpp + * + * $Id$ + * + * Checks the functionality of the ACE CDR streams. + * + * + * @author Istvan Buki <istvan.buki@euronet.be> and Jeff Parsons <parsons@cs.wustl.edu> and Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Get_Opt.h" diff --git a/ACE/tests/Cache_Map_Manager_Test.cpp b/ACE/tests/Cache_Map_Manager_Test.cpp index 7263fa8411c..7953a125251 100644 --- a/ACE/tests/Cache_Map_Manager_Test.cpp +++ b/ACE/tests/Cache_Map_Manager_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cache_Map_Manager_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_Cache_Map_Manager> and -// <ACE_Hash_Cache_Map_Manager> that illustrates how to use the -// forward and reverse iterators, as well as the purging and -// caching features. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cache_Map_Manager_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_Cache_Map_Manager> and + * <ACE_Hash_Cache_Map_Manager> that illustrates how to use the + * forward and reverse iterators, as well as the purging and + * caching features. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Cache_Map_Manager_Test.h b/ACE/tests/Cache_Map_Manager_Test.h index 6ca91ddf4de..0f95b3cf7d9 100644 --- a/ACE/tests/Cache_Map_Manager_Test.h +++ b/ACE/tests/Cache_Map_Manager_Test.h @@ -1,22 +1,19 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cache_Map_Manager_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Cache_Map_Manager_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef __ACE_CACHE_MAP_MANAGER_TEST_H #define __ACE_CACHE_MAP_MANAGER_TEST_H diff --git a/ACE/tests/Cached_Accept_Conn_Test.cpp b/ACE/tests/Cached_Accept_Conn_Test.cpp index c8a29b236be..c7a7877db96 100644 --- a/ACE/tests/Cached_Accept_Conn_Test.cpp +++ b/ACE/tests/Cached_Accept_Conn_Test.cpp @@ -1,26 +1,23 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cached_Accept_Conn_Test.cpp -// -// = DESCRIPTION -// The test illustrates how the <ACE_Strategy_Connector> works by -// showing how you can cache connections on the client using -// different caching strategies. Also how connections can be purged -// explicitly and implicitly if needed from the connection cache -// maintained by the connector. The <ACE_Strategy_Acceptor> can also -// explicitly purge connections from the process CONNECTION CACHE on -// demand. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cached_Accept_Conn_Test.cpp + * + * $Id$ + * + * The test illustrates how the <ACE_Strategy_Connector> works by + * showing how you can cache connections on the client using + * different caching strategies. Also how connections can be purged + * explicitly and implicitly if needed from the connection cache + * maintained by the connector. The <ACE_Strategy_Acceptor> can also + * explicitly purge connections from the process CONNECTION CACHE on + * demand. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef CACHED_ACCEPT_CONNECTION_TEST #define CACHED_ACCEPT_CONNECTION_TEST diff --git a/ACE/tests/Cached_Accept_Conn_Test.h b/ACE/tests/Cached_Accept_Conn_Test.h index 5fabeb155d5..c1ca61d74f0 100644 --- a/ACE/tests/Cached_Accept_Conn_Test.h +++ b/ACE/tests/Cached_Accept_Conn_Test.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cache_Accept_Conn_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cached_Accept_Conn_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_CACHED_ACCEPT_CONN_TEST_H #define ACE_TESTS_CACHED_ACCEPT_CONN_TEST_H @@ -109,27 +106,31 @@ class Accept_Strategy : public ACE_Accept_Strategy<SVC_HANDLER, ACE_PEER_ACCEPTO { public: + /// Constructor. Accept_Strategy (CACHED_CONNECT_STRATEGY &caching_connect_strategy); - // Constructor. + /** + * Initialize the <peer_acceptor_> with <local_addr>. If the + * process runs out of descriptors, the unsed svc_handlers from the + * CONNECTION CACHE are removed. + */ int open (const ACE_PEER_ACCEPTOR_ADDR &local_addr, bool restart = false); - // Initialize the <peer_acceptor_> with <local_addr>. If the - // process runs out of descriptors, the unsed svc_handlers from the - // CONNECTION CACHE are removed. + /** + * The default behavior delegates to the <accept> method of the + * PEER_ACCEPTOR. A check is made here for the process running out + * of file descriptors. If so, the CONNECTION CACHE is purged of + * some idle svc_handlers. + */ int accept_svc_handler (SVC_HANDLER *svc_handler); - // The default behavior delegates to the <accept> method of the - // PEER_ACCEPTOR. A check is made here for the process running out - // of file descriptors. If so, the CONNECTION CACHE is purged of - // some idle svc_handlers. protected: typedef ACE_Accept_Strategy<SVC_HANDLER, ACE_PEER_ACCEPTOR_2> ACCEPT_STRATEGY_BASE; + /// Handler for removing cached connections. int out_of_sockets_handler (void); - // Handler for removing cached connections. CACHED_CONNECT_STRATEGY &caching_connect_strategy_; }; diff --git a/ACE/tests/Cached_Allocator_Test.cpp b/ACE/tests/Cached_Allocator_Test.cpp index e9fb4b3435c..bda18427401 100644 --- a/ACE/tests/Cached_Allocator_Test.cpp +++ b/ACE/tests/Cached_Allocator_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cached_Allocator_Test.cpp -// -// = DESCRIPTION -// Simple test of ACE_Dynamic_Cached_Allocator and ACE_Cached_Allocator. -// -// = AUTHOR -// Jaroslaw Nozderko <jareknz@polbox.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cached_Allocator_Test.cpp + * + * $Id$ + * + * Simple test of ACE_Dynamic_Cached_Allocator and ACE_Cached_Allocator. + * + * + * @author Jaroslaw Nozderko <jareknz@polbox.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Cached_Conn_Test.cpp b/ACE/tests/Cached_Conn_Test.cpp index b9cbc6924df..5db585f448b 100644 --- a/ACE/tests/Cached_Conn_Test.cpp +++ b/ACE/tests/Cached_Conn_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cached_Conn_Test.cpp -// -// = DESCRIPTION -// The test illustrates how the <ACE_Strategy_Connector> works by -// showing how you can cache connections on the client using -// different caching strategies. Also how connections can be purged -// explicitly and implicitly if needed from the connection cache -// maintained by the connector. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cached_Conn_Test.cpp + * + * $Id$ + * + * The test illustrates how the <ACE_Strategy_Connector> works by + * showing how you can cache connections on the client using + * different caching strategies. Also how connections can be purged + * explicitly and implicitly if needed from the connection cache + * maintained by the connector. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef CACHED_CONNECT_TEST #define CACHED_CONNECT_TEST diff --git a/ACE/tests/Cached_Conn_Test.h b/ACE/tests/Cached_Conn_Test.h index 4e7cfa4673e..939346a0f76 100644 --- a/ACE/tests/Cached_Conn_Test.h +++ b/ACE/tests/Cached_Conn_Test.h @@ -1,21 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Cache_Conn_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Cached_Conn_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_CACHED_CONN_TEST_H #define ACE_TESTS_CACHED_CONN_TEST_H diff --git a/ACE/tests/Capabilities_Test.cpp b/ACE/tests/Capabilities_Test.cpp index dc0a18875b9..41af5b42817 100644 --- a/ACE/tests/Capabilities_Test.cpp +++ b/ACE/tests/Capabilities_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Capabilities_Test.cpp -// -// = DESCRIPTION -// This is a test that makes sure the <ACE_Capabililties> class -// works correctly. -// -// = AUTHOR -// Arturo Montes <mitosys@colomsat.net.co> -// -// ============================================================================ + +//============================================================================= +/** + * @file Capabilities_Test.cpp + * + * $Id$ + * + * This is a test that makes sure the <ACE_Capabililties> class + * works correctly. + * + * + * @author Arturo Montes <mitosys@colomsat.net.co> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_fcntl.h" diff --git a/ACE/tests/Codecs_Test.cpp b/ACE/tests/Codecs_Test.cpp index c33fea1e7b0..551dfcf5591 100644 --- a/ACE/tests/Codecs_Test.cpp +++ b/ACE/tests/Codecs_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Codecs_Test.cpp -// -// = DESCRIPTION -// Checks the functionality of the ACE Codecs class. -// -// = AUTHORS -// Krishnakumar B <kitty@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Codecs_Test.cpp + * + * $Id$ + * + * Checks the functionality of the ACE Codecs class. + * + * + * @author Krishnakumar B <kitty@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Codecs.h" diff --git a/ACE/tests/Collection_Test.cpp b/ACE/tests/Collection_Test.cpp index 9d7cea3d13f..253ec6a07fb 100644 --- a/ACE/tests/Collection_Test.cpp +++ b/ACE/tests/Collection_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Collection_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the ACE collection classes and its -// iterators. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Collection_Test.cpp + * + * $Id$ + * + * This is a simple test of the ACE collection classes and its + * iterators. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/Collection_Test.h b/ACE/tests/Collection_Test.h index 249c9dd281d..4cd9e8731f7 100644 --- a/ACE/tests/Collection_Test.h +++ b/ACE/tests/Collection_Test.h @@ -1,23 +1,20 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Collection_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Collection_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_COLLECTION_TEST_H #define ACE_TESTS_COLLECTION_TEST_H diff --git a/ACE/tests/Config_Test.cpp b/ACE/tests/Config_Test.cpp index 8938ec1a0a8..f9b1bcacdd0 100644 --- a/ACE/tests/Config_Test.cpp +++ b/ACE/tests/Config_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Config_Test.cpp -// -// = DESCRIPTION -// This is a test that makes sure various classes in -// <ACE_Configuration> work correctly. -// -// = AUTHOR -// Michael Searles <msearles@base16.com>, -// Chris Hafey <chafey@stentor.com>, and -// Jerry D. Odenwelder Jr. <jerry.o@mindspring.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Config_Test.cpp + * + * $Id$ + * + * This is a test that makes sure various classes in + * <ACE_Configuration> work correctly. + * + * + * @author Michael Searles <msearles@base16.com> + * @author Chris Hafey <chafey@stentor.com> + * @author and Jerry D. Odenwelder Jr. <jerry.o@mindspring.com> + */ +//============================================================================= + #include "test_config.h" #include "Config_Test.h" diff --git a/ACE/tests/Config_Test.h b/ACE/tests/Config_Test.h index 28fcdbd2d36..8054acd3d6b 100644 --- a/ACE/tests/Config_Test.h +++ b/ACE/tests/Config_Test.h @@ -1,22 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// ConfigTest.h -// -// = DESCRIPTION -// This is a test that makes sure the <import_config_as_strings> of -// <ACE_Configuration_Heap> class works correctly. -// -// = AUTHOR -// Michael Searles <msearles@base16.com> and -// Jerry D. Odenwelder Jr. <jerry.o@mindspring.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Config_Test.h + * + * $Id$ + * + * This is a test that makes sure the <import_config_as_strings> of + * <ACE_Configuration_Heap> class works correctly. + * + * + * @author Michael Searles <msearles@base16.com> and Jerry D. Odenwelder Jr. <jerry.o@mindspring.com> + */ +//============================================================================= + #ifndef __CONFIG_TEST_H #define __CONFIG_TEST_H diff --git a/ACE/tests/Conn_Test.cpp b/ACE/tests/Conn_Test.cpp index 19ceab04825..a245dcd0c25 100644 --- a/ACE/tests/Conn_Test.cpp +++ b/ACE/tests/Conn_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Conn_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_Acceptor> and <ACE_Connector> -// classes. The test forks processes or spawns threads (depending -// upon the platform) and then executes client and server allowing -// them to connect and exchange data. The test also illustrates -// how the <ACE_Strategy_Connector> works by showing how you can -// cache connections on the client. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, -// Chris Cleeland <cleeland@cs.wustl.edu>, -// and Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Conn_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_Acceptor> and <ACE_Connector> + * classes. The test forks processes or spawns threads (depending + * upon the platform) and then executes client and server allowing + * them to connect and exchange data. The test also illustrates + * how the <ACE_Strategy_Connector> works by showing how you can + * cache connections on the client. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author Chris Cleeland <cleeland@cs.wustl.edu> + * @author and Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/SOCK_Connector.h" diff --git a/ACE/tests/Conn_Test.h b/ACE/tests/Conn_Test.h index 38e3cda4cd5..9b9f8c4afd3 100644 --- a/ACE/tests/Conn_Test.h +++ b/ACE/tests/Conn_Test.h @@ -1,22 +1,19 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Conn_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Conn_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "ace/Service_Config.h" @@ -28,35 +25,37 @@ #include "ace/Svc_Handler.h" #include "ace/SOCK_Stream.h" +/** + * @class Svc_Handler + * + * @brief This class is the product created by both <ACE_Connector> + * and <ACE_Acceptor> objects. + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Conn_Test.cpp. + */ class Svc_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_NULL_SYNCH> { - // = TITLE - // This class is the product created by both <ACE_Connector> - // and <ACE_Acceptor> objects. - // - // = DESCRIPTION - // This class gets its own header file to work around AIX C++ - // compiler "features" related to template instantiation... It is - // only used by Conn_Test.cpp. public: + /// Do-nothing constructor. Svc_Handler (ACE_Thread_Manager * = 0); - // Do-nothing constructor. + /// Initialization hook. virtual int open (void *); - // Initialization hook. + /// Prepare for recycling. virtual int recycle (void * = 0); - // Prepare for recycling. + /// Send data to server. void send_data (void); - // Send data to server. + /// Recv data from client. void recv_data (void); - // Recv data from client. + /// Shutdown the <Svc_Handler>. int close (u_long = 0); - // Shutdown the <Svc_Handler>. + /// Set <this> to idle. int idle (u_long flags); - // Set <this> to idle. }; diff --git a/ACE/tests/DLL_Test.cpp b/ACE/tests/DLL_Test.cpp index bad583ce519..1f652effa73 100644 --- a/ACE/tests/DLL_Test.cpp +++ b/ACE/tests/DLL_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// DLL_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of <ACE_DLL> wrapper class. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file DLL_Test.cpp + * + * $Id$ + * + * This test illustrates the use of <ACE_DLL> wrapper class. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/DLL.h" diff --git a/ACE/tests/DLL_Test_Impl.cpp b/ACE/tests/DLL_Test_Impl.cpp index 88cc0ba3ea4..ba02c9ab320 100644 --- a/ACE/tests/DLL_Test_Impl.cpp +++ b/ACE/tests/DLL_Test_Impl.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// DLL_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of <ACE_DLL> wrapper class. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file DLL_Test_Impl.cpp + * + * $Id$ + * + * This test illustrates the use of <ACE_DLL> wrapper class. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #include "DLL_Test_Impl.h" #include "ace/ACE.h" diff --git a/ACE/tests/DLL_Test_Impl.h b/ACE/tests/DLL_Test_Impl.h index 9ef3fb887a8..433a48de3ac 100644 --- a/ACE/tests/DLL_Test_Impl.h +++ b/ACE/tests/DLL_Test_Impl.h @@ -1,17 +1,14 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// DLL_Test_Impl.h -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file DLL_Test_Impl.h + * + * $Id$ + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_DLL_TEST_IMPL_H #define ACE_TESTS_DLL_TEST_IMPL_H @@ -23,30 +20,32 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class Hello_Impl + * + * @brief The Hello class in the dynamically linkable library. + * + * This class is used in this example to show how a library can + * be loaded on demand and its methods called on getting the + * symbols from the library. + */ class Hello_Impl : public Hello { - // = TITLE - // The Hello class in the dynamically linkable library. - // - // = DESCRIPTION - // This class is used in this example to show how a library can - // be loaded on demand and its methods called on getting the - // symbols from the library. public: + /// Constructor Hello_Impl (void); - // Constructor + /// Destructor ~Hello_Impl (void); - // Destructor + /// See the documentation in the base class void say_next (void); - // See the documentation in the base class + /// Uses ACE::strnew() to allocate the returned string. ACE_TCHAR *new_info (void); - // Uses ACE::strnew() to allocate the returned string. + /// Uses ACE_OS::malloc() to allocate the returned string. ACE_TCHAR *malloc_info (void); - // Uses ACE_OS::malloc() to allocate the returned string. // Overload the new/delete opertors so the object will be // created/deleted using the memory allocator associated with the diff --git a/ACE/tests/DLList_Test.cpp b/ACE/tests/DLList_Test.cpp index 8dc77be3422..bad545ad89a 100644 --- a/ACE/tests/DLList_Test.cpp +++ b/ACE/tests/DLList_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// DLList_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of <ACE_DLList>. -// -// = AUTHOR -// James Hu <jxh@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file DLList_Test.cpp + * + * $Id$ + * + * This test illustrates the use of <ACE_DLList>. + * + * + * @author James Hu <jxh@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Containers.h" diff --git a/ACE/tests/Dirent_Test.cpp b/ACE/tests/Dirent_Test.cpp index dc5df5ded2d..08bed5fd276 100644 --- a/ACE/tests/Dirent_Test.cpp +++ b/ACE/tests/Dirent_Test.cpp @@ -1,28 +1,25 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Dirent_Test.cpp -// -// = DESCRIPTION -// This is a test of the opendir and readdir emulation provided by the -// class ACE_Dirent. It is used to ensure that the emulation code -// works properly on platforms that don't support this capability -// natively. As the emulation code is not compiled in other -// platforms, this test also ensures that there is no impact to -// platforms that natively support directory scanning operations. -// -// = AUTHOR -// Phil Mesnier <mesnier_p@ociweb.com>, -// Zvika Ashani <zvika@aspectusvi.com>, -// Rich Newman <RNewman@directv.com>, and -// Douglas C. Schmidt <d.schmidt@vanderbilt.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Dirent_Test.cpp + * + * $Id$ + * + * This is a test of the opendir and readdir emulation provided by the + * class ACE_Dirent. It is used to ensure that the emulation code + * works properly on platforms that don't support this capability + * natively. As the emulation code is not compiled in other + * platforms, this test also ensures that there is no impact to + * platforms that natively support directory scanning operations. + * + * + * @author Phil Mesnier <mesnier_p@ociweb.com> + * @author Zvika Ashani <zvika@aspectusvi.com> + * @author Rich Newman <RNewman@directv.com> + * @author and Douglas C. Schmidt <d.schmidt@vanderbilt.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Dirent.h" diff --git a/ACE/tests/Dynamic_Priority_Test.cpp b/ACE/tests/Dynamic_Priority_Test.cpp index fdce93fae85..255bb762097 100644 --- a/ACE/tests/Dynamic_Priority_Test.cpp +++ b/ACE/tests/Dynamic_Priority_Test.cpp @@ -1,51 +1,48 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Dynamic_Priority_Test.cpp (based on Priority_Buffer_Test.cpp) -// -// = DESCRIPTION -// This is a test to verify and illustrate the static and dynamic -// priority mechanisms of the <ACE_Message_Queue> class and the -// <ACE_Dynamic_Message_Queue> class. As in the -// <Priority_Buffer_Test>, a producer generates messages and -// enqueues them, and a consumer dequeues them and checks their -// ordering. -// -// In these tests, every effort is made to ensure that there is -// plenty of time for the messages to be enqueued and dequeued, -// with messages that *should* meet their deadlines actually -// meeting them, while messages that should miss their deadlines -// are delayed so that they actually miss them. It is, however, -// remotely possible that this test could yield a false negative: -// the dynamic queues could work correctly but due to timing -// variations the test could indicate failure. -// -// Three message queues are obtained from the message queue -// factory, one static, two dynamic (one deadline based, and one -// laxity based) and the same supplier behavior is used each time: -// the messages are preallocated and their static information -// valued, the current time is obtained and deadlines are set, with -// half of the messages given late deadlines, and the other half of -// the messages given reachable deadlines. The producer then -// immediately enqueues all messages. -// -// Two separate tests are run, one which verifies messages are -// correctly ordered my the given queues, and one which generates -// performance numbers for the various queues under increasing -// numbers of messages. In the first test, the consumer is passed -// the filled queue and a string with the expected order in which -// the messages should dequeue. In the second test, measurements -// are made as non-intrusive as possible, with no ordering checks. -// -// = AUTHOR -// Chris Gill <cdgill@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Dynamic_Priority_Test.cpp (based on Priority_Buffer_Test.cpp) + * + * $Id$ + * + * This is a test to verify and illustrate the static and dynamic + * priority mechanisms of the <ACE_Message_Queue> class and the + * <ACE_Dynamic_Message_Queue> class. As in the + * <Priority_Buffer_Test>, a producer generates messages and + * enqueues them, and a consumer dequeues them and checks their + * ordering. + * + * In these tests, every effort is made to ensure that there is + * plenty of time for the messages to be enqueued and dequeued, + * with messages that *should* meet their deadlines actually + * meeting them, while messages that should miss their deadlines + * are delayed so that they actually miss them. It is, however, + * remotely possible that this test could yield a false negative: + * the dynamic queues could work correctly but due to timing + * variations the test could indicate failure. + * + * Three message queues are obtained from the message queue + * factory, one static, two dynamic (one deadline based, and one + * laxity based) and the same supplier behavior is used each time: + * the messages are preallocated and their static information + * valued, the current time is obtained and deadlines are set, with + * half of the messages given late deadlines, and the other half of + * the messages given reachable deadlines. The producer then + * immediately enqueues all messages. + * + * Two separate tests are run, one which verifies messages are + * correctly ordered my the given queues, and one which generates + * performance numbers for the various queues under increasing + * numbers of messages. In the first test, the consumer is passed + * the filled queue and a string with the expected order in which + * the messages should dequeue. In the second test, measurements + * are made as non-intrusive as possible, with no ordering checks. + * + * + * @author Chris Gill <cdgill@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" /* Include first to enable ACE_TEST_ASSERT. */ #include "ace/Message_Queue.h" @@ -62,23 +59,26 @@ #if defined (ACE_HAS_TIMED_MESSAGE_BLOCKS) enum Test_Type {BEST, WORST, RANDOM}; +/** + * @class ArgStruct + * + * @brief Structure used to pass arguments to test functions. + */ class ArgStruct { - // = TITLE - // Structure used to pass arguments to test functions. public: + /// message queue to test ACE_Message_Queue<ACE_SYNCH> *queue_; - // message queue to test + /// string of characters to indicate message order const char *order_string_; - // string of characters to indicate message order + /// array of message blocks to use ACE_Message_Block **array_; - // array of message blocks to use + /// expected message count u_int expected_count_; - // expected message count }; // Order in which messages are sent. diff --git a/ACE/tests/Dynamic_Test.cpp b/ACE/tests/Dynamic_Test.cpp index 86e0b7323d9..39be9642c61 100644 --- a/ACE/tests/Dynamic_Test.cpp +++ b/ACE/tests/Dynamic_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Dynamic_Test.cpp -// -// = DESCRIPTION -// This tests the ACE_Dynamic class -// -// = AUTHORS -// Johnny Willemsen <jwillemsen@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Dynamic_Test.cpp + * + * $Id$ + * + * This tests the ACE_Dynamic class + * + * + * @author Johnny Willemsen <jwillemsen@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Enum_Interfaces_Test.cpp b/ACE/tests/Enum_Interfaces_Test.cpp index 400b5b77bc6..4fa785126cf 100644 --- a/ACE/tests/Enum_Interfaces_Test.cpp +++ b/ACE/tests/Enum_Interfaces_Test.cpp @@ -1,31 +1,28 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Enum_interfaces.cpp -// -// = DESCRIPTION -// This is a simple test of <ACE::get_ip_interfaces>. This call -// retrieves the IP addresses assigned to the host by -// interrogating the kernel. Network applications typically -// assume gethostbyname(uname()) will work, but this is just a -// convention. It is also problematic if the resolver code -// (DNS/NIS+...) is misconfigured. This happens more than -// programmers realize. It is better to find out by asking the -// kernel for local address assignments. This API is similar to -// what netstat -ni or ifconfig -a produces on UNIX or ipconfig on -// Windows NT. In fact, it was by reverse engineering these tools -// that this api was created. -// -// = AUTHOR -// Michael R. MacFaden <mrm@cisco.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Enum_Interfaces_Test.cpp + * + * $Id$ + * + * This is a simple test of <ACE::get_ip_interfaces>. This call + * retrieves the IP addresses assigned to the host by + * interrogating the kernel. Network applications typically + * assume gethostbyname(uname()) will work, but this is just a + * convention. It is also problematic if the resolver code + * (DNS/NIS+...) is misconfigured. This happens more than + * programmers realize. It is better to find out by asking the + * kernel for local address assignments. This API is similar to + * what netstat -ni or ifconfig -a produces on UNIX or ipconfig on + * Windows NT. In fact, it was by reverse engineering these tools + * that this api was created. + * + * + * @author Michael R. MacFaden <mrm@cisco.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_sys_utsname.h" diff --git a/ACE/tests/FIFO_Test.cpp b/ACE/tests/FIFO_Test.cpp index 99c143b15a7..54125ca1b20 100644 --- a/ACE/tests/FIFO_Test.cpp +++ b/ACE/tests/FIFO_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// FIFO_Test.cpp -// -// = DESCRIPTION -// This is a test of basic ACE_FIFO_* class functionality. -// The test forks two processes or spawns two threads (depending -// upon the platform) and then tests various data exchange -// scenarios. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file FIFO_Test.cpp + * + * $Id$ + * + * This is a test of basic ACE_FIFO_* class functionality. + * The test forks two processes or spawns two threads (depending + * upon the platform) and then tests various data exchange + * scenarios. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/FlReactor_Test.cpp b/ACE/tests/FlReactor_Test.cpp index d0d5319540d..613cdd8f704 100644 --- a/ACE/tests/FlReactor_Test.cpp +++ b/ACE/tests/FlReactor_Test.cpp @@ -1,26 +1,23 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// FlReactor_Test.cpp -// -// = DESCRIPTION -// A simple test that ilustrates the integration of the fast-light -// toolkit (http://fltk.easysw.org/) with ACE, it uses FL to create -// an OpenGL window and display a polygon, it uses ACE to open an -// acceptor. Every time there is a connection the number of polygons -// is increased, a little widget can be used to change the number of -// polygons too. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file FlReactor_Test.cpp + * + * $Id$ + * + * A simple test that ilustrates the integration of the fast-light + * toolkit (http://fltk.easysw.org/) with ACE, it uses FL to create + * an OpenGL window and display a polygon, it uses ACE to open an + * acceptor. Every time there is a connection the number of polygons + * is increased, a little widget can be used to change the number of + * polygons too. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" @@ -46,17 +43,17 @@ class Test_Window : public Fl_Gl_Window { public: + /// Constructor Test_Window (int x, int y, int w, int h, const char * l = 0); - // Constructor int sides (void) const; void sides (int s); void incr_sides (void); private: + /// from the Fl_Gl_Window... virtual void draw (void); - // from the Fl_Gl_Window... int sides_; }; diff --git a/ACE/tests/Framework_Component_DLL.cpp b/ACE/tests/Framework_Component_DLL.cpp index c0aa88b1bb0..e155cf22e74 100644 --- a/ACE/tests/Framework_Component_DLL.cpp +++ b/ACE/tests/Framework_Component_DLL.cpp @@ -1,22 +1,19 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Framework_Component_DLL.cpp -// -// = DESCRIPTION -// This is a simple server that can be loaded via the ACE -// Service Configuration framework and uses the singleton that -// also lives in this library. -// -// = AUTHOR -// Don Hinton <dhinton@ieee.org> -// -// ============================================================================ +//============================================================================= +/** + * @file Framework_Component_DLL.cpp + * + * $Id$ + * + * This is a simple server that can be loaded via the ACE + * Service Configuration framework and uses the singleton that + * also lives in this library. + * + * + * @author Don Hinton <dhinton@ieee.org> + */ +//============================================================================= + #include "Framework_Component_DLL.h" #include "ace/Service_Config.h" diff --git a/ACE/tests/Framework_Component_DLL.h b/ACE/tests/Framework_Component_DLL.h index c9760b33dcb..a0dd585c6fb 100644 --- a/ACE/tests/Framework_Component_DLL.h +++ b/ACE/tests/Framework_Component_DLL.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Framework_Component_DLL.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Don Hinton <dhinton@ieee.org> -// -// ============================================================================ + +//============================================================================= +/** + * @file Framework_Component_DLL.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Don Hinton <dhinton@ieee.org> + */ +//============================================================================= + #ifndef ACE_TESTS_FRAMEWORK_COMPONENT_DLL_H #define ACE_TESTS_FRAMEWORK_COMPONENT_DLL_H diff --git a/ACE/tests/Framework_Component_Test.h b/ACE/tests/Framework_Component_Test.h index 5f6e359afb7..ca3f46f3482 100644 --- a/ACE/tests/Framework_Component_Test.h +++ b/ACE/tests/Framework_Component_Test.h @@ -1,21 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Framework_Component_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Don Hinton <dhinton@ieee.org> -// -// ============================================================================ +//============================================================================= +/** + * @file Framework_Component_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Don Hinton <dhinton@ieee.org> + */ +//============================================================================= + #ifndef ACE_TESTS_FRAMEWORK_COMPONENT_TEST_H #define ACE_TESTS_FRAMEWORK_COMPONENT_TEST_H diff --git a/ACE/tests/Future_Set_Test.cpp b/ACE/tests/Future_Set_Test.cpp index 6a138a99e85..954aa33722f 100644 --- a/ACE/tests/Future_Set_Test.cpp +++ b/ACE/tests/Future_Set_Test.cpp @@ -1,27 +1,23 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Future_Set_Test.cpp -// -// = DESCRIPTION -// This example tests the ACE Future Set and illustrates an -// implementation of the Active Object pattern, which is available -// at <http://www.cs.wustl.edu/~schmidt/PDF/Act-Obj.pdf>. The -// Active Object itself is very simple -- it determines if numbers -// are prime. -// -// = AUTHOR -// Andres Kruse <Andres.Kruse@cern.ch>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, -// Per Andersson <pera@ipso.se> and -// Johnny Tucker <jtucker@infoglide.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Future_Set_Test.cpp + * + * $Id$ + * + * This example tests the ACE Future Set and illustrates an + * implementation of the Active Object pattern, which is available + * at <http://www.cs.wustl.edu/~schmidt/PDF/Act-Obj.pdf>. The + * Active Object itself is very simple -- it determines if numbers + * are prime. + * + * + * @author Andres Kruse <Andres.Kruse@cern.ch> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author Per Andersson <pera@ipso.se> and Johnny Tucker <jtucker@infoglide.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" @@ -45,35 +41,37 @@ typedef ACE_Atomic_Op<ACE_Thread_Mutex, int> ATOMIC_INT; // A counter for the tasks.. static ATOMIC_INT task_count (0); +/** + * @class Prime_Scheduler + * + * @brief Prime number scheduler for the Active Object. + * + * This class also plays the role of the Proxy and the Servant + * in the Active Object pattern. Naturally, these roles could + * be split apart from the Prime_Scheduler. + */ class Prime_Scheduler : public ACE_Task_Base { - // = TITLE - // Prime number scheduler for the Active Object. - // - // = DESCRIPTION - // This class also plays the role of the Proxy and the Servant - // in the Active Object pattern. Naturally, these roles could - // be split apart from the Prime_Scheduler. friend class Method_Request_work; friend class Method_Request_name; friend class Method_Request_end; public: // = Initialization and termination methods. + /// Constructor. Prime_Scheduler (const ACE_TCHAR *, Prime_Scheduler * = 0); - // Constructor. //FUZZ: disable check_for_lack_ACE_OS + /// Initializer. virtual int open (void *args = 0); - // Initializer. - virtual int shutdown (void); - // Terminator. + /// Terminator. //FUZZ: enable check_for_lack_ACE_OS + virtual int shutdown (void); + /// Destructor. virtual ~Prime_Scheduler (void); - // Destructor. // = These methods are part of the Active Object Proxy interface. ACE_Future<u_long> work (u_long param, int count = 1); @@ -81,9 +79,9 @@ public: void end (void); protected: + /// Runs the Prime_Scheduler's event loop, which dequeues + /// <Method_Requests> and dispatches them. virtual int svc (void); - // Runs the Prime_Scheduler's event loop, which dequeues - // <Method_Requests> and dispatches them. // = These are the Servant methods that do the actual work. u_long work_i (u_long, int); @@ -96,10 +94,13 @@ private: Prime_Scheduler *scheduler_; }; +/** + * @class Method_Request_work + * + * @brief Reification of the <work> method. + */ class Method_Request_work : public ACE_Method_Request { - // = TITLE - // Reification of the <work> method. public: Method_Request_work (Prime_Scheduler *, u_long, @@ -107,21 +108,21 @@ public: ACE_Future<u_long> &); virtual ~Method_Request_work (void); + /// This is the entry point into the Active Object method. virtual int call (void); - // This is the entry point into the Active Object method. private: Prime_Scheduler *scheduler_; + /// Parameter to the method that's used to determine if a number if + /// prime. u_long param_; - // Parameter to the method that's used to determine if a number if - // prime. + /// Unused. int count_; - // Unused. + /// Store the result of the Future. ACE_Future<u_long> future_result_; - // Store the result of the Future. }; Method_Request_work::Method_Request_work (Prime_Scheduler *new_Prime_Scheduler, @@ -153,17 +154,20 @@ Method_Request_work::call (void) this->count_)); } +/** + * @class Method_Request_name + * + * @brief Reification of the <name> method. + */ class Method_Request_name : public ACE_Method_Request { - // = TITLE - // Reification of the <name> method. public: Method_Request_name (Prime_Scheduler *, ACE_Future<const ACE_TCHAR*> &); virtual ~Method_Request_name (void); + /// This is the entry point into the Active Object method. virtual int call (void); - // This is the entry point into the Active Object method. private: Prime_Scheduler *scheduler_; @@ -193,10 +197,13 @@ Method_Request_name::call (void) return future_result_.set (scheduler_->name_i ()); } +/** + * @class Method_Request_end + * + * @brief Reification of the <end> method. + */ class Method_Request_end : public ACE_Method_Request { - // = TITLE - // Reification of the <end> method. public: Method_Request_end (Prime_Scheduler *new_Prime_Scheduler); virtual ~Method_Request_end (void); diff --git a/ACE/tests/Future_Test.cpp b/ACE/tests/Future_Test.cpp index 40d14fc734f..5a418583147 100644 --- a/ACE/tests/Future_Test.cpp +++ b/ACE/tests/Future_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Future_Test.cpp -// -// = DESCRIPTION -// This example tests the ACE Future and illustrates an -// implementation of the Active Object pattern, which is described -// in the POSA2 book <www.cs.wustl.edu/~schmidt/POSA/> and in a -// paper at <www.cs.wustl.edu/~schmidt/PDF/Act-Obj.pdf>. The -// Active Object example here is very simple -- it determines if numbers -// are prime. -// -// = AUTHOR -// Andres Kruse <Andres.Kruse@cern.ch>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, -// and Per Andersson <pera@ipso.se> -// -// ============================================================================ + +//============================================================================= +/** + * @file Future_Test.cpp + * + * $Id$ + * + * This example tests the ACE Future and illustrates an + * implementation of the Active Object pattern, which is described + * in the POSA2 book <www.cs.wustl.edu/~schmidt/POSA/> and in a + * paper at <www.cs.wustl.edu/~schmidt/PDF/Act-Obj.pdf>. The + * Active Object example here is very simple -- it determines if numbers + * are prime. + * + * + * @author Andres Kruse <Andres.Kruse@cern.ch> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author and Per Andersson <pera@ipso.se> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" @@ -54,35 +51,37 @@ static ATOMIC_INT capsule_count (0); // A counter for the method requests... static ATOMIC_INT method_request_count (0); +/** + * @class Prime_Scheduler + * + * @brief Prime number scheduler for the Active Object. + * + * This class also plays the role of the Proxy and the Servant + * in the Active Object pattern. Naturally, these roles could + * be split apart from the Prime_Scheduler. + */ class Prime_Scheduler : public ACE_Task_Base { - // = TITLE - // Prime number scheduler for the Active Object. - // - // = DESCRIPTION - // This class also plays the role of the Proxy and the Servant - // in the Active Object pattern. Naturally, these roles could - // be split apart from the Prime_Scheduler. friend class Method_Request_work; friend class Method_Request_name; friend class Method_Request_end; public: // = Initialization and termination methods. + /// Constructor. Prime_Scheduler (const ACE_TCHAR *, Prime_Scheduler * = 0); - // Constructor. //FUZZ: disable check_for_lack_ACE_OS + /// Initializer. virtual int open (void *args = 0); - // Initializer. + //FUZZ: enable check_for_lack_ACE_OS + /// Terminator. virtual int shutdown (void); - // Terminator. - //FUZZ: enable check_for_lack_ACE_OS + /// Destructor. virtual ~Prime_Scheduler (void); - // Destructor. // = These methods are part of the Active Object Proxy interface. ACE_Future<u_long> work (u_long param, int count = 1); @@ -90,9 +89,9 @@ public: void end (void); protected: + /// Runs the Prime_Scheduler's event loop, which dequeues + /// <Method_Requests> and dispatches them. virtual int svc (void); - // Runs the Prime_Scheduler's event loop, which dequeues - // <Method_Requests> and dispatches them. // = These are the Servant methods that do the actual work. u_long work_i (u_long, int); @@ -105,10 +104,13 @@ private: Prime_Scheduler *scheduler_; }; +/** + * @class Method_Request_work + * + * @brief Reification of the <work> method. + */ class Method_Request_work : public ACE_Method_Request { - // = TITLE - // Reification of the <work> method. public: Method_Request_work (Prime_Scheduler *, u_long, @@ -116,21 +118,21 @@ public: ACE_Future<u_long> &); virtual ~Method_Request_work (void); + /// This is the entry point into the Active Object method. virtual int call (void); - // This is the entry point into the Active Object method. private: Prime_Scheduler *scheduler_; + /// Parameter to the method that's used to determine if a number if + /// prime. u_long param_; - // Parameter to the method that's used to determine if a number if - // prime. + /// Unused. int count_; - // Unused. + /// Store the result of the Future. ACE_Future<u_long> future_result_; - // Store the result of the Future. }; Method_Request_work::Method_Request_work (Prime_Scheduler *new_Prime_Scheduler, @@ -162,17 +164,20 @@ Method_Request_work::call (void) this->count_)); } +/** + * @class Method_Request_name + * + * @brief Reification of the <name> method. + */ class Method_Request_name : public ACE_Method_Request { - // = TITLE - // Reification of the <name> method. public: Method_Request_name (Prime_Scheduler *, ACE_Future<const ACE_TCHAR*> &); virtual ~Method_Request_name (void); + /// This is the entry point into the Active Object method. virtual int call (void); - // This is the entry point into the Active Object method. private: Prime_Scheduler *scheduler_; @@ -202,10 +207,13 @@ Method_Request_name::call (void) return future_result_.set (scheduler_->name_i ()); } +/** + * @class Method_Request_end + * + * @brief Reification of the <end> method. + */ class Method_Request_end : public ACE_Method_Request { - // = TITLE - // Reification of the <end> method. public: Method_Request_end (Prime_Scheduler *new_Prime_Scheduler); virtual ~Method_Request_end (void); diff --git a/ACE/tests/Handle_Set_Test.cpp b/ACE/tests/Handle_Set_Test.cpp index 696f58525c3..af6c4be30b7 100644 --- a/ACE/tests/Handle_Set_Test.cpp +++ b/ACE/tests/Handle_Set_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Handle_Set_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of ACE_Handle_Set to maintain a -// set of handles. No command line arguments are needed to run -// the test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Handle_Set_Test.cpp + * + * $Id$ + * + * This test illustrates the use of ACE_Handle_Set to maintain a + * set of handles. No command line arguments are needed to run + * the test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_stdlib.h" diff --git a/ACE/tests/Hash_Map_Bucket_Iterator_Test.cpp b/ACE/tests/Hash_Map_Bucket_Iterator_Test.cpp index 5cf017c288d..826cb6995cc 100644 --- a/ACE/tests/Hash_Map_Bucket_Iterator_Test.cpp +++ b/ACE/tests/Hash_Map_Bucket_Iterator_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Hash_Map_Bucket_Iterator_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the <Hash_Map_Bucket_Iterator>. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Hash_Map_Bucket_Iterator_Test.cpp + * + * $Id$ + * + * This is a simple test of the <Hash_Map_Bucket_Iterator>. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_stdlib.h" diff --git a/ACE/tests/Hash_Map_Manager_Test.cpp b/ACE/tests/Hash_Map_Manager_Test.cpp index 6a9e6f91486..8f8e2848967 100644 --- a/ACE/tests/Hash_Map_Manager_Test.cpp +++ b/ACE/tests/Hash_Map_Manager_Test.cpp @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Hash_Map_Manager_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of <ACE_Hash_Map_Manager> to -// maintain a hash table using strings. In addition, it also -// illustrates how the <ACE_Static_Allocator> works in -// conjunction with the <ACE_Hash_Map_Manager>. -// -// = AUTHOR -// James Hu <jxh@cs.wustl.edu> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Hash_Map_Manager_Test.cpp + * + * $Id$ + * + * This test illustrates the use of <ACE_Hash_Map_Manager> to + * maintain a hash table using strings. In addition, it also + * illustrates how the <ACE_Static_Allocator> works in + * conjunction with the <ACE_Hash_Map_Manager>. + * + * + * @author James Hu <jxh@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "STL_algorithm_Test_T.h" diff --git a/ACE/tests/Hash_Multi_Map_Manager_Test.cpp b/ACE/tests/Hash_Multi_Map_Manager_Test.cpp index 3560eb86824..913eb2818ca 100644 --- a/ACE/tests/Hash_Multi_Map_Manager_Test.cpp +++ b/ACE/tests/Hash_Multi_Map_Manager_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Hash_Multi_Map_Manager_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of <ACE_Hash_Multi_Map_Manager> to -// maintain a hash table using strings. -// -// = AUTHOR -// Shanshan Jiang <shanshan.jiang@vanderbilt.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Hash_Multi_Map_Manager_Test.cpp + * + * $Id$ + * + * This test illustrates the use of <ACE_Hash_Multi_Map_Manager> to + * maintain a hash table using strings. + * + * + * @author Shanshan Jiang <shanshan.jiang@vanderbilt.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Hash_Multi_Map_Manager_T.h" diff --git a/ACE/tests/High_Res_Timer_Test.cpp b/ACE/tests/High_Res_Timer_Test.cpp index 6dc70ced6f8..b2b87708ff2 100644 --- a/ACE/tests/High_Res_Timer_Test.cpp +++ b/ACE/tests/High_Res_Timer_Test.cpp @@ -1,19 +1,16 @@ -// $Id$ -//============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// High_Res_Timer_Test.cpp -// -// = DESCRIPTION -// Simple test of ACE_High_Res_Timer. -// -// = AUTHOR -// David L. Levine <levine@cs.wustl.edu> -// -//============================================================================ +//============================================================================= +/** + * @file High_Res_Timer_Test.cpp + * + * $Id$ + * + * Simple test of ACE_High_Res_Timer. + * + * + * @author David L. Levine <levine@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Log_Msg.h" diff --git a/ACE/tests/INET_Addr_Test.cpp b/ACE/tests/INET_Addr_Test.cpp index 7a8d255a295..b339a7b2dfa 100644 --- a/ACE/tests/INET_Addr_Test.cpp +++ b/ACE/tests/INET_Addr_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// INET_Addr_Test.cpp -// -// = DESCRIPTION -// Performs several tests on the ACE_INET_Addr class. It creates several -// IPv4 and IPv6 addresses and checks that the address formed by the -// class is valid. -// -// = AUTHOR -// John Aughey (jha@aughey.com) -// -// ============================================================================ + +//============================================================================= +/** + * @file INET_Addr_Test.cpp + * + * $Id$ + * + * Performs several tests on the ACE_INET_Addr class. It creates several + * IPv4 and IPv6 addresses and checks that the address formed by the + * class is valid. + * + * + * @author John Aughey (jha@aughey.com) + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/IOStream_Test.cpp b/ACE/tests/IOStream_Test.cpp index 276c69d5537..a73d184d5dd 100644 --- a/ACE/tests/IOStream_Test.cpp +++ b/ACE/tests/IOStream_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// IOStream_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the IOStream class that illustrates -// how to use iostream operations on almost arbitrary I/O classes. -// -// = AUTHOR -// James CE Johnson <jcej@lads.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file IOStream_Test.cpp + * + * $Id$ + * + * This is a simple test of the IOStream class that illustrates + * how to use iostream operations on almost arbitrary I/O classes. + * + * + * @author James CE Johnson <jcej@lads.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread.h" diff --git a/ACE/tests/Intrusive_Auto_Ptr_Test.cpp b/ACE/tests/Intrusive_Auto_Ptr_Test.cpp index bc49d843e0b..4be3c25f0ac 100644 --- a/ACE/tests/Intrusive_Auto_Ptr_Test.cpp +++ b/ACE/tests/Intrusive_Auto_Ptr_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Intrusive_Auto_Ptr_Test -// -// = DESCRIPTION -// This test verifies the functionality of the <ACE_Intrusive_Auto_Ptr> -// implementation. -// -// = AUTHOR -// Iliyan Jeliazkov <iliyan@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Intrusive_Auto_Ptr_Test.cpp + * + * $Id$ + * + * This test verifies the functionality of the <ACE_Intrusive_Auto_Ptr> + * implementation. + * + * + * @author Iliyan Jeliazkov <iliyan@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Intrusive_Auto_Ptr.h" diff --git a/ACE/tests/Lazy_Map_Manager_Test.cpp b/ACE/tests/Lazy_Map_Manager_Test.cpp index a518146b6a7..ce3d09ecccb 100644 --- a/ACE/tests/Lazy_Map_Manager_Test.cpp +++ b/ACE/tests/Lazy_Map_Manager_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Lazy_Map_Manager_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the <ACE_Map_Manager> and -// <ACE_Active_Map_Manager> that illustrates how lazy map managers -// allow the deletion of entries while iterating over the map. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu>, -// -// ============================================================================ + +//============================================================================= +/** + * @file Lazy_Map_Manager_Test.cpp + * + * $Id$ + * + * This is a simple test of the <ACE_Map_Manager> and + * <ACE_Active_Map_Manager> that illustrates how lazy map managers + * allow the deletion of entries while iterating over the map. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Map_Manager.h" diff --git a/ACE/tests/Log_Msg_Backend_Test.cpp b/ACE/tests/Log_Msg_Backend_Test.cpp index 54050e18036..df15ebf5d76 100644 --- a/ACE/tests/Log_Msg_Backend_Test.cpp +++ b/ACE/tests/Log_Msg_Backend_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Log_Msg_Backend_Test.cpp -// -// = DESCRIPTION -// This program tests the ACE_Log_Msg class's use of a custom backend, -// including its initialization and reset as well as logging information -// through the backend. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Log_Msg_Backend_Test.cpp + * + * $Id$ + * + * This program tests the ACE_Log_Msg class's use of a custom backend, + * including its initialization and reset as well as logging information + * through the backend. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" @@ -33,14 +30,14 @@ public: : reset_ (false), open_ (false), close_ (false), log_count_ (0) {} //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS virtual int open (const ACE_TCHAR *logger_key); - //FUZZ: enable check_for_lack_ACE_OS virtual int reset (void); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS virtual int close (void); - //FUZZ: enable check_for_lack_ACE_OS virtual ssize_t log (ACE_Log_Record &log_record); diff --git a/ACE/tests/Log_Msg_Test.cpp b/ACE/tests/Log_Msg_Test.cpp index dcdcf407192..9601961af85 100644 --- a/ACE/tests/Log_Msg_Test.cpp +++ b/ACE/tests/Log_Msg_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Log_Msg_Test.cpp -// -// = DESCRIPTION -// This program tests the <ACE_Log_Msg> class in various ways and -// also illustrates many of the features of the <ACE_Log_Msg> For -// instance, this program tests the <ACE_Log_Msg> abstraction wrt -// writing to stderr and to a file. It also tests writing to user -// defined callback objects. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Log_Msg_Test.cpp + * + * $Id$ + * + * This program tests the <ACE_Log_Msg> class in various ways and + * also illustrates many of the features of the <ACE_Log_Msg> For + * instance, this program tests the <ACE_Log_Msg> abstraction wrt + * writing to stderr and to a file. It also tests writing to user + * defined callback objects. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" @@ -56,21 +53,21 @@ cause_error (void) class Logger : public ACE_Log_Msg_Callback { public: + /// Constructor sets whether we're testing "recursive" callback + /// logging! Logger (bool be_recursive = true); - // Constructor sets whether we're testing "recursive" callback - // logging! + /// Logging callback void log (ACE_Log_Record &log_record); - // Logging callback void verbose (bool be_verbose); private: + /// Flag for testing verbose logging. bool verbose_logging_; - // Flag for testing verbose logging. + /// Flag for testing recursive callback logging. bool recursive_; - // Flag for testing recursive callback logging. }; void @@ -479,17 +476,17 @@ class Log_Spec_Verify : public ACE_Log_Msg_Callback public: Log_Spec_Verify (bool be_recursive = true) : fail_ (0), tests_ (0), recursive_ (be_recursive) {}; + /// Logging callback void log (ACE_Log_Record &log_record); - // Logging callback int result (); private: + /// Count how many tests failed. int fail_; - // Count how many tests failed. + /// Count how many tests we run int tests_; - // Count how many tests we run bool recursive_; }; diff --git a/ACE/tests/Logging_Strategy_Test.cpp b/ACE/tests/Logging_Strategy_Test.cpp index 92efa0fefce..6b3c6a8394d 100644 --- a/ACE/tests/Logging_Strategy_Test.cpp +++ b/ACE/tests/Logging_Strategy_Test.cpp @@ -1,36 +1,33 @@ -// $Id$ - -//========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// Logging_Strategy_Test.cpp -// -// = DESCRIPTION -// This program tests the <ACE_Logging_Strategy> class in various -// ways and also illustrates many of the features of the -// <ACE_Log_Msg>. The test works as follows: -// -Load the inserted arguments; -// -Remove existent log_files with the file_name specified by the -// user; -// -Generate 1000 messages to create the DEBUG statements to be -// stored in the files; -// -Counts the created log_files and if it was specified a maximum -// number of log_files, compare and verify if they are the same. -// -Verify the order of the files with the order argument. -// -// When Dlls are used, we utilize the dynamic service -// configuration mechanism to activate the logging strategy. This -// is not a must though, and you may activate the logging strategy -// as described in the non-DLL section below under DLL -// environments as well. -// -// = AUTHOR -// Orlando Ribeiro <oribeiro@inescporto.pt> -// -//========================================================================== + +//============================================================================= +/** + * @file Logging_Strategy_Test.cpp + * + * $Id$ + * + * This program tests the <ACE_Logging_Strategy> class in various + * ways and also illustrates many of the features of the + * <ACE_Log_Msg>. The test works as follows: + * -Load the inserted arguments; + * -Remove existent log_files with the file_name specified by the + * user; + * -Generate 1000 messages to create the DEBUG statements to be + * stored in the files; + * -Counts the created log_files and if it was specified a maximum + * number of log_files, compare and verify if they are the same. + * -Verify the order of the files with the order argument. + * + * When Dlls are used, we utilize the dynamic service + * configuration mechanism to activate the logging strategy. This + * is not a must though, and you may activate the logging strategy + * as described in the non-DLL section below under DLL + * environments as well. + * + * + * @author Orlando Ribeiro <oribeiro@inescporto.pt> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_stdio.h" diff --git a/ACE/tests/MEM_Stream_Test.cpp b/ACE/tests/MEM_Stream_Test.cpp index 8409ab58fda..66d13ae085e 100644 --- a/ACE/tests/MEM_Stream_Test.cpp +++ b/ACE/tests/MEM_Stream_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MEM_Stream_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_MEM_Acceptor> and -// <ACE_MEM_Connector> classes. -// -// = AUTHOR -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file MEM_Stream_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_MEM_Acceptor> and + * <ACE_MEM_Connector> classes. + * + * + * @author Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_stdio.h" diff --git a/ACE/tests/MEM_Stream_Test.h b/ACE/tests/MEM_Stream_Test.h index b9ed6924463..d7fa1df3d8b 100644 --- a/ACE/tests/MEM_Stream_Test.h +++ b/ACE/tests/MEM_Stream_Test.h @@ -1,23 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MEM_Stream_Test.h -// -// = DESCRIPTION -// This file has the class definitions needed for template generation in -// MEM_Stream_Test.cpp. They have to be in a separate file so AIX xlC can -// find them at auto-instantiate time. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MEM_Stream_Test.h + * + * $Id$ + * + * This file has the class definitions needed for template generation in + * MEM_Stream_Test.cpp. They have to be in a separate file so AIX xlC can + * find them at auto-instantiate time. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #ifndef ACE_TESTS_MEM_STREAM_TEST_H #define ACE_TESTS_MEM_STREAM_TEST_H @@ -33,18 +30,21 @@ #if (ACE_HAS_POSITION_INDEPENDENT_POINTERS == 1) +/** + * @class Echo_Handler + * + * @brief Simple class for reading in the data and then sending it back + */ class Echo_Handler : public ACE_Svc_Handler<ACE_MEM_STREAM, ACE_SYNCH> { - // = TITLE - // Simple class for reading in the data and then sending it back public: + /// The Svc_Handler callbacks. Echo_Handler (ACE_Thread_Manager *thr_mgr = 0); virtual int open (void *); static void reset_handler (void); virtual int handle_input (ACE_HANDLE h); virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask); - // The Svc_Handler callbacks. virtual int svc (void); private: diff --git a/ACE/tests/MM_Shared_Memory_Test.cpp b/ACE/tests/MM_Shared_Memory_Test.cpp index 3df0943b05b..c320d8a6a96 100644 --- a/ACE/tests/MM_Shared_Memory_Test.cpp +++ b/ACE/tests/MM_Shared_Memory_Test.cpp @@ -1,25 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Shared_Memory_MM_Test.cpp -// -// = DESCRIPTION -// This is a simple test of <ACE_Shared_Memory_MM>. The test -// forks two processes or spawns two threads (depending upon the -// platform) and then executes child and parent allowing them to -// exchange data using shared memory. No user input is required as -// far as command line arguments are concerned. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file MM_Shared_Memory_Test.cpp + * + * $Id$ + * + * This is a simple test of <ACE_Shared_Memory_MM>. The test + * forks two processes or spawns two threads (depending upon the + * platform) and then executes child and parent allowing them to + * exchange data using shared memory. No user input is required as + * far as command line arguments are concerned. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Shared_Memory_MM.h" @@ -42,12 +38,15 @@ static ACE_TCHAR *shm_key; #include "ace/Thread_Semaphore.h" typedef ACE_Thread_Semaphore SYNCHRONIZER; #elif defined (ACE_HAS_POSIX_SEM) && defined(ACE_HAS_SYSV_IPC) +/** + * @class SYNCHRONIZER + * + * @brief If the platform has native cross-process POSIX semaphores, we + * must *force* this test to use the System V Semaphores in order + * to get the right semantics. + */ class SYNCHRONIZER : public ACE_SV_Semaphore_Simple { - // = TITLE - // If the platform has native cross-process POSIX semaphores, we - // must *force* this test to use the System V Semaphores in order - // to get the right semantics. public: SYNCHRONIZER (int initial_value) : ACE_SV_Semaphore_Simple ((const char *) 0, diff --git a/ACE/tests/MT_NonBlocking_Connect_Test.cpp b/ACE/tests/MT_NonBlocking_Connect_Test.cpp index 79a7b660999..4c046e2fd65 100644 --- a/ACE/tests/MT_NonBlocking_Connect_Test.cpp +++ b/ACE/tests/MT_NonBlocking_Connect_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_NonBlocking_Connect_Test.cpp -// -// = DESCRIPTION -// -// This test makes non-blocking connects from multiple threads. Things are -// complicated by the fact that after the connection is attempted reactor's -// handle_events() is called and this leads to possible connection -// completion in the other thread. This is similar to what TAO does for -// oneway with SYNC_NONE sync scope policy. -// The following reactors are tested: Select, TP, WFMO, and Dev Poll -// (if enabled). -// -// = AUTHOR -// Vladimir Zykov <vladimir.zykov@prismtech.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_NonBlocking_Connect_Test.cpp + * + * $Id$ + * + * + * This test makes non-blocking connects from multiple threads. Things are + * complicated by the fact that after the connection is attempted reactor's + * handle_events() is called and this leads to possible connection + * completion in the other thread. This is similar to what TAO does for + * oneway with SYNC_NONE sync scope policy. + * The following reactors are tested: Select, TP, WFMO, and Dev Poll + * (if enabled). + * + * + * @author Vladimir Zykov <vladimir.zykov@prismtech.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/MT_Reactor_Timer_Test.cpp b/ACE/tests/MT_Reactor_Timer_Test.cpp index d3448d98fec..01fc16210c4 100644 --- a/ACE/tests/MT_Reactor_Timer_Test.cpp +++ b/ACE/tests/MT_Reactor_Timer_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_Reactor_Timer_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the timer mechanism of -// the reactor scheduling timers, handling expired timers and -// cancelling scheduled timers from multiple threads. No command -// line arguments are needed to run the test. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_Reactor_Timer_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the timer mechanism of + * the reactor scheduling timers, handling expired timers and + * cancelling scheduled timers from multiple threads. No command + * line arguments are needed to run the test. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "MT_Reactor_Timer_Test.h" diff --git a/ACE/tests/MT_Reactor_Timer_Test.h b/ACE/tests/MT_Reactor_Timer_Test.h index d3dce675ed4..21603efa84c 100644 --- a/ACE/tests/MT_Reactor_Timer_Test.h +++ b/ACE/tests/MT_Reactor_Timer_Test.h @@ -1,22 +1,19 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_Reactor_Timer_Test.h -// -// = DESCRIPTION -// This file contains class definitions needed for template -// instantiation in the MT_Reactor_Timer_Test.cpp file. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_Reactor_Timer_Test.h + * + * $Id$ + * + * This file contains class definitions needed for template + * instantiation in the MT_Reactor_Timer_Test.cpp file. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #ifndef ACE_TESTS_MT_REACTOR_TIMER_TEST_H #define ACE_TESTS_MT_REACTOR_TIMER_TEST_H @@ -30,11 +27,14 @@ #include "ace/Task.h" #include "ace/Pipe.h" +/** + * @class Time_Handler + * + * @brief Test out the multi-threading features of the Reactor's timer + * mechanism. + */ class Time_Handler : public ACE_Task<ACE_SYNCH> { - // = TITLE - // Test out the multi-threading features of the Reactor's timer - // mechanism. public: Time_Handler (void); @@ -42,8 +42,8 @@ public: int verify_results(void); + /// Run by a daemon thread to handle deferred processing. virtual int svc (void); - // Run by a daemon thread to handle deferred processing. virtual int handle_timeout (const ACE_Time_Value &tv, const void *arg); @@ -54,12 +54,14 @@ private: TIMER_SLOTS = 10 }; + /** + * The timer_id_ array holds timer IDs. They also have some other values + * that are specific to this test: + * -1 the timer has not been set + * -2 the timer was set, but has been cancelled + * -3 the timer was set, and it already fired + */ long timer_id_[TIMER_SLOTS]; - // The timer_id_ array holds timer IDs. They also have some other values - // that are specific to this test: - // -1 the timer has not been set - // -2 the timer was set, but has been cancelled - // -3 the timer was set, and it already fired enum { TIMER_NOTSET = -1, TIMER_CANCELLED = -2, TIMER_FIRED = -3 }; long prev_timer_; @@ -70,34 +72,37 @@ private: }; +/** + * @class Dispatch_Count_Handler + * + * @brief A simple test to ensure that the Reactor counts the number of + * dispatches correctly. + */ class Dispatch_Count_Handler : public ACE_Event_Handler { - // = TITLE - // A simple test to ensure that the Reactor counts the number of - // dispatches correctly. public: Dispatch_Count_Handler (void); + /// Clean up resources from the Reactor. int handle_close (ACE_HANDLE h, ACE_Reactor_Mask m); - // Clean up resources from the Reactor. + /// Keep track of the number of timeouts. virtual int handle_timeout (const ACE_Time_Value &tv, const void *arg); - // Keep track of the number of timeouts. + /// Keep track of the number of I/O events. virtual int handle_input (ACE_HANDLE); - // Keep track of the number of I/O events. + /// Keep track of the number of notifies. virtual int handle_exception (ACE_HANDLE); - // Keep track of the number of notifies. + /// Verify that the expected events did happen. int verify_results (void); - // Verify that the expected events did happen. private: + /// Provide something to trigger I/O. ACE_Pipe pipe_; - // Provide something to trigger I/O. int input_seen_; int notify_seen_; diff --git a/ACE/tests/MT_Reactor_Upcall_Test.cpp b/ACE/tests/MT_Reactor_Upcall_Test.cpp index 8e63c205df2..f299dad742d 100644 --- a/ACE/tests/MT_Reactor_Upcall_Test.cpp +++ b/ACE/tests/MT_Reactor_Upcall_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_Reactor_Upcall_Test.cpp -// -// = DESCRIPTION -// This is a test that shows how to handle upcalls from the -// TP_Reactor and the WFMO_Reactor when the event loop is being run -// by multiple threads. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_Reactor_Upcall_Test.cpp + * + * $Id$ + * + * This is a test that shows how to handle upcalls from the + * TP_Reactor and the WFMO_Reactor when the event loop is being run + * by multiple threads. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/MT_Reference_Counted_Event_Handler_Test.cpp b/ACE/tests/MT_Reference_Counted_Event_Handler_Test.cpp index 111e1dceb2c..1288adb2916 100644 --- a/ACE/tests/MT_Reference_Counted_Event_Handler_Test.cpp +++ b/ACE/tests/MT_Reference_Counted_Event_Handler_Test.cpp @@ -1,31 +1,28 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_Reference_Counted_Event_Handler_Test.cpp -// -// = DESCRIPTION -// -// This test tries to represents what happens in the ORB wrt to -// event handlers, reactors, timer queues, threads, and connection -// caches, minus the other complexities. The following reactors -// are tested: Select, TP, WFMO, and Dev Poll (if enabled). -// -// The test checks proper use and shutting down of client-side -// event handlers when it is used by invocation threads and/or -// event loop threads. Server-side event handlers are either -// threaded or reactive. A purger thread is introduced to check the -// connection recycling and cache purging. Nested upcalls are also -// tested. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_Reference_Counted_Event_Handler_Test.cpp + * + * $Id$ + * + * + * This test tries to represents what happens in the ORB wrt to + * event handlers, reactors, timer queues, threads, and connection + * caches, minus the other complexities. The following reactors + * are tested: Select, TP, WFMO, and Dev Poll (if enabled). + * + * The test checks proper use and shutting down of client-side + * event handlers when it is used by invocation threads and/or + * event loop threads. Server-side event handlers are either + * threaded or reactive. A purger thread is introduced to check the + * connection recycling and cache purging. Nested upcalls are also + * tested. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" @@ -152,8 +149,8 @@ public: Pipe (void); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS int open (void); - //FUZZ: enable check_for_lack_ACE_OS ACE_HANDLE read_handle (void) const; @@ -247,8 +244,8 @@ public: ssize_t send_message (void); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS void close (void); - //FUZZ: enable check_for_lack_ACE_OS ACE_HANDLE handle_; @@ -394,8 +391,8 @@ public: int svc (void); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS int close (u_long flags); - //FUZZ: enable check_for_lack_ACE_OS int handle_input (ACE_HANDLE); @@ -557,10 +554,10 @@ public: int nested_upcalls); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS int connect (ACE_HANDLE &client_handle, ACE_HANDLE &server_handle, int run_receiver_thread); - //FUZZ: enable check_for_lack_ACE_OS ACE_Thread_Manager &thread_manager_; diff --git a/ACE/tests/MT_Reference_Counted_Notify_Test.cpp b/ACE/tests/MT_Reference_Counted_Notify_Test.cpp index d9ee8be6242..b79a017ed30 100644 --- a/ACE/tests/MT_Reference_Counted_Notify_Test.cpp +++ b/ACE/tests/MT_Reference_Counted_Notify_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_Reference_Counted_Notify_Test.cpp -// -// = DESCRIPTION -// This test is used to check reference counting of the event -// handlers when it interacts with the reactor notification -// mechanism. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_Reference_Counted_Notify_Test.cpp + * + * $Id$ + * + * This test is used to check reference counting of the event + * handlers when it interacts with the reactor notification + * mechanism. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/MT_SOCK_Test.cpp b/ACE/tests/MT_SOCK_Test.cpp index 56fa9404da9..aa8cd57f14b 100644 --- a/ACE/tests/MT_SOCK_Test.cpp +++ b/ACE/tests/MT_SOCK_Test.cpp @@ -1,27 +1,24 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// MT_SOCK_Test.cpp -// -// = DESCRIPTION -// This is a multi-threaded torture test of the -// <ACE_SOCK_Acceptor> and <ACE_SOCK_Connector> classes. The test -// forks 30 processes or spawns 30 threads (depending upon the -// platform) and then executes client and server allowing them to -// connect and exchange data. Note that most of the connections -// will fail since we're overrunning the size of the listen queue -// for the acceptor-mode socket. -// -// = AUTHOR -// Doug Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file MT_SOCK_Test.cpp + * + * $Id$ + * + * This is a multi-threaded torture test of the + * <ACE_SOCK_Acceptor> and <ACE_SOCK_Connector> classes. The test + * forks 30 processes or spawns 30 threads (depending upon the + * platform) and then executes client and server allowing them to + * connect and exchange data. Note that most of the connections + * will fail since we're overrunning the size of the listen queue + * for the acceptor-mode socket. + * + * + * @author Doug Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_sys_wait.h" diff --git a/ACE/tests/Main.cpp b/ACE/tests/Main.cpp index 44b92128394..241e8b54bec 100644 --- a/ACE/tests/Main.cpp +++ b/ACE/tests/Main.cpp @@ -1,21 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Main.cpp -// -// = DESCRIPTION -// This is a wrapper for the test programs. It obviates the test cpp's -// from having to always include OS.h. -// -// = AUTHOR -// Don Hinton <dhinton@dresystems.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Main.cpp + * + * $Id$ + * + * This is a wrapper for the test programs. It obviates the test cpp's + * from having to always include OS.h. + * + * + * @author Don Hinton <dhinton@dresystems.com> + */ +//============================================================================= + #include "ace/OS_main.h" #if defined (ACE_HAS_WINCE) diff --git a/ACE/tests/Malloc_Test.cpp b/ACE/tests/Malloc_Test.cpp index b38b7fb532a..e0ddce1d2e6 100644 --- a/ACE/tests/Malloc_Test.cpp +++ b/ACE/tests/Malloc_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Malloc_Test.cpp -// -// = DESCRIPTION -// This is a test of the position-independent <ACE_Malloc> memory -// manager using the <ACE_MMAP_Memory_Pool> and <ACE_Process_Mutex>. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Malloc_Test.cpp + * + * $Id$ + * + * This is a test of the position-independent <ACE_Malloc> memory + * manager using the <ACE_MMAP_Memory_Pool> and <ACE_Process_Mutex>. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "Malloc_Test.h" diff --git a/ACE/tests/Malloc_Test.h b/ACE/tests/Malloc_Test.h index 8fda7368ee4..45982889163 100644 --- a/ACE/tests/Malloc_Test.h +++ b/ACE/tests/Malloc_Test.h @@ -1,22 +1,18 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Malloc_Test.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Malloc_Test.cpp. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> +//============================================================================= +/** + * @file Malloc_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Malloc_Test.cpp. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= -// ============================================================================ #ifndef ACE_TESTS_MALLOC_TEST_H #define ACE_TESTS_MALLOC_TEST_H diff --git a/ACE/tests/Manual_Event_Test.cpp b/ACE/tests/Manual_Event_Test.cpp index a2b62a52f9a..7d736f69282 100644 --- a/ACE/tests/Manual_Event_Test.cpp +++ b/ACE/tests/Manual_Event_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Manual_Event Test -// -// = DESCRIPTION -// This test verifies the functionality of the <ACE_Manual_Event> -// implementation. -// -// = AUTHOR -// Martin Corino <mcorino@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Manual_Event_Test.cpp + * + * $Id$ + * + * This test verifies the functionality of the <ACE_Manual_Event> + * implementation. + * + * + * @author Martin Corino <mcorino@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Manual_Event.h" diff --git a/ACE/tests/Map_Manager_Test.cpp b/ACE/tests/Map_Manager_Test.cpp index 7279c9f5d39..f06e966a89a 100644 --- a/ACE/tests/Map_Manager_Test.cpp +++ b/ACE/tests/Map_Manager_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Map_Manager_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the <ACE_Map_Manager> and -// <ACE_Hash_Map_Manager> that illustrates how to use the forward -// and reverse iterators. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, and -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Map_Manager_Test.cpp + * + * $Id$ + * + * This is a simple test of the <ACE_Map_Manager> and + * <ACE_Hash_Map_Manager> that illustrates how to use the forward + * and reverse iterators. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author and Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Map_Manager.h" diff --git a/ACE/tests/Map_Test.cpp b/ACE/tests/Map_Test.cpp index 2cb9198f682..9bcd7ad25f4 100644 --- a/ACE/tests/Map_Test.cpp +++ b/ACE/tests/Map_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Map_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the <ACE_Map> and illustrates how to -// use the forward and reverse iterators. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Map_Test.cpp + * + * $Id$ + * + * This is a simple test of the <ACE_Map> and illustrates how to + * use the forward and reverse iterators. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "Map_Test.h" diff --git a/ACE/tests/Map_Test.h b/ACE/tests/Map_Test.h index c881a3f7645..39b4db9b682 100644 --- a/ACE/tests/Map_Test.h +++ b/ACE/tests/Map_Test.h @@ -1,23 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Map_Test.h -// -// = DESCRIPTION -// This file has the class definitions needed for template generation in -// Map_Test.cpp. They have to be in a separate file so AIX xlC can -// find them at auto-instantiate time. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Map_Test.h + * + * $Id$ + * + * This file has the class definitions needed for template generation in + * Map_Test.cpp. They have to be in a separate file so AIX xlC can + * find them at auto-instantiate time. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_MAP_TEST_H #define ACE_TESTS_MAP_TEST_H @@ -34,13 +31,15 @@ // Key data type. typedef ACE_Array<char> KEY; +/** + * @class Key_Generator + * + * @brief Defines a key generator. + * + * This class is used in adapters of maps that do not produce keys. + */ class Key_Generator { - // = TITLE - // Defines a key generator. - // - // = DESCRIPTION - // This class is used in adapters of maps that do not produce keys. public: Key_Generator (void) diff --git a/ACE/tests/Max_Default_Port_Test.cpp b/ACE/tests/Max_Default_Port_Test.cpp index 3c9f30cbf91..bf1e530bd75 100644 --- a/ACE/tests/Max_Default_Port_Test.cpp +++ b/ACE/tests/Max_Default_Port_Test.cpp @@ -1,30 +1,27 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Max_Default_Port_Test.cpp -// -// = DESCRIPTION -// This is a test for ACE_MAX_DEFAULT_PORT value. The test tests the -// highest value of the port number at which an event handler can be -// registered and a Connector can be connected to. -// -// Some weird behaviour has been reported on Windows NT (sp 3) when -// the port number exceeds 65279 resulting ACE_MAX_DEFAULT_PORT to set -// to zero on that platform. -// -// In this test, the event handler is started at the port value -// USHRT_MAX and decremented for 'ports_to_test' port values and tested -// if the highest port number used agrees with ACE_MAX_DEFAULT_PORT value. -// -// -// = AUTHOR -// Chanaka Liyanaarachchi <chanaka@ociweb.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Max_Default_Port_Test.cpp + * + * $Id$ + * + * This is a test for ACE_MAX_DEFAULT_PORT value. The test tests the + * highest value of the port number at which an event handler can be + * registered and a Connector can be connected to. + * + * Some weird behaviour has been reported on Windows NT (sp 3) when + * the port number exceeds 65279 resulting ACE_MAX_DEFAULT_PORT to set + * to zero on that platform. + * + * In this test, the event handler is started at the port value + * USHRT_MAX and decremented for 'ports_to_test' port values and tested + * if the highest port number used agrees with ACE_MAX_DEFAULT_PORT value. + * + * + * + * @author Chanaka Liyanaarachchi <chanaka@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/Max_Default_Port_Test.h b/ACE/tests/Max_Default_Port_Test.h index 78969cf05e1..f61748531bc 100644 --- a/ACE/tests/Max_Default_Port_Test.h +++ b/ACE/tests/Max_Default_Port_Test.h @@ -1,19 +1,16 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Max_Default_Port_Test.h -// -// = DESCRIPTION -// This is a test to verify ACE_MAX_DEFAULT_PORT is correct. -// -// = AUTHOR -// Chanaka Liyanaarachchi <chanaka@ociweb.com> -// -// =========================================================================== +//============================================================================= +/** + * @file Max_Default_Port_Test.h + * + * $Id$ + * + * This is a test to verify ACE_MAX_DEFAULT_PORT is correct. + * + * + * @author Chanaka Liyanaarachchi <chanaka@ociweb.com> + */ +//============================================================================= + #ifndef ACE_TESTS_MAX_DEFAULT_PORT_TEST @@ -24,10 +21,13 @@ #include "ace/SOCK_Stream.h" #include "ace/INET_Addr.h" +/** + * @class My_Accept_Handler + = Title + * A simple event handler + */ class My_Accept_Handler : public ACE_Event_Handler { - // = Title - // A simple event handler public: My_Accept_Handler (ACE_INET_Addr &addr); @@ -39,8 +39,8 @@ public: int handle_input (ACE_HANDLE handle); + /// Returns the port the event handler is listening at. u_short port (); - // Returns the port the event handler is listening at. private: ACE_SOCK_Acceptor peer_acceptor_; diff --git a/ACE/tests/Mem_Map_Test.cpp b/ACE/tests/Mem_Map_Test.cpp index 9d1d56b76e6..d47d3845ac6 100644 --- a/ACE/tests/Mem_Map_Test.cpp +++ b/ACE/tests/Mem_Map_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Mem_Map_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of ACE_Mem_Map to reverse a -// file. The test first creates a dummy file for testing, then -// reverses the file and then reverses it again to get back the -// original file. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Mem_Map_Test.cpp + * + * $Id$ + * + * This test illustrates the use of ACE_Mem_Map to reverse a + * file. The test first creates a dummy file for testing, then + * reverses the file and then reverses it again to get back the + * original file. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Mem_Map.h" diff --git a/ACE/tests/Message_Block_Test.cpp b/ACE/tests/Message_Block_Test.cpp index cf76ad4610c..b551ecf2e64 100644 --- a/ACE/tests/Message_Block_Test.cpp +++ b/ACE/tests/Message_Block_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Message_Block_Test.cpp -// -// = DESCRIPTION -// This test program is a torture test that illustrates how -// <ACE_Message_Block> reference counting works in multi-threaded -// code. -// -// = AUTHOR -// Doug Schmidt <schmidt@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Message_Block_Test.cpp + * + * $Id$ + * + * This test program is a torture test that illustrates how + * <ACE_Message_Block> reference counting works in multi-threaded + * code. + * + * + * @author Doug Schmidt <schmidt@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_stdio.h" @@ -50,21 +47,21 @@ static ACE_Lock_Adapter<ACE_SYNCH_MUTEX> lock_adapter_; class Worker_Task : public ACE_Task<ACE_MT_SYNCH> { public: + /// Activate the task. Worker_Task (void); - // Activate the task. + /// Iterate <n_iterations> time printing off a message and "waiting" + /// for all other threads to complete this iteration. virtual int svc (void); - // Iterate <n_iterations> time printing off a message and "waiting" - // for all other threads to complete this iteration. + /// Allows the producer to pass messages to the <Message_Block>. virtual int put (ACE_Message_Block *mb, ACE_Time_Value *tv = 0); - // Allows the producer to pass messages to the <Message_Block>. private: //FUZZ: disable check_for_lack_ACE_OS + /// Close hook. + ///FUZZ: enable check_for_lack_ACE_OS virtual int close (u_long); - // Close hook. - //FUZZ: enable check_for_lack_ACE_OS }; int diff --git a/ACE/tests/Message_Queue_Notifications_Test.cpp b/ACE/tests/Message_Queue_Notifications_Test.cpp index a57c4b31d2c..c39286d498c 100644 --- a/ACE/tests/Message_Queue_Notifications_Test.cpp +++ b/ACE/tests/Message_Queue_Notifications_Test.cpp @@ -1,38 +1,35 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Message_Queue_Notification_Test.cpp -// -// = DESCRIPTION -// There are two tests that test 2 different notification -// mechanisms in Message Queue. -// -// The first test illustrates the notification mechanisms in -// Message_Queue and its integration with Reactor. -// -// Note the following things about this part of the test: -// -// 1. Multiple threads are not required. -// 2. You do not have to explicitly notify the Reactor -// 3. This code will work the same with any Reactor Implementation -// 4. handle_input, handle_exception, handle_output are the only -// callbacks supported by this mechanism -// 5. The notification mechanism need not notify the Reactor. You can -// write your own strategy classes that can do whatever application -// specific behavior you want. -// -// The second test also makes sure the high/low water mark -// signaling mechanism works flawlessly. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Message_Queue_Notifications_Test.cpp + * + * $Id$ + * + * There are two tests that test 2 different notification + * mechanisms in Message Queue. + * + * The first test illustrates the notification mechanisms in + * Message_Queue and its integration with Reactor. + * + * Note the following things about this part of the test: + * + * 1. Multiple threads are not required. + * 2. You do not have to explicitly notify the Reactor + * 3. This code will work the same with any Reactor Implementation + * 4. handle_input, handle_exception, handle_output are the only + * callbacks supported by this mechanism + * 5. The notification mechanism need not notify the Reactor. You can + * write your own strategy classes that can do whatever application + * specific behavior you want. + * + * The second test also makes sure the high/low water mark + * signaling mechanism works flawlessly. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" @@ -56,14 +53,17 @@ static const size_t default_high_water_mark = 20; static const size_t default_low_water_mark = 10; static const int watermark_iterations = 2 * default_high_water_mark; +/** + * @class Message_Handler + * + * @brief This class implements a notification strategy for the Reactor. + */ class Message_Handler : public ACE_Task<ACE_NULL_SYNCH> { - // = TITLE - // This class implements a notification strategy for the Reactor. public: // = Initialization and termination. + /// Constructor. Message_Handler (ACE_Reactor &reactor); - // Constructor. // = Demuxing hooks. virtual int handle_input (ACE_HANDLE); @@ -77,11 +77,14 @@ private: ACE_Reactor_Notification_Strategy notification_strategy_; }; +/** + * @class Watermark_Test + * + * @brief This class test the correct functioning of build-in flow + * control machanism in ACE_Task. + */ class Watermark_Test : public ACE_Task<ACE_SYNCH> { - // = TITLE - // This class test the correct functioning of build-in flow - // control machanism in ACE_Task. public: Watermark_Test (void); diff --git a/ACE/tests/Message_Queue_Test.cpp b/ACE/tests/Message_Queue_Test.cpp index 5565166739d..c55f4211381 100644 --- a/ACE/tests/Message_Queue_Test.cpp +++ b/ACE/tests/Message_Queue_Test.cpp @@ -1,31 +1,28 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Message_Queue_Test.cpp -// -// = DESCRIPTION -// This is: -// 0) a test that ensures key ACE_Message_Queue features are -// working properly, including timeouts and priorities -// 1) a simple test of the ACE_Message_Queue that illustrates how to -// use the forward and reverse iterators -// 2) a simple performance measurement test for both single-threaded -// (null synch), thread-safe ACE_Message_Queues, and -// ACE_Message_Queue_Vx, which wraps VxWorks message queues -// 3) a test/usage example of ACE_Message_Queue_Vx -// 4) a test of the message counting in a message queue under load. -// -// = AUTHORS -// Irfan Pyarali <irfan@cs.wustl.edu>, -// David L. Levine <levine@cs.wustl.edu>, and -// Douglas C. Schmidt <schmidt@vanderbilt.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Message_Queue_Test.cpp + * + * $Id$ + * + * This is: + * 0) a test that ensures key ACE_Message_Queue features are + * working properly, including timeouts and priorities + * 1) a simple test of the ACE_Message_Queue that illustrates how to + * use the forward and reverse iterators + * 2) a simple performance measurement test for both single-threaded + * (null synch), thread-safe ACE_Message_Queues, and + * ACE_Message_Queue_Vx, which wraps VxWorks message queues + * 3) a test/usage example of ACE_Message_Queue_Vx + * 4) a test of the message counting in a message queue under load. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + * @author David L. Levine <levine@cs.wustl.edu> + * @author and Douglas C. Schmidt <schmidt@vanderbilt.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Atomic_Op.h" diff --git a/ACE/tests/Message_Queue_Test_Ex.cpp b/ACE/tests/Message_Queue_Test_Ex.cpp index d13faea21a0..6bf8773ea87 100644 --- a/ACE/tests/Message_Queue_Test_Ex.cpp +++ b/ACE/tests/Message_Queue_Test_Ex.cpp @@ -1,28 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Message_Queue_Test_Ex.cpp -// -// = DESCRIPTION -// This is: -// 1. A simple test of the ACE_Message_Queue_Ex that executes -// a performance measurement test for both single-threaded -// (null synch) and thread-safe ACE_Message_Queue_Ex -// instantiations. -// 2. An example of using a user-defined class to parameterize -// ACE_Message_Queue_Ex. -// -// = AUTHORS -// Michael Vitlo <mvitalo@sprynet.com>, copied the code from: -// Irfan Pyarali <irfan@cs.wustl.edu> and -// David L. Levine <levine@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Message_Queue_Test_Ex.cpp + * + * $Id$ + * + * This is: + * 1. A simple test of the ACE_Message_Queue_Ex that executes + * a performance measurement test for both single-threaded + * (null synch) and thread-safe ACE_Message_Queue_Ex + * instantiations. + * 2. An example of using a user-defined class to parameterize + * ACE_Message_Queue_Ex. + * + * + * @author Michael Vitlo <mvitalo@sprynet.com> + * @author copied the code from: Irfan Pyarali <irfan@cs.wustl.edu> and David L. Levine <levine@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread_Manager.h" diff --git a/ACE/tests/Missing_Svc_Conf_Test.cpp b/ACE/tests/Missing_Svc_Conf_Test.cpp index 2780b26f587..a9ca9bf7dc9 100644 --- a/ACE/tests/Missing_Svc_Conf_Test.cpp +++ b/ACE/tests/Missing_Svc_Conf_Test.cpp @@ -1,30 +1,27 @@ -// $Id$ -// ========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// Missing_Svc_Conf_Test.cpp -// -// = DESCRIPTION -// A test to ensure that service_config::open() returns -1 if it is -// fully defaulted, but no default svc.conf file exists. The first -// test verifies that open returns -1 with errno ENOENT. A second -// test ensures that service_config::open() returns 0 when any -// explicit directive is supplied by the command line, regardless -// of the existence of default svc.conf. -// -// Presently there is no svc.conf file in the tests directory and -// this test relies on that. It is assumed that this will stay -// true, since adding a default svc.conf file in this directory my -// impact other tests. -// -// = AUTHOR -// Phil Mesnier <mesnier_p@ociweb.com> -// -// ========================================================================== +//============================================================================= +/** + * @file Missing_Svc_Conf_Test.cpp + * + * $Id$ + * + * A test to ensure that service_config::open() returns -1 if it is + * fully defaulted, but no default svc.conf file exists. The first + * test verifies that open returns -1 with errno ENOENT. A second + * test ensures that service_config::open() returns 0 when any + * explicit directive is supplied by the command line, regardless + * of the existence of default svc.conf. + * + * Presently there is no svc.conf file in the tests directory and + * this test relies on that. It is assumed that this will stay + * true, since adding a default svc.conf file in this directory my + * impact other tests. + * + * + * @author Phil Mesnier <mesnier_p@ociweb.com> + */ +//============================================================================= + #include "ace/Service_Config.h" #include "ace/OS_NS_fcntl.h" diff --git a/ACE/tests/Multihomed_INET_Addr_Test.cpp b/ACE/tests/Multihomed_INET_Addr_Test.cpp index c68df6da834..100bc588bb3 100644 --- a/ACE/tests/Multihomed_INET_Addr_Test.cpp +++ b/ACE/tests/Multihomed_INET_Addr_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Multihomed_INET_Addr_Test.cpp -// -// = DESCRIPTION -// Performs several tests on the Multihomed_ACE_INET_Addr class. -// It creates several IPv4 addresses and checks that the -// address formed by the class is valid. -// -// = AUTHOR -// Edward Mulholland (emulholl@atl.lmco.com) -// -// ============================================================================ + +//============================================================================= +/** + * @file Multihomed_INET_Addr_Test.cpp + * + * $Id$ + * + * Performs several tests on the Multihomed_ACE_INET_Addr class. + * It creates several IPv4 addresses and checks that the + * address formed by the class is valid. + * + * + * @author Edward Mulholland (emulholl@atl.lmco.com) + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Multihomed_INET_Addr_Test_IPV6.cpp b/ACE/tests/Multihomed_INET_Addr_Test_IPV6.cpp index 1607dd81fb2..6047bb0c019 100644 --- a/ACE/tests/Multihomed_INET_Addr_Test_IPV6.cpp +++ b/ACE/tests/Multihomed_INET_Addr_Test_IPV6.cpp @@ -1,25 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Multihomed_INET_Addr_Test.cpp -// -// = DESCRIPTION -// Performs several tests on the Multihomed_ACE_INET_Addr class. -// It creates several IPv6 addresses and checks that the -// address formed by the class is valid. -// -// = AUTHOR -// Edward Mulholland (emulholl@atl.lmco.com) -// Brian Buesker (bbuesker@qualcomm.com) - Added testing of -// ACE_Multihomed_INET_Addr class -// using IPv6 addresses based on -// Multihomed_INET_Addr_Test. -// -// ============================================================================ +//============================================================================= +/** + * @file Multihomed_INET_Addr_Test_IPV6.cpp + * + * $Id$ + * + * Performs several tests on the Multihomed_ACE_INET_Addr class. + * It creates several IPv6 addresses and checks that the + * address formed by the class is valid. + * + * + * @author Edward Mulholland (emulholl@atl.lmco.com) Brian Buesker (bbuesker@qualcomm.com) - Added testing of ACE_Multihomed_INET_Addr class using IPv6 addresses based on Multihomed_INET_Addr_Test. + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/NDDS_Timer_Test.cpp b/ACE/tests/NDDS_Timer_Test.cpp index 00108b5a578..7e11daa3ed7 100644 --- a/ACE/tests/NDDS_Timer_Test.cpp +++ b/ACE/tests/NDDS_Timer_Test.cpp @@ -1,19 +1,16 @@ -// $Id$ -//============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// NDDS_Timer_Test.cpp -// -// = DESCRIPTION -// Simple test of NDDS_Timer. Copied from NDDS_Timer_Test. -// -// = AUTHOR -// Marcel Smit <msmit@remedy.nl> -// -//============================================================================ +//============================================================================= +/** + * @file NDDS_Timer_Test.cpp + * + * $Id$ + * + * Simple test of NDDS_Timer. Copied from NDDS_Timer_Test. + * + * + * @author Marcel Smit <msmit@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Log_Msg.h" diff --git a/ACE/tests/Naming_Test.cpp b/ACE/tests/Naming_Test.cpp index b6f219521c7..4981b875c73 100644 --- a/ACE/tests/Naming_Test.cpp +++ b/ACE/tests/Naming_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Naming_Test.cpp -// -// = DESCRIPTION -// This is a test to illustrate the Naming Services. The test -// does binds, rebinds, finds, and unbinds on name bindings using -// the local naming context. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Naming_Test.cpp + * + * $Id$ + * + * This is a test to illustrate the Naming Services. The test + * does binds, rebinds, finds, and unbinds on name bindings using + * the local naming context. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "randomize.h" diff --git a/ACE/tests/Network_Adapters_Test.cpp b/ACE/tests/Network_Adapters_Test.cpp index 69158323a35..4d5aea82d7b 100644 --- a/ACE/tests/Network_Adapters_Test.cpp +++ b/ACE/tests/Network_Adapters_Test.cpp @@ -1,21 +1,16 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Network_Adapters_Test.cpp -// -// = DESCRIPTION -// Tests the ICMP-echo support in ACE. -// -// = AUTHOR -// Robert S. Iakobashvili <coroberti@gmail.com> <coroberti@walla.co.il> -// Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Network_Adapters_Test.cpp + * + * $Id$ + * + * Tests the ICMP-echo support in ACE. + * + * + * @author Robert S. Iakobashvili <coroberti@gmail.com> <coroberti@walla.co.il> Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> + */ +//============================================================================= + // We need this to be able to check for ACE_HAS_ICMP_SUPPORT #include "ace/config-all.h" diff --git a/ACE/tests/Network_Adapters_Test.h b/ACE/tests/Network_Adapters_Test.h index a726b1212b6..f5c8e9121ed 100644 --- a/ACE/tests/Network_Adapters_Test.h +++ b/ACE/tests/Network_Adapters_Test.h @@ -1,23 +1,18 @@ // -*- C++ -*- -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Network_Adapters_Test.h -// -// = DESCRIPTION -// Definitions for Network_Adapters_Test.cpp. -// -// = AUTHOR -// Robert S. Iakobashvili <roberti@go-WLAN.com> <coroberti@walla.co.il> -// Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> made aceing -// -// ============================================================================ +//============================================================================= +/** + * @file Network_Adapters_Test.h + * + * $Id$ + * + * Definitions for Network_Adapters_Test.cpp. + * + * + * @author Robert S. Iakobashvili <roberti@go-WLAN.com> <coroberti@walla.co.il> Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> made aceing + */ +//============================================================================= + #ifndef ACE_NETWORK_ADAPTERS_TEST_H #define ACE_NETWORK_ADAPTERS_TEST_H diff --git a/ACE/tests/New_Fail_Test.cpp b/ACE/tests/New_Fail_Test.cpp index 7375e624ba6..f32fdefb405 100644 --- a/ACE/tests/New_Fail_Test.cpp +++ b/ACE/tests/New_Fail_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// New_Fail_Test.cpp -// -// = DESCRIPTION -// Checks to be sure that a failed ACE_NEW[_RETURN | _NORETURN] doesn't end -// up throwing an exception up to the caller. -// -// Note that this test doesn't get a real attempt on platforms which: -// 1. Are known to throw exceptions when 'new' runs out of resources, -// 2. Are built with exceptions disabled. -// In these cases, the test puts a message in the log noting that a failed -// new will throw an exception, and trust that the user accepts that risk. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ +//============================================================================= +/** + * @file New_Fail_Test.cpp + * + * $Id$ + * + * Checks to be sure that a failed ACE_NEW[_RETURN | _NORETURN] doesn't end + * up throwing an exception up to the caller. + * + * Note that this test doesn't get a real attempt on platforms which: + * 1. Are known to throw exceptions when 'new' runs out of resources, + * 2. Are built with exceptions disabled. + * In these cases, the test puts a message in the log noting that a failed + * new will throw an exception, and trust that the user accepts that risk. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Log_Msg.h" diff --git a/ACE/tests/NonBlocking_Conn_Test.cpp b/ACE/tests/NonBlocking_Conn_Test.cpp index d85ce6ce1ba..fff840fc029 100644 --- a/ACE/tests/NonBlocking_Conn_Test.cpp +++ b/ACE/tests/NonBlocking_Conn_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// NonBlocking_Conn_Test.cpp -// -// = DESCRIPTION -// This test checks for the proper working of the following: -// - blocking connections -// - blocking connections with timeouts -// - non-blocking connections -// - non-blocking connections without waiting for completions -// - non-blocking connections with timeouts -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file NonBlocking_Conn_Test.cpp + * + * $Id$ + * + * This test checks for the proper working of the following: + * - blocking connections + * - blocking connections with timeouts + * - non-blocking connections + * - non-blocking connections without waiting for completions + * - non-blocking connections with timeouts + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "NonBlocking_Conn_Test.h" diff --git a/ACE/tests/NonBlocking_Conn_Test.h b/ACE/tests/NonBlocking_Conn_Test.h index dc52f3fe694..505bccc3ad6 100644 --- a/ACE/tests/NonBlocking_Conn_Test.h +++ b/ACE/tests/NonBlocking_Conn_Test.h @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// NonBlocking_Conn_Test.cpp -// -// = DESCRIPTION -// This test checks for the proper working of the following: -// - blocking connections -// - blocking connections with timeouts -// - non-blocking connections -// - non-blocking connections without waiting for completions -// - non-blocking connections with timeouts -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file NonBlocking_Conn_Test.h + * + * $Id$ + * + * This test checks for the proper working of the following: + * - blocking connections + * - blocking connections with timeouts + * - non-blocking connections + * - non-blocking connections without waiting for completions + * - non-blocking connections with timeouts + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #ifndef NONBLOCKING_CONN_TEST_H #define NONBLOCKING_CONN_TEST_H diff --git a/ACE/tests/Notify_Performance_Test.cpp b/ACE/tests/Notify_Performance_Test.cpp index 768c5cbce78..ced0ca0d9a4 100644 --- a/ACE/tests/Notify_Performance_Test.cpp +++ b/ACE/tests/Notify_Performance_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Notify_Performance_Test.cpp -// -// = DESCRIPTION -// This test is used to time the notification mechanisms of the -// ACE_Reactors. Both the WFMO_Reactor and Select_Reactor can be -// tested. The notify() mechanism can also be tested with or -// without data. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Notify_Performance_Test.cpp + * + * $Id$ + * + * This test is used to time the notification mechanisms of the + * ACE_Reactors. Both the WFMO_Reactor and Select_Reactor can be + * tested. The notify() mechanism can also be tested with or + * without data. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Profile_Timer.h" @@ -56,8 +53,8 @@ static int opt_pass_notify_data = 0; class Handler : public ACE_Event_Handler { public: + /// The Handler callbacks. virtual int handle_exception (ACE_HANDLE fd = ACE_INVALID_HANDLE); - // The Handler callbacks. }; int diff --git a/ACE/tests/Object_Manager_Flipping_Test.cpp b/ACE/tests/Object_Manager_Flipping_Test.cpp index b42279aa767..78bb5f91d18 100644 --- a/ACE/tests/Object_Manager_Flipping_Test.cpp +++ b/ACE/tests/Object_Manager_Flipping_Test.cpp @@ -1,26 +1,23 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Object_Manager_Flipping_Test.cpp -// -// = DESCRIPTION - -// Tests the basic function of the ACE_Service_Config in scenarios -// where the ACE_Object_Manager is being -// flipped. i.e. ACE::init/ACE::fini() are called in sequence -// (which can occur with loading DLLs). More specifically we test -// that the OM correctly controlls the lifecycle of the default SC -// instance, which is pointed to by a TSS pointer. -// -// = AUTHOR -// Iliyan Jeliazkov <iliyan@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Object_Manager_Flipping_Test.cpp + * + * $Id$ + * + + * Tests the basic function of the ACE_Service_Config in scenarios + * where the ACE_Object_Manager is being + * flipped. i.e. ACE::init/ACE::fini() are called in sequence + * (which can occur with loading DLLs). More specifically we test + * that the OM correctly controlls the lifecycle of the default SC + * instance, which is pointed to by a TSS pointer. + * + * + * @author Iliyan Jeliazkov <iliyan@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Object_Manager.h" diff --git a/ACE/tests/Object_Manager_Test.cpp b/ACE/tests/Object_Manager_Test.cpp index 2b5001b73a1..65e033e64e1 100644 --- a/ACE/tests/Object_Manager_Test.cpp +++ b/ACE/tests/Object_Manager_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Object_Manager_Test.cpp -// -// = DESCRIPTION -// Tests the basic functions of the ACE_Object_Manager. -// -// = AUTHOR -// David L. Levine <levine@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Object_Manager_Test.cpp + * + * $Id$ + * + * Tests the basic functions of the ACE_Object_Manager. + * + * + * @author David L. Levine <levine@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Object_Manager.h" diff --git a/ACE/tests/Obstack_Test.cpp b/ACE/tests/Obstack_Test.cpp index 058c495c58c..ee10ff8e86a 100644 --- a/ACE/tests/Obstack_Test.cpp +++ b/ACE/tests/Obstack_Test.cpp @@ -1,20 +1,16 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Obtack_Test.cpp -// -// = DESCRIPTION -// Checks the functionality of ACE_Obstack<T> -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Obstack_Test.cpp + * + * $Id$ + * + * Checks the functionality of ACE_Obstack<T> + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/OrdMultiSet_Test.cpp b/ACE/tests/OrdMultiSet_Test.cpp index 906735973c7..e67728c3164 100644 --- a/ACE/tests/OrdMultiSet_Test.cpp +++ b/ACE/tests/OrdMultiSet_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// OrdMultiSet_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the <ACE_Ordered_MultiSet> and -// <ACE_Ordered_MultiSet_Iterator> class templates, instantiating -// them with type int. No command line arguments are needed to run -// the test. -// -// = AUTHOR -// Chris Gill <cdgill@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file OrdMultiSet_Test.cpp + * + * $Id$ + * + * This is a simple test of the <ACE_Ordered_MultiSet> and + * <ACE_Ordered_MultiSet_Iterator> class templates, instantiating + * them with type int. No command line arguments are needed to run + * the test. + * + * + * @author Chris Gill <cdgill@cs.wustl.edu> + */ +//============================================================================= + // Note, for this test the config.h file *must* come first! #include "ace/config-all.h" diff --git a/ACE/tests/Pipe_Test.cpp b/ACE/tests/Pipe_Test.cpp index b40c756c789..1863eaa5776 100644 --- a/ACE/tests/Pipe_Test.cpp +++ b/ACE/tests/Pipe_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Pipe_Test.cpp -// -// = DESCRIPTION -// Tests the construction of multiple pipes in a process. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Pipe_Test.cpp + * + * $Id$ + * + * Tests the construction of multiple pipes in a process. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Pipe.h" diff --git a/ACE/tests/Priority_Buffer_Test.cpp b/ACE/tests/Priority_Buffer_Test.cpp index 885e01d63a5..c92e7a51fec 100644 --- a/ACE/tests/Priority_Buffer_Test.cpp +++ b/ACE/tests/Priority_Buffer_Test.cpp @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Priority_Buffer_Test.cpp -// -// = DESCRIPTION -// This is a simple test to illustrate the priority mechanism of -// <ACE_Message_Queue>s. The producer uses an <ACE_Message_Queue> -// to enqueue a bunch of messages with different priorities which -// are then dequeued by the consumer. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Priority_Buffer_Test.cpp + * + * $Id$ + * + * This is a simple test to illustrate the priority mechanism of + * <ACE_Message_Queue>s. The producer uses an <ACE_Message_Queue> + * to enqueue a bunch of messages with different priorities which + * are then dequeued by the consumer. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Message_Queue.h" diff --git a/ACE/tests/Priority_Reactor_Test.cpp b/ACE/tests/Priority_Reactor_Test.cpp index 8a0e9a1c118..cb758134e7f 100644 --- a/ACE/tests/Priority_Reactor_Test.cpp +++ b/ACE/tests/Priority_Reactor_Test.cpp @@ -1,28 +1,25 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Priority_Reactor_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_Priority_Reactor>. The test forks -// two processes (for a total of three processes) which connect to -// the main process and The clients send data to a connector, -// interestingly enough the acceptor will give more priority to -// the second connection, which should run always before the first -// one. -// -// The test itself is interesting, it shows how to write very -// simple <ACE_Svc_Handler>, <ACE_Connectors> and <ACE_Acceptors>. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Priority_Reactor_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_Priority_Reactor>. The test forks + * two processes (for a total of three processes) which connect to + * the main process and The clients send data to a connector, + * interestingly enough the acceptor will give more priority to + * the second connection, which should run always before the first + * one. + * + * The test itself is interesting, it shows how to write very + * simple <ACE_Svc_Handler>, <ACE_Connectors> and <ACE_Acceptors>. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Get_Opt.h" diff --git a/ACE/tests/Priority_Reactor_Test.h b/ACE/tests/Priority_Reactor_Test.h index fdf17865448..4436822c496 100644 --- a/ACE/tests/Priority_Reactor_Test.h +++ b/ACE/tests/Priority_Reactor_Test.h @@ -1,22 +1,19 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Priority_Reactor_Test.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Priority_Reactor_Test.cpp. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Priority_Reactor_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Priority_Reactor_Test.cpp. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_PRIORITY_REACTOR_TEST_H #define ACE_TESTS_PRIORITY_REACTOR_TEST_H @@ -30,43 +27,47 @@ #include "ace/SOCK_Stream.h" #include "ace/Svc_Handler.h" +/** + * @class Read_Handler + * + * @brief A Svc_Handler with a priority twist. + * + * This Svc_Handler receives the data sent by the childs or writer + * threads; each one sets it own priority to a new level, in a + * cyclic manner. The main point is test and exercise the + * priority dispatching features of ACE_Priority_Reactor. + */ class Read_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH> - // = TITLE - // A Svc_Handler with a priority twist. - // - // = DESCRIPTION - // This Svc_Handler receives the data sent by the childs or writer - // threads; each one sets it own priority to a new level, in a - // cyclic manner. The main point is test and exercise the - // priority dispatching features of ACE_Priority_Reactor. { public: + /// Set the number of children or writer threads we will be running, + /// when they are all gone we terminate the reactor loop. static void set_countdown (int nchildren); - // Set the number of children or writer threads we will be running, - // when they are all gone we terminate the reactor loop. + /// Get the number of children we are still waiting for. static int get_countdown (void); - // Get the number of children we are still waiting for. + /// The Svc_Handler callbacks. virtual int open (void *); virtual int handle_input (ACE_HANDLE h); - // The Svc_Handler callbacks. private: + /// How many writers are we waiting for. static int waiting_; - // How many writers are we waiting for. + /// How many readers have started. static int started_; - // How many readers have started. }; +/** + * @class Write_Handler + * + * @brief A simple writer. + * + * This Svc_Handler simply connects to a server and sends some + * output to it. Its purpose is to feed the test. + */ class Write_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH> - // = TITLE - // A simple writer. - // - // = DESCRIPTION - // This Svc_Handler simply connects to a server and sends some - // output to it. Its purpose is to feed the test. { public: virtual int open (void *); diff --git a/ACE/tests/Priority_Task_Test.cpp b/ACE/tests/Priority_Task_Test.cpp index dcc4c604378..99b028e35f5 100644 --- a/ACE/tests/Priority_Task_Test.cpp +++ b/ACE/tests/Priority_Task_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Priority_Task_Test.cpp -// -// = DESCRIPTION -// This is a simple test to illustrate the priority mechanism of -// ACE Tasks. The test requires no options, but the -d option -// enables LM_DEBUG output. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Priority_Task_Test.cpp + * + * $Id$ + * + * This is a simple test to illustrate the priority mechanism of + * ACE Tasks. The test requires no options, but the -d option + * enables LM_DEBUG output. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -28,30 +25,34 @@ static const ACE_TCHAR *usage = ACE_TEXT ("usage: %s [-d]\n"); #if defined (ACE_HAS_THREADS) +/** + * @class Priority_Task + * + * @brief A simple Task that runs itself a different priorities. + * + * This task uses the void* argument on open to run the svc() + * method at a different priority. The point is execise the thread + * priority features of ACE. + */ class Priority_Task : public ACE_Task<ACE_MT_SYNCH> { - // = TITLE - // A simple Task that runs itself a different priorities. - // - // = DESCRIPTION - // This task uses the void* argument on open to run the svc() - // method at a different priority. The point is execise the thread - // priority features of ACE. public: + /// The constructor Priority_Task (void); - // The constructor //FUZZ: disable check_for_lack_ACE_OS + /** + * Receives the priority and run svc() on a separate thread at that + * priority. + *FUZZ: enable check_for_lack_ACE_OS + */ int open (void *); - // Receives the priority and run svc() on a separate thread at that - // priority. - //FUZZ: enable check_for_lack_ACE_OS + /// Runs on a separate thread an checks the priority. int svc (void); - // Runs on a separate thread an checks the priority. + /// Returns 1 if priority was set properly, 0 otherwise. int succeeded (void) { return error_ == 0; } - // Returns 1 if priority was set properly, 0 otherwise. private: int priority_; diff --git a/ACE/tests/Proactor_Test.h b/ACE/tests/Proactor_Test.h index f23389f73e2..4306b82937c 100644 --- a/ACE/tests/Proactor_Test.h +++ b/ACE/tests/Proactor_Test.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Proactor_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// @author Alexander Libman <alibman@baltimore.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Proactor_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author @author Alexander Libman <alibman@baltimore.com> + */ +//============================================================================= + #ifndef ACE_TESTS_PROACTOR_TEST_H #define ACE_TESTS_PROACTOR_TEST_H @@ -49,13 +46,13 @@ public: void cancel (); protected: + //// This is called when asynchronous <read> operation from the + //// socket completes. /** * @name AIO callback handling * * These methods are called by the framework */ - /// This is called when asynchronous <read> operation from the - /// socket completes. virtual void handle_read_stream (const ACE_Asynch_Read_Stream::Result &result); /// This is called when an asynchronous <write> to the socket @@ -108,11 +105,11 @@ public: virtual void addresses (const ACE_INET_Addr& peer, const ACE_INET_Addr& local); + /// This is called when asynchronous reads from the socket complete virtual void handle_read_stream (const ACE_Asynch_Read_Stream::Result &result); - // This is called when asynchronous reads from the socket complete + /// This is called when asynchronous writes from the socket complete virtual void handle_write_stream (const ACE_Asynch_Write_Stream::Result &result); - // This is called when asynchronous writes from the socket complete void cancel (void); diff --git a/ACE/tests/Proactor_Timer_Test.cpp b/ACE/tests/Proactor_Timer_Test.cpp index 04763c456cc..d27601bb3ce 100644 --- a/ACE/tests/Proactor_Timer_Test.cpp +++ b/ACE/tests/Proactor_Timer_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Proctor_Timer_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the timer mechanism of -// the <ACE_Proactor>. Scheduling timers, handling expired timers and -// cancelling scheduled timers are all exercised in this test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, and -// Miljenko Norsic <Miljenko.Norsic@etk.ericsson.se> -// -// ============================================================================ + +//============================================================================= +/** + * @file Proactor_Timer_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the timer mechanism of + * the <ACE_Proactor>. Scheduling timers, handling expired timers and + * cancelling scheduled timers are all exercised in this test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author and Miljenko Norsic <Miljenko.Norsic@etk.ericsson.se> + */ +//============================================================================= + #include "test_config.h" #include "ace/Trace.h" @@ -40,21 +37,21 @@ static int odd = 0; class Time_Handler : public ACE_Handler { public: + /// Default constructor Time_Handler (); - // Default constructor + /// Handle the timeout. virtual void handle_time_out (const ACE_Time_Value &tv, const void *arg); - // Handle the timeout. + /// Return our timer id. long timer_id (void) const; - // Return our timer id. + /// Set our timer id; void timer_id (long); - // Set our timer id; private: + /// Stores the id of this timer. long timer_id_; - // Stores the id of this timer. }; /* diff --git a/ACE/tests/Process_Env_Test.cpp b/ACE/tests/Process_Env_Test.cpp index 59409263b91..116f800ad5e 100644 --- a/ACE/tests/Process_Env_Test.cpp +++ b/ACE/tests/Process_Env_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Env_Test.cpp -// -// = DESCRIPTION -// This program tests the limits of the Windows CreateProcess -// environment buffer. -// -// = AUTHOR -// Chad Elliott <elliott_c@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Env_Test.cpp + * + * $Id$ + * + * This program tests the limits of the Windows CreateProcess + * environment buffer. + * + * + * @author Chad Elliott <elliott_c@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/Process_Manager_Test.cpp b/ACE/tests/Process_Manager_Test.cpp index 58638b2b878..49554a66ba3 100644 --- a/ACE/tests/Process_Manager_Test.cpp +++ b/ACE/tests/Process_Manager_Test.cpp @@ -1,29 +1,25 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Manager_Test.cpp -// -// = DESCRIPTION -// This program tests the various methods provided by -// <ACE_Process_Manager>. It illustrates both the explicit <wait> -// functions and the Reactor-style auto-reaping. There's an -// Exit_Handler class that can print out (in Debug mode) when a -// child has been reaped. -// -// The child processes spawned are simply this program itself, with -// an integer argument specifying how long to "process" (actually, -// the child just sleeps for the specified length of time). -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> and -// Dave Madden <dhm@mersenne.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Manager_Test.cpp + * + * $Id$ + * + * This program tests the various methods provided by + * <ACE_Process_Manager>. It illustrates both the explicit <wait> + * functions and the Reactor-style auto-reaping. There's an + * Exit_Handler class that can print out (in Debug mode) when a + * child has been reaped. + * + * The child processes spawned are simply this program itself, with + * an integer argument specifying how long to "process" (actually, + * the child just sleeps for the specified length of time). + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> and Dave Madden <dhm@mersenne.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/SString.h" @@ -181,8 +177,8 @@ public: sleep_time_ (sleep_time) { } // FUZZ: disable check_for_lack_ACE_OS + /// FUZZ: enable check_for_lack_ACE_OS int open (void*) - // FUZZ: enable check_for_lack_ACE_OS { char tmp[10]; order += ACE_OS::itoa (sleep_time_, tmp, 10); @@ -222,8 +218,8 @@ public: } // FUZZ: disable check_for_lack_ACE_OS + /// FUZZ: enable check_for_lack_ACE_OS int close (u_long) - // FUZZ: enable check_for_lack_ACE_OS { --running_tasks; return 0; diff --git a/ACE/tests/Process_Manual_Event_Test.cpp b/ACE/tests/Process_Manual_Event_Test.cpp index 9da4d9d8229..389fc91aa8c 100644 --- a/ACE/tests/Process_Manual_Event_Test.cpp +++ b/ACE/tests/Process_Manual_Event_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Manual_Event_Test.cpp -// -// = DESCRIPTION -// This test verifies the functionality of the <ACE_Manual_Event> -// process-shared implementation. -// -// = AUTHOR -// Martin Corino <mcorino@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Manual_Event_Test.cpp + * + * $Id$ + * + * This test verifies the functionality of the <ACE_Manual_Event> + * process-shared implementation. + * + * + * @author Martin Corino <mcorino@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/Process_Mutex_Test.cpp b/ACE/tests/Process_Mutex_Test.cpp index bc1a530c58f..46273817eed 100644 --- a/ACE/tests/Process_Mutex_Test.cpp +++ b/ACE/tests/Process_Mutex_Test.cpp @@ -1,19 +1,16 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Mutex_Test.cpp -// -// = DESCRIPTION -// Tests an <ACE_Process_Mutex> shared between multiple child processes. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Process_Mutex_Test.cpp + * + * $Id$ + * + * Tests an <ACE_Process_Mutex> shared between multiple child processes. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Mutex.h" diff --git a/ACE/tests/Process_Semaphore_Test.cpp b/ACE/tests/Process_Semaphore_Test.cpp index 3bf8d104d2c..42053baa5fd 100644 --- a/ACE/tests/Process_Semaphore_Test.cpp +++ b/ACE/tests/Process_Semaphore_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Semaphore_Test.cpp -// -// = DESCRIPTION -// Tests an ACE Semaphore shared between multiple child processes. -// -// = AUTHOR -// Martin Corino <mcorino@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Semaphore_Test.cpp + * + * $Id$ + * + * Tests an ACE Semaphore shared between multiple child processes. + * + * + * @author Martin Corino <mcorino@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Mutex.h" diff --git a/ACE/tests/Process_Strategy_Test.cpp b/ACE/tests/Process_Strategy_Test.cpp index ec92f62df05..61cd3619933 100644 --- a/ACE/tests/Process_Strategy_Test.cpp +++ b/ACE/tests/Process_Strategy_Test.cpp @@ -1,41 +1,37 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Strategy_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_Strategy_Acceptor> and -// <ACE_File_Lock> classes. The <ACE_Strategy_Acceptor> uses -// either the <ACE_Process_Strategy> (which forks a -// process-per-connection and runs as a concurrent server -// process), the <ACE_Thread_Strategy> (which spawns a -// thread-per-connection and runs as a concurrent server thread), -// or <ACE_Reactive_Strategy> (which register the <Svc_Handler> -// with the <Reactor> and runs in the main thread of control as an -// iterative server). This server queries and increments a -// "counting value" in a file. -// -// This test program can be run in the following ways: -// -// # Run the server "reactively" (i.e., iteratively) -// % Process_Strategy_Test -c REACTIVE -// -// # Run the server in multi-threads. -// % Process_Strategy_Test -c THREAD -// -// # Run the server in multi-processes -// % Process_Strategy_Test -c PROCESS -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// and Kevin Boyle <kboyle@sanwafp.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Strategy_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_Strategy_Acceptor> and + * <ACE_File_Lock> classes. The <ACE_Strategy_Acceptor> uses + * either the <ACE_Process_Strategy> (which forks a + * process-per-connection and runs as a concurrent server + * process), the <ACE_Thread_Strategy> (which spawns a + * thread-per-connection and runs as a concurrent server thread), + * or <ACE_Reactive_Strategy> (which register the <Svc_Handler> + * with the <Reactor> and runs in the main thread of control as an + * iterative server). This server queries and increments a + * "counting value" in a file. + * + * This test program can be run in the following ways: + * + * # Run the server "reactively" (i.e., iteratively) + * % Process_Strategy_Test -c REACTIVE + * + * # Run the server in multi-threads. + * % Process_Strategy_Test -c THREAD + * + * # Run the server in multi-processes + * % Process_Strategy_Test -c PROCESS + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> and Kevin Boyle <kboyle@sanwafp.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Process_Strategy_Test.h b/ACE/tests/Process_Strategy_Test.h index 9278e37404a..52365621ea0 100644 --- a/ACE/tests/Process_Strategy_Test.h +++ b/ACE/tests/Process_Strategy_Test.h @@ -1,20 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// = FILENAME -// Process_Strategy_Test.h -// -// = DESCRIPTION -// This file contains the definition of Counting_Service and -// Options. Some compilers need it in a .h file for template -// instantiation (such as AIX C Set ++). -// -// = AUTHOR -// Doug Schmidt <schmidt@cs.wustl.edu> and -// Kevin Boyle <kboyle@sanwafp.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Strategy_Test.h + * + * $Id$ + * + * This file contains the definition of Counting_Service and + * Options. Some compilers need it in a .h file for template + * instantiation (such as AIX C Set ++). + * + * + * @author Doug Schmidt <schmidt@cs.wustl.edu> and Kevin Boyle <kboyle@sanwafp.com> + */ +//============================================================================= + #ifndef ACE_TESTS_PROCESS_STRATEGY_TEST_H #define ACE_TESTS_PROCESS_STRATEGY_TEST_H @@ -30,44 +30,46 @@ #include "ace/Svc_Handler.h" #include "ace/Strategies_T.h" +/** + * @class Counting_Service + * + * @brief Reads and increments the count in a shared file. + * + * Objects of this class execute in a separate process as a + * result of the <ACE_Strategy_Acceptor> and + * <ACE_Process_Strategy>. + */ class Counting_Service : public ACE_Svc_Handler <ACE_SOCK_STREAM, ACE_NULL_SYNCH> - // = TITLE - // Reads and increments the count in a shared file. - // - // = DESCRIPTION - // Objects of this class execute in a separate process as a - // result of the <ACE_Strategy_Acceptor> and - // <ACE_Process_Strategy>. { public: + /// Constructor. Counting_Service (ACE_Thread_Manager * = 0); - // Constructor. + /// Hook that is used to initialize the service (called by the + /// <ACE_Strategy_Acceptor::handle_input> Template Method). virtual int open (void *v); - // Hook that is used to initialize the service (called by the - // <ACE_Strategy_Acceptor::handle_input> Template Method). protected: // = Methods invoked via "pointer to method" table entry. + /// Handle the THREAD case. virtual int svc (void); - // Handle the THREAD case. // = Operations corresponding to requests from the client. + /// Execute the read operation on the file. int read (void); - // Execute the read operation on the file. + /// Execute the increment operation on the file. int inc (void); - // Execute the increment operation on the file. // = Hooks called by <Reactor> and <Strategy_Acceptor>. + /// Hook called by the <Reactor> when data arrives from the client. virtual int handle_input (ACE_HANDLE p = ACE_INVALID_HANDLE); - // Hook called by the <Reactor> when data arrives from the client. + /// Closing down virtual int handle_close (ACE_HANDLE = ACE_INVALID_HANDLE, ACE_Reactor_Mask = ACE_Event_Handler::ALL_EVENTS_MASK); - // Closing down }; class Process_Strategy : public ACE_Process_Strategy<Counting_Service> @@ -89,19 +91,22 @@ public: void *arg = 0); }; +/** + * @class Options + * + * @brief Maintains the options for this program. + */ class Options : public ACE_Event_Handler - // = TITLE - // Maintains the options for this program. { public: + /// Constructor. Options (void); - // Constructor. + /// Destructor. ~Options (void); - // Destructor. + /// Read command-line arguments and initialize options. int parse_args (int argc, ACE_TCHAR *argv[]); - // Read command-line arguments and initialize options. enum Concurrency_Type { @@ -114,28 +119,28 @@ public: Concurrency_Type concurrency_type (void); void concurrency_type (Concurrency_Type); + /// Returns the file lock. ACE_File_Lock &file_lock (void); - // Returns the file lock. + /// Returns the filename that we're using as the lock. const ACE_TCHAR *filename (void); - // Returns the filename that we're using as the lock. + /// Returns the concurrency strategy. ACE_Concurrency_Strategy <Counting_Service> *concurrency_strategy (void); - // Returns the concurrency strategy. private: + /// Concurrency strategy that we're running. Concurrency_Type concurrency_type_; - // Concurrency strategy that we're running. + /// Lock for the counting file. ACE_File_Lock file_lock_; - // Lock for the counting file. + /// Activation strategy that either forks a new process or spawns a + /// new thread for each client connection. ACE_Concurrency_Strategy<Counting_Service> *concurrency_strategy_; - // Activation strategy that either forks a new process or spawns a - // new thread for each client connection. + /// Name of the counting file. ACE_TCHAR filename_[MAXPATHLEN + 1]; - // Name of the counting file. }; #endif /* ACE_TESTS_PROCESS_STRATEGY_TEST_H */ diff --git a/ACE/tests/Process_Test.cpp b/ACE/tests/Process_Test.cpp index 4aab9a1ab15..69b68b98eb5 100644 --- a/ACE/tests/Process_Test.cpp +++ b/ACE/tests/Process_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Process_Test.cpp -// -// = DESCRIPTION -// Tests ACE_Process file handle inheritance for UNIX-like systems -// -// = AUTHOR -// Christian Fromme <kaner@strace.org> -// -// ============================================================================ + +//============================================================================= +/** + * @file Process_Test.cpp + * + * $Id$ + * + * Tests ACE_Process file handle inheritance for UNIX-like systems + * + * + * @author Christian Fromme <kaner@strace.org> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/QtReactor_Test.cpp b/ACE/tests/QtReactor_Test.cpp index c871969f37c..8106433745a 100644 --- a/ACE/tests/QtReactor_Test.cpp +++ b/ACE/tests/QtReactor_Test.cpp @@ -1,43 +1,40 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// QtReactor_Test.cpp -// -// = DESCRIPTION -// Simple test of QtReactor. Test is intended to verify if QtReactor -// correctly cooperates with Qt event loop in typical application. Test -// creates a number of timers which send datagrams. These datagrams are -// expected by datagram_handlers registered in reactor. Test asynchronously -// establishes also a number of loopback tcp connections using ACE_Acceptors -// and ACE_Connectors. Socket activities are handled asynchronously to ensure -// that reactor does not lose events in traffic transmission. Moreover, test -// registers and removes handlers frequently to cover register/remove_handler -// method of QtReactor which are known (10/07/2004) to be buggy. -// -// Classes: -// QTestApplication - main qt application running event loop for a -// finite time -// Dgram_Handler - responsible for sending and receiving datagrams as -// well as handling timeouts. Datagrams are sent in -// handle_timeout method. -// TCPConnectionHandler - connection handler responsible for sending and -// receiving data using tcp streams. -// TCPAcceptorHandler - acceptor responsible for acceptance and -// registration of connections in HandlersRegister -// class. -// HandlersRegister - register of event_handlers, responsible also for -// the analysis of test results. -// -// = AUTHOR -// Marek Brudka <mbrudka@elka.pw.edu.pl> -// -// ============================================================================ + +//============================================================================= +/** + * @file QtReactor_Test.cpp + * + * $Id$ + * + * Simple test of QtReactor. Test is intended to verify if QtReactor + * correctly cooperates with Qt event loop in typical application. Test + * creates a number of timers which send datagrams. These datagrams are + * expected by datagram_handlers registered in reactor. Test asynchronously + * establishes also a number of loopback tcp connections using ACE_Acceptors + * and ACE_Connectors. Socket activities are handled asynchronously to ensure + * that reactor does not lose events in traffic transmission. Moreover, test + * registers and removes handlers frequently to cover register/remove_handler + * method of QtReactor which are known (10/07/2004) to be buggy. + * + * Classes: + * QTestApplication - main qt application running event loop for a + * finite time + * Dgram_Handler - responsible for sending and receiving datagrams as + * well as handling timeouts. Datagrams are sent in + * handle_timeout method. + * TCPConnectionHandler - connection handler responsible for sending and + * receiving data using tcp streams. + * TCPAcceptorHandler - acceptor responsible for acceptance and + * registration of connections in HandlersRegister + * class. + * HandlersRegister - register of event_handlers, responsible also for + * the analysis of test results. + * + * + * @author Marek Brudka <mbrudka@elka.pw.edu.pl> + */ +//============================================================================= + #include "test_config.h" @@ -165,8 +162,8 @@ public: virtual int handle_close (ACE_HANDLE handle,ACE_Reactor_Mask close_mask); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS virtual int open (void * = 0); - //FUZZ: enable check_for_lack_ACE_OS int scheduleSend (ACE_Message_Block *); int sendBuffers (); diff --git a/ACE/tests/RB_Tree_Test.cpp b/ACE/tests/RB_Tree_Test.cpp index fd369d0d5ba..2e752a50e5b 100644 --- a/ACE/tests/RB_Tree_Test.cpp +++ b/ACE/tests/RB_Tree_Test.cpp @@ -1,30 +1,27 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// RB_Tree_Test.cpp -// -// = DESCRIPTION -// This is a test to verify and illustrate the use of the -// <ACE_RB_Tree ACE_RB_Tree_Iterator> and -// <ACE_RB_Tree_Reverse_Iterator> classes. Two different key and -// item types are used in order to demonstrate specialization of -// the <ACE_Less_Than> comparison function object template: int -// (for which the native < operator is sufficient), and const char -// * (for which < operator semantics must be replaced by strcmp -// semantics). An RB tree for each of the four possible type -// parameter permutations over int and const char * is constructed -// and filled in, and the resulting order is checked via an -// iterator over each. -// -// = AUTHOR -// Chris Gill <cdgill@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file RB_Tree_Test.cpp + * + * $Id$ + * + * This is a test to verify and illustrate the use of the + * <ACE_RB_Tree ACE_RB_Tree_Iterator> and + * <ACE_RB_Tree_Reverse_Iterator> classes. Two different key and + * item types are used in order to demonstrate specialization of + * the <ACE_Less_Than> comparison function object template: int + * (for which the native < operator is sufficient), and const char + * * (for which < operator semantics must be replaced by strcmp + * semantics). An RB tree for each of the four possible type + * parameter permutations over int and const char * is constructed + * and filled in, and the resulting order is checked via an + * iterator over each. + * + * + * @author Chris Gill <cdgill@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" /* Include first to enable ACE_TEST_ASSERT. */ #include "ace/RB_Tree.h" diff --git a/ACE/tests/RB_Tree_Test.h b/ACE/tests/RB_Tree_Test.h index 4f20674a17f..5f005e46e6c 100644 --- a/ACE/tests/RB_Tree_Test.h +++ b/ACE/tests/RB_Tree_Test.h @@ -1,33 +1,32 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// RB_Tree_Test.cpp -// -// = DESCRIPTION -// Header file for a test to verify and illustrate the use of the -// ACE_RB_Tree ACE_RB_Tree_Iterator, and -// ACE_RB_Tree_Reverse_Iterator classes. -// iterator over each. -// -// = AUTHOR -// Chris Gill <cdgill@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file RB_Tree_Test.h + * + * $Id$ + * + * Header file for a test to verify and illustrate the use of the + * ACE_RB_Tree ACE_RB_Tree_Iterator, and + * ACE_RB_Tree_Reverse_Iterator classes. + * iterator over each. + * + * + * @author Chris Gill <cdgill@cs.wustl.edu> + */ +//============================================================================= + + +/** + * @class ACE_RB_Tree_Test + * + * @brief Implements a templatized test class for the RB_Tree ADT and its + * iterators. + * + */ template <class EXT_ID, class INT_ID, class COMPARE_KEYS, class ACE_LOCK> class ACE_RB_Tree_Test { - // = TITLE - // Implements a templatized test class for the RB_Tree ADT and its - // iterators. - // - // = DESCRIPTION // To run the test class on a particular type instantiation of the // RB_Tree, simply instantiate the test class template with the @@ -44,69 +43,69 @@ public: // = Initialization and termination methods. + /// Constructor. ACE_RB_Tree_Test (int entry_count, EXT_ID key_array [], INT_ID item_array [], int order_index []); - // Constructor. + /// Destructor. ~ACE_RB_Tree_Test (void); - // Destructor. + /// Run the individual interface and iteration tests in order. void run_test (void); - // Run the individual interface and iteration tests in order. private: + /// Tests stable and deprecated insertion interfaces. void test_tree_insertion (void); - // Tests stable and deprecated insertion interfaces. + /// Tests forward and reverse iteration after insertion in both + /// trees. void test_post_insertion_iteration (void); - // Tests forward and reverse iteration after insertion in both - // trees. + ///Tests forward and reverse partial iteration void test_partial_iteration(void); - //Tests forward and reverse partial iteration + /// Tests stable and deprecated deletion interfaces. void test_tree_deletion (void); - // Tests stable and deprecated deletion interfaces. + /// Tests forward and reverse iteration after deletions in both + /// trees. void test_post_deletion_iteration (void); - // Tests forward and reverse iteration after deletions in both - // trees. + /// Tree for testing stable interface. TREE stable_tree_; - // Tree for testing stable interface. + /// Forward iterator for tree for testing stable interface. ITERATOR stable_fwd_iter_; - // Forward iterator for tree for testing stable interface. ITERATOR part_fwd_iter_; REVERSE_ITERATOR part_rev_iter_; + /// Forward iterator for tree for testing stable interface. REVERSE_ITERATOR stable_rev_iter_; - // Forward iterator for tree for testing stable interface. + /// Tree for testing deprecated interface. TREE deprecated_tree_; - // Tree for testing deprecated interface. + /// Forward iterator for tree for testing deprecated interface. ITERATOR deprecated_fwd_iter_; - // Forward iterator for tree for testing deprecated interface. + /// Forward iterator for tree for testing deprecated interface. REVERSE_ITERATOR deprecated_rev_iter_; - // Forward iterator for tree for testing deprecated interface. + /// Number of entries in the key, item, and index arrays. int entry_count_; - // Number of entries in the key, item, and index arrays. + /// Array of EXT_IDs (keys) with which to test. EXT_ID *key_array_; - // Array of EXT_IDs (keys) with which to test. + /// Array of INT_IDs (items) with which to test. INT_ID *item_array_; - // Array of INT_IDs (items) with which to test. + /// Order of indices in the key and item arrays. int *order_index_; - // Order of indices in the key and item arrays. }; diff --git a/ACE/tests/RW_Process_Mutex_Test.cpp b/ACE/tests/RW_Process_Mutex_Test.cpp index a985344435e..743af11191f 100644 --- a/ACE/tests/RW_Process_Mutex_Test.cpp +++ b/ACE/tests/RW_Process_Mutex_Test.cpp @@ -1,19 +1,16 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// RW_Process_Mutex_Test.cpp -// -// = DESCRIPTION -// Tests an <ACE_RW_Process_Mutex> shared between multiple child processes. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ +//============================================================================= +/** + * @file RW_Process_Mutex_Test.cpp + * + * $Id$ + * + * Tests an <ACE_RW_Process_Mutex> shared between multiple child processes. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/Reactor_Dispatch_Order_Test.cpp b/ACE/tests/Reactor_Dispatch_Order_Test.cpp index 1f5d10bc77f..648c5d48765 100644 --- a/ACE/tests/Reactor_Dispatch_Order_Test.cpp +++ b/ACE/tests/Reactor_Dispatch_Order_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Dispatch_Order_Test.cpp -// -// = DESCRIPTION -// This is a simple test that checks the order of dispatching of -// ACE Reactors. Order should be: timeout, output, and then input. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Dispatch_Order_Test.cpp + * + * $Id$ + * + * This is a simple test that checks the order of dispatching of + * ACE Reactors. Order should be: timeout, output, and then input. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp b/ACE/tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp index 861d3e735ce..29e3103d5d1 100644 --- a/ACE/tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp +++ b/ACE/tests/Reactor_Dispatch_Order_Test_Dev_Poll.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Dispatch_Order_Test.cpp -// -// = DESCRIPTION -// This is a simple test that checks the order of dispatching of -// ACE Reactors. Order should be: timeout, output, and then input. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Dispatch_Order_Test_Dev_Poll.cpp + * + * $Id$ + * + * This is a simple test that checks the order of dispatching of + * ACE Reactors. Order should be: timeout, output, and then input. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Reactor_Exceptions_Test.cpp b/ACE/tests/Reactor_Exceptions_Test.cpp index 450cec8dcbe..d020ea2d61d 100644 --- a/ACE/tests/Reactor_Exceptions_Test.cpp +++ b/ACE/tests/Reactor_Exceptions_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Exceptions_Test.cpp -// -// = DESCRIPTION -// This is a test that makes sure the <ACE_Reactor> works -// correctly in the face of C++ exceptions and threads. -// -// = AUTHOR -// Luca Priorelli <lucapri@mbox.vol.it> and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Exceptions_Test.cpp + * + * $Id$ + * + * This is a test that makes sure the <ACE_Reactor> works + * correctly in the face of C++ exceptions and threads. + * + * + * @author Luca Priorelli <lucapri@mbox.vol.it> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/Reactor_Fairness_Test.cpp b/ACE/tests/Reactor_Fairness_Test.cpp index 39d1c8bdfde..dbc5f0478d3 100644 --- a/ACE/tests/Reactor_Fairness_Test.cpp +++ b/ACE/tests/Reactor_Fairness_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Performance_Test.cpp -// -// = DESCRIPTION -// This test is used to time the dispatching mechanisms of the -// <ACE_Reactor>s. Both the <ACE_WFMO_Reactor> and -// <ACE_Select_Reactor> can be tested. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Fairness_Test.cpp + * + * $Id$ + * + * This test is used to time the dispatching mechanisms of the + * <ACE_Reactor>s. Both the <ACE_WFMO_Reactor> and + * <ACE_Select_Reactor> can be tested. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "Reactor_Fairness_Test.h" diff --git a/ACE/tests/Reactor_Fairness_Test.h b/ACE/tests/Reactor_Fairness_Test.h index 6b8815ace11..589947cef17 100644 --- a/ACE/tests/Reactor_Fairness_Test.h +++ b/ACE/tests/Reactor_Fairness_Test.h @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Fairness_Test.h -// -// = DESCRIPTION -// This file includes template class definitions for the -// Reactor_Fairness_Test.cpp program. This class gets its own -// header file to work around AIX C++ compiler "features" related -// to template instantiation... -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Fairness_Test.h + * + * $Id$ + * + * This file includes template class definitions for the + * Reactor_Fairness_Test.cpp program. This class gets its own + * header file to work around AIX C++ compiler "features" related + * to template instantiation... + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #ifndef ACE_TESTS_REACTOR_FAIRNESS_TEST_H #define ACE_TESTS_REACTOR_FAIRNESS_TEST_H @@ -30,17 +27,20 @@ #include "ace/Svc_Handler.h" +/** + * @class Read_Handler + * + * @brief Simple class for reading in the data + */ class Read_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_NULL_SYNCH> { - // = TITLE - // Simple class for reading in the data public: Read_Handler () : chunks_in (0) {} + /// The Svc_Handler callbacks. virtual int handle_input (ACE_HANDLE h); virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask); - // The Svc_Handler callbacks. private: unsigned int chunks_in; diff --git a/ACE/tests/Reactor_Notify_Test.cpp b/ACE/tests/Reactor_Notify_Test.cpp index 2e9b635c77e..128a2c61a43 100644 --- a/ACE/tests/Reactor_Notify_Test.cpp +++ b/ACE/tests/Reactor_Notify_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Notify_Test.cpp -// -// = DESCRIPTION -// This is a test that illustrates how the <ACE_Reactor>'s -// <notify> method works under various <max_notify_iterations> -// settings. It also tests that the <disable_notify_pipe> option -// works correctly. Moreover, if the $ACE_ROOT/ace/config.h file -// has the ACE_HAS_REACTOR_NOTIFICATION_QUEUE option enabled this -// test will also exercise this feature. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Notify_Test.cpp + * + * $Id$ + * + * This is a test that illustrates how the <ACE_Reactor>'s + * <notify> method works under various <max_notify_iterations> + * settings. It also tests that the <disable_notify_pipe> option + * works correctly. Moreover, if the $ACE_ROOT/ace/config.h file + * has the ACE_HAS_REACTOR_NOTIFICATION_QUEUE option enabled this + * test will also exercise this feature. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" @@ -48,8 +45,8 @@ public: ~Quiet_Notify_Tester (void) { this->wait (); } //FUZZ: disable check_for_lack_ACE_OS + /// Start the reactor event thread. virtual int open (void * = 0); - // Start the reactor event thread. // Run the reactor event loop. virtual int svc (void); @@ -117,58 +114,64 @@ run_quiet_notify_test (void) class Supplier_Task : public ACE_Task<ACE_MT_SYNCH> { public: + /// Constructor. Supplier_Task (int disable_notify_pipe, const ACE_Time_Value &tv); - // Constructor. + /// Destructor. ~Supplier_Task (void); - // Destructor. //FUZZ: disable check_for_lack_ACE_OS + /// Make this an Active Object. virtual int open (void * = 0); - // Make this an Active Object. + /// Close down the supplier. + ///FUZZ: enable check_for_lack_ACE_OS virtual int close (u_long); - // Close down the supplier. - //FUZZ: enable check_for_lack_ACE_OS + /// Generates events and sends them to the <Reactor>'s <notify> + /// method. virtual int svc (void); - // Generates events and sends them to the <Reactor>'s <notify> - // method. + /// Releases the <waiter_> semaphore when called by the <Reactor>'s + /// notify handler. virtual int handle_exception (ACE_HANDLE); - // Releases the <waiter_> semaphore when called by the <Reactor>'s - // notify handler. + /** + * Called every time through the main <ACE_Reactor> event loop to + * illustrate the difference between "limited" and "unlimited" + * notification. + */ virtual int handle_output (ACE_HANDLE); - // Called every time through the main <ACE_Reactor> event loop to - // illustrate the difference between "limited" and "unlimited" - // notification. + /// Release the <waiter_>. void release (void); - // Release the <waiter_>. private: + /// Perform the notifications. int perform_notifications (int notifications); - // Perform the notifications. + /// Used to hand-shake between the <Supplier_Task> and the + /// <Reactor>'s notify mechanism. ACE_Thread_Semaphore waiter_; - // Used to hand-shake between the <Supplier_Task> and the - // <Reactor>'s notify mechanism. + /** + * We use this pipe just to get a handle that is always "active," + * i.e., the <ACE_Reactor> will always dispatch its <handle_output> + * method. + */ ACE_Pipe pipe_; - // We use this pipe just to get a handle that is always "active," - // i.e., the <ACE_Reactor> will always dispatch its <handle_output> - // method. + /// Keeps track of whether the notification pipe in the <ACE_Reactor> + /// has been diabled or not. int disable_notify_pipe_; - // Keeps track of whether the notification pipe in the <ACE_Reactor> - // has been diabled or not. + /** + * Keeps track of whether we're running with a <LONG_TIMEOUT>, which + * is used for the ACE_HAS_REACTOR_NOTIFICATION_QUEUE portion of + * this test. + */ int long_timeout_; - // Keeps track of whether we're running with a <LONG_TIMEOUT>, which - // is used for the ACE_HAS_REACTOR_NOTIFICATION_QUEUE portion of - // this test. }; void @@ -439,13 +442,16 @@ run_test (int disable_notify_pipe, #endif /* ACE_HAS_THREADS */ +/** + * @class Purged_Notify + * + * @brief <run_notify_purge_test> tests the reactor's + * purge_pending_notifications function. It does 2 notifications, + * and explicitly cancels one, and deletes the other's event + * handler, which should cause it to be cancelled as well. + */ class Purged_Notify : public ACE_Event_Handler { - // = TITLE - // <run_notify_purge_test> tests the reactor's - // purge_pending_notifications function. It does 2 notifications, - // and explicitly cancels one, and deletes the other's event - // handler, which should cause it to be cancelled as well. virtual int handle_exception (ACE_HANDLE = ACE_INVALID_HANDLE) { diff --git a/ACE/tests/Reactor_Performance_Test.cpp b/ACE/tests/Reactor_Performance_Test.cpp index 267553c1d57..47148b56cf6 100644 --- a/ACE/tests/Reactor_Performance_Test.cpp +++ b/ACE/tests/Reactor_Performance_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Performance_Test.cpp -// -// = DESCRIPTION -// This test is used to time the dispatching mechanisms of the -// <ACE_Reactor>s. Both the <ACE_WFMO_Reactor> and -// <ACE_Select_Reactor> can be tested. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Performance_Test.cpp + * + * $Id$ + * + * This test is used to time the dispatching mechanisms of the + * <ACE_Reactor>s. Both the <ACE_WFMO_Reactor> and + * <ACE_Select_Reactor> can be tested. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "Reactor_Performance_Test.h" diff --git a/ACE/tests/Reactor_Performance_Test.h b/ACE/tests/Reactor_Performance_Test.h index bde943c2951..139752c9090 100644 --- a/ACE/tests/Reactor_Performance_Test.h +++ b/ACE/tests/Reactor_Performance_Test.h @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Performance_Test.h -// -// = DESCRIPTION -// This file includes template class definitions for the -// Reactor_Performance_Test.cpp program. This class gets its own -// header file to work around AIX C++ compiler "features" related -// to template instantiation... -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> and -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Performance_Test.h + * + * $Id$ + * + * This file includes template class definitions for the + * Reactor_Performance_Test.cpp program. This class gets its own + * header file to work around AIX C++ compiler "features" related + * to template instantiation... + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> and Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #ifndef ACE_TESTS_REACTOR_PERFORMANCE_TEST_H #define ACE_TESTS_REACTOR_PERFORMANCE_TEST_H @@ -31,29 +27,35 @@ #include "ace/Svc_Handler.h" +/** + * @class Read_Handler + * + * @brief Simple class for reading in the data + */ class Read_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH> { - // = TITLE - // Simple class for reading in the data public: static void set_countdown (int nconnections); + /// The Svc_Handler callbacks. virtual int open (void *); virtual int handle_input (ACE_HANDLE h); virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask); - // The Svc_Handler callbacks. private: + /// How many connections are we waiting for. static int waiting_; - // How many connections are we waiting for. }; +/** + * @class Write_Handler + * + * @brief This Svc_Handler simply connects to a server and sends some + * output to it. Its purpose is to feed the test. + */ class Write_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH> { - // = TITLE - // This Svc_Handler simply connects to a server and sends some - // output to it. Its purpose is to feed the test. public: virtual int open (void *); virtual int send_data (void); diff --git a/ACE/tests/Reactor_Registration_Test.cpp b/ACE/tests/Reactor_Registration_Test.cpp index f623a8fc3f6..98ffede2e91 100644 --- a/ACE/tests/Reactor_Registration_Test.cpp +++ b/ACE/tests/Reactor_Registration_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Registration_Test.cpp -// -// = DESCRIPTION -// This is a test of registering handlers with the Reactor. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Registration_Test.cpp + * + * $Id$ + * + * This is a test of registering handlers with the Reactor. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Pipe.h" diff --git a/ACE/tests/Reactor_Timer_Test.cpp b/ACE/tests/Reactor_Timer_Test.cpp index 8a564ebc2c2..f376b51c069 100644 --- a/ACE/tests/Reactor_Timer_Test.cpp +++ b/ACE/tests/Reactor_Timer_Test.cpp @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactor_Timer_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the timer mechanism of -// the reactor. Scheduling timers, resetting timer intervals, -// handling expired timers and cancelling scheduled timers are -// all exercised in this test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt -// <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Timer_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the timer mechanism of + * the reactor. Scheduling timers, resetting timer intervals, + * handling expired timers and cancelling scheduled timers are + * all exercised in this test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Timer_Queue.h" @@ -37,26 +33,26 @@ static int odd = 0; class Time_Handler : public ACE_Event_Handler { public: + /// Default constructor Time_Handler (); - // Default constructor + /// Handle the timeout. virtual int handle_timeout (const ACE_Time_Value &tv, const void *arg); - // Handle the timeout. + /// Called when <Time_Handler> is removed. virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask); - // Called when <Time_Handler> is removed. + /// Return our timer id. long timer_id (void) const; - // Return our timer id. + /// Set our timer id; void timer_id (long); - // Set our timer id; private: + /// Stores the id of this timer. long timer_id_; - // Stores the id of this timer. }; Time_Handler::Time_Handler () diff --git a/ACE/tests/Reactors_Test.cpp b/ACE/tests/Reactors_Test.cpp index ae8575981a2..fc3bb3e3be5 100644 --- a/ACE/tests/Reactors_Test.cpp +++ b/ACE/tests/Reactors_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reactors_Test.cpp -// -// = DESCRIPTION -// This is a test that performs a torture test of multiple -// <ACE_Reactors> and <ACE_Tasks> in the same process. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu>, -// Detlef Becker <Detlef.Becker@med.siemens.de>, and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactors_Test.cpp + * + * $Id$ + * + * This is a test that performs a torture test of multiple + * <ACE_Reactors> and <ACE_Tasks> in the same process. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + * @author Detlef Becker <Detlef.Becker@med.siemens.de> + * @author and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -33,9 +30,12 @@ ACE_Thread_Manager *thr_mgr; static const int MAX_TASKS = 20; +/** + * @class Test_Task + * + * @brief Exercise the tasks. + */ class Test_Task : public ACE_Task<ACE_MT_SYNCH> - // = TITLE - // Exercise the tasks. { public: // = Initialization and termination methods. @@ -44,21 +44,21 @@ public: //FUZZ: disable check_for_lack_ACE_OS // = Task hooks. + ///FUZZ: enable check_for_lack_ACE_OS virtual int open (void *args = 0); virtual int close (u_long flags = 0); virtual int svc (void); - //FUZZ: enable check_for_lack_ACE_OS // = Event Handler hooks. virtual int handle_input (ACE_HANDLE handle); virtual int handle_close (ACE_HANDLE fd, ACE_Reactor_Mask close_mask); private: + /// Number of iterations handled. size_t handled_; - // Number of iterations handled. + /// Number of tasks running. static int task_count_; - // Number of tasks running. }; // Static data member initialization. diff --git a/ACE/tests/Reader_Writer_Test.cpp b/ACE/tests/Reader_Writer_Test.cpp index 61344a29061..a96495ade53 100644 --- a/ACE/tests/Reader_Writer_Test.cpp +++ b/ACE/tests/Reader_Writer_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reader_Writer_Test.cpp -// -// = DESCRIPTION -// This test program verifies the functionality of the ACE_OS -// implementation of readers/writer locks on Win32 and Posix -// pthreads. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Doug C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reader_Writer_Test.cpp + * + * $Id$ + * + * This test program verifies the functionality of the ACE_OS + * implementation of readers/writer locks on Win32 and Posix + * pthreads. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Doug C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread.h" diff --git a/ACE/tests/Recursive_Condition_Bug_Test.cpp b/ACE/tests/Recursive_Condition_Bug_Test.cpp index ba7f00ee95d..e896e813856 100644 --- a/ACE/tests/Recursive_Condition_Bug_Test.cpp +++ b/ACE/tests/Recursive_Condition_Bug_Test.cpp @@ -1,26 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Recursive_Condition_Bug_Test.cpp -// -// = DESCRIPTION -// This test program validates the functionality of the -// ACE_Condition<ACE_Recursive_Thread_Mutex> template -// specialization when combined with the -// ACE_Thread_Timer_Queue_Adapter on Win32 and Posix pthreads. -// It was added to test for bugs with the ACE_OS recursive -// condition implementation. -// -// = AUTHOR -// Leonid Kvetnyi <leonidk@nice.com> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Recursive_Condition_Bug_Test.cpp + * + * $Id$ + * + * This test program validates the functionality of the + * ACE_Condition<ACE_Recursive_Thread_Mutex> template + * specialization when combined with the + * ACE_Thread_Timer_Queue_Adapter on Win32 and Posix pthreads. + * It was added to test for bugs with the ACE_OS recursive + * condition implementation. + * + * + * @author Leonid Kvetnyi <leonidk@nice.com> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_sys_time.h" diff --git a/ACE/tests/Recursive_Condition_Test.cpp b/ACE/tests/Recursive_Condition_Test.cpp index 05dc17544be..4e61aadffd7 100644 --- a/ACE/tests/Recursive_Condition_Test.cpp +++ b/ACE/tests/Recursive_Condition_Test.cpp @@ -1,23 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Recursive_Condition_Test.cpp -// -// = DESCRIPTION -// This test program validates the functionality of the -// ACE_Condition<ACE_Recursive_Thread_Mutex> template -// specialization. -// -// = AUTHOR -// Stephen Howard <stephen.e.howard@lmco.com> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Recursive_Condition_Test.cpp + * + * $Id$ + * + * This test program validates the functionality of the + * ACE_Condition<ACE_Recursive_Thread_Mutex> template + * specialization. + * + * + * @author Stephen Howard <stephen.e.howard@lmco.com> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/Recursive_Mutex_Test.cpp b/ACE/tests/Recursive_Mutex_Test.cpp index 71565fa5bf2..2c5c2ddfdbf 100644 --- a/ACE/tests/Recursive_Mutex_Test.cpp +++ b/ACE/tests/Recursive_Mutex_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Recursive_Mutex_Test.cpp -// -// = DESCRIPTION -// This test program verifies the functionality of the ACE_OS -// implementation of recursive mutexes on Win32 and Posix -// pthreads. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Recursive_Mutex_Test.cpp + * + * $Id$ + * + * This test program verifies the functionality of the ACE_OS + * implementation of recursive mutexes on Win32 and Posix + * pthreads. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Get_Opt.h" diff --git a/ACE/tests/Refcounted_Auto_Ptr_Test.h b/ACE/tests/Refcounted_Auto_Ptr_Test.h index 745b7239c3d..f3fac1bd796 100644 --- a/ACE/tests/Refcounted_Auto_Ptr_Test.h +++ b/ACE/tests/Refcounted_Auto_Ptr_Test.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Refcounted_Auto_Ptr_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Refcounted_Auto_Ptr_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #ifndef ACE_TESTS_REFCOUNTED_AUTO_PTR_TEST_H #define ACE_TESTS_REFCOUNTED_AUTO_PTR_TEST_H diff --git a/ACE/tests/Refcounted_Event_Handler_Test_DevPoll.cpp b/ACE/tests/Refcounted_Event_Handler_Test_DevPoll.cpp index a57f79df719..c88ffd41a43 100644 --- a/ACE/tests/Refcounted_Event_Handler_Test_DevPoll.cpp +++ b/ACE/tests/Refcounted_Event_Handler_Test_DevPoll.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Refcounted_Event_Handler_Test_DevPoll.cpp -// -// = DESCRIPTION -// This is a simple test that checks the order of dispatching of -// ACE Reactors. Order should be: timeout, output, and then input. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Refcounted_Event_Handler_Test_DevPoll.cpp + * + * $Id$ + * + * This is a simple test that checks the order of dispatching of + * ACE Reactors. Order should be: timeout, output, and then input. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Reference_Counted_Event_Handler_Test.cpp b/ACE/tests/Reference_Counted_Event_Handler_Test.cpp index a8d878dc3f4..e0ec5a205cc 100644 --- a/ACE/tests/Reference_Counted_Event_Handler_Test.cpp +++ b/ACE/tests/Reference_Counted_Event_Handler_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reference_Counted_Event_Handler_Test.cpp -// -// = DESCRIPTION -// This test is used to check reference counting of the Event -// Handler when it interacts with the Reactor. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reference_Counted_Event_Handler_Test.cpp + * + * $Id$ + * + * This test is used to check reference counting of the Event + * Handler when it interacts with the Reactor. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/Reverse_Lock_Test.cpp b/ACE/tests/Reverse_Lock_Test.cpp index f46b9159a70..cc0e676640c 100644 --- a/ACE/tests/Reverse_Lock_Test.cpp +++ b/ACE/tests/Reverse_Lock_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Reverse_Lock_Test.cpp -// -// = DESCRIPTION -// This is a simple test to illustrate the functionality of -// ACE_Reverse_Lock. The test acquires and releases mutexes. No -// command line arguments are needed to run the test. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Reverse_Lock_Test.cpp + * + * $Id$ + * + * This is a simple test to illustrate the functionality of + * ACE_Reverse_Lock. The test acquires and releases mutexes. No + * command line arguments are needed to run the test. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Synch_Traits.h" diff --git a/ACE/tests/SOCK_Connector_Test.cpp b/ACE/tests/SOCK_Connector_Test.cpp index b6752b977dd..7a3793fa0c3 100644 --- a/ACE/tests/SOCK_Connector_Test.cpp +++ b/ACE/tests/SOCK_Connector_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Connector_Test.cpp -// -// = DESCRIPTION -// This is a test of ACE_SOCK_Connector, focusing on failure cases more -// than on success cases. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ========================================================================== + +//============================================================================= +/** + * @file SOCK_Connector_Test.cpp + * + * $Id$ + * + * This is a test of ACE_SOCK_Connector, focusing on failure cases more + * than on success cases. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/SOCK_Dgram_Bcast_Test.cpp b/ACE/tests/SOCK_Dgram_Bcast_Test.cpp index 19c3eaac8ab..30f64e3e8ed 100644 --- a/ACE/tests/SOCK_Dgram_Bcast_Test.cpp +++ b/ACE/tests/SOCK_Dgram_Bcast_Test.cpp @@ -1,26 +1,23 @@ -// $Id$ -// =========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Dgram_Bcast_Test.cpp -// -// = DESCRIPTION -// This simple broadcast test is intended to check if ACE is capable -// of sending and receiving broadcasts. In single host environment most -// errors related to invalid broadcast initialization will not manifest -// themself, because usually broadcast on localhost interface works -// correctly. For this reason one should run also this test on two distinct -// hosts in single LAN. -// Tests that a call to open with an any address binds to the any address -// for the protocol passed in. -// -// = AUTHOR -// Marek Brudka (mbrudka@elka.pw.edu.pl) -// -// ========================================================================== +//============================================================================= +/** + * @file SOCK_Dgram_Bcast_Test.cpp + * + * $Id$ + * + * This simple broadcast test is intended to check if ACE is capable + * of sending and receiving broadcasts. In single host environment most + * errors related to invalid broadcast initialization will not manifest + * themself, because usually broadcast on localhost interface works + * correctly. For this reason one should run also this test on two distinct + * hosts in single LAN. + * Tests that a call to open with an any address binds to the any address + * for the protocol passed in. + * + * + * @author Marek Brudka (mbrudka@elka.pw.edu.pl) + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/SOCK_Dgram_Test.cpp b/ACE/tests/SOCK_Dgram_Test.cpp index 1447eb5283c..7b4399484c9 100644 --- a/ACE/tests/SOCK_Dgram_Test.cpp +++ b/ACE/tests/SOCK_Dgram_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ -// =========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Dgram.cpp -// -// = DESCRIPTION -// Tests that a call to open with an any address binds to the any address -// for the protocol passed in. -// -// This test uses the same test setup as SOCK_Test. -// -// = AUTHOR -// Brian Buesker (bbuesker@qualcomm.com) -// -// ========================================================================== +//============================================================================= +/** + * @file SOCK_Dgram_Test.cpp + * + * $Id$ + * + * Tests that a call to open with an any address binds to the any address + * for the protocol passed in. + * + * This test uses the same test setup as SOCK_Test. + * + * + * @author Brian Buesker (bbuesker@qualcomm.com) + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/SOCK_Netlink_Test.cpp b/ACE/tests/SOCK_Netlink_Test.cpp index 67283ab407e..90f3e2073e6 100644 --- a/ACE/tests/SOCK_Netlink_Test.cpp +++ b/ACE/tests/SOCK_Netlink_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ -// ====================================================================// -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Netlink_Test.cpp -// -// = DESCRIPTION -// Tests adding of a secondary IP-address, using linux netlink -// sockets. -// -// = AUTHOR -// -// Robert Iakobashvili, coroberti@gmail.com -// -// ====================================================================// +//============================================================================= +/** + * @file SOCK_Netlink_Test.cpp + * + * $Id$ + * + * Tests adding of a secondary IP-address, using linux netlink + * sockets. + * + * + * @author Robert Iakobashvili + * @author coroberti@gmail.com + */ +//============================================================================= + #include "test_config.h" @@ -214,10 +211,10 @@ public: //FUZZ: disable check_for_lack_ACE_OS // Initialization. Schedules a timer to run start the business. // + ///FUZZ: enable check_for_lack_ACE_OS int open (ACE_Reactor *const reactor, char* const ip_slash_mask, const char *const if_name); - //FUZZ: enable check_for_lack_ACE_OS // Returns reference to netlink socket. Necessary for reactor. virtual ACE_HANDLE get_handle (void) const; @@ -272,8 +269,8 @@ protected: // other cleanup jobs virtual int close (); + ///FUZZ: enable check_for_lack_ACE_OS ACE_SOCK_Netlink& socket (); - //FUZZ: enable check_for_lack_ACE_OS private: diff --git a/ACE/tests/SOCK_SEQPACK_SCTP_Test.cpp b/ACE/tests/SOCK_SEQPACK_SCTP_Test.cpp index 895d2d374d5..953bb654b08 100644 --- a/ACE/tests/SOCK_SEQPACK_SCTP_Test.cpp +++ b/ACE/tests/SOCK_SEQPACK_SCTP_Test.cpp @@ -1,369 +1,13 @@ -// $Id$ -// -// *WARRANTY DISCLAIMER: LIMITATION OF LIABILITY. THE SOFTWARE AND -// CONTENT ARE PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED -// REPRESENTATIONS, GUARANTEES, OR WARRANTIES, INCLUDING BUT NOT LIMITED -// TO SUCH REPRESENTATION, GUARANTEES OR WARRANTIES REGARDING THE -// USABILITY, SUITABILITY, CONDITION, OPERATION OR ACCURACY THEREOF. * -// -// *ALL OTHER WARRANTIES AND CONDITIONS (EXPRESS, IMPLIED OR STATUTORY) -// ARE HEREBY DISCLAIMED, SUCH WARRANTIES AND CONDITIONS INCLUDING -// WITHOUT LIMITATION, ALL WARRANTIES AND CONDITIONS OF MERCHANTABILITY, -// TITLE, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, -// COMPATIBILITY, AND SECURITY OR ACCURACY.* -// -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_SEQPACK_SCTP_Test.cpp -// -// = DESCRIPTION -// Performs several tests on the ACE_SOCK_SEQPACK_Connector, -// ACE_SOCK_SEQPACK_Acceptor, and ACE_SOCK_SEQPACK_Association classes -// specifically for SCTP using the loopback interface. Attempts to -// replicate behavior of SOCK_Test.cpp, but integrating IPv6 tests -// directly. -// -// = AUTHOR -// Dave Craig <dwc@qualcomm.com> -// - -#include "test_config.h" -#include "ace/OS_NS_unistd.h" -#include "ace/OS_NS_sys_select.h" -#include "ace/OS_NS_sys_wait.h" -#include "ace/SOCK_SEQPACK_Connector.h" -#include "ace/SOCK_SEQPACK_Acceptor.h" -#include "ace/Thread_Manager.h" -#include "ace/Handle_Set.h" - -#define TTCPPORT 5001 -#define BYTE_MESG 0xcd - -struct tdesc { - ACE_Thread_Semaphore *tsemap; - bool ipv6_test; -}; - -typedef struct tdesc tdesc_t; - -#ifdef ACE_WIN64 -// This arg is ignored on Windows and causes pointer truncation -// warnings on 64-bit compiled. -#define SELECT_WIDTH(x) 0 -#else -#define SELECT_WIDTH(x) (x) -#endif - -ACE_THR_FUNC_RETURN -Server (void *arg) -{ - ACE_SOCK_SEQPACK_Acceptor *AcceptorSocket = - reinterpret_cast<ACE_SOCK_SEQPACK_Acceptor *> (arg); - - ACE_SOCK_SEQPACK_Association Stream; - - ACE_Handle_Set handle_set; - - const ACE_Time_Value def_timeout (ACE_DEFAULT_TIMEOUT); - - ACE_Time_Value tv (def_timeout); - - int select_width; - - int result; - - // - // Make sure AcceptorSocket is in nonblocking mode so as not to - // hang tests. - // - if (-1 == AcceptorSocket->enable (ACE_NONBLOCK)) - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("AcceptorSocket.enable (ACE_NONBLOCK)"))); - - // - // Set up select to wait for I/O events. - // - handle_set.reset (); - handle_set.set_bit (AcceptorSocket->get_handle ()); - - select_width = SELECT_WIDTH(int (AcceptorSocket->get_handle ()) + 1); - - result = ACE_OS::select(select_width, - handle_set, - 0, - 0, - &tv); - - if (-1 == result) - ACE_ERROR_RETURN ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("select")), - 0); - if (0 == result) - ACE_ERROR_RETURN ((LM_ERROR, - ACE_TEXT("(%P|%t) select timed out, shutting down\n")), - 0); - - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT ("(%P|%t) waiting for client to connect\n"))); - - while (-1 != AcceptorSocket->accept (Stream)) { - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT ("(%P|%t) client connected\n"))); - - // - // Enable non-blocking I/O. - // - if (Stream.enable (ACE_NONBLOCK)) - ACE_ERROR_RETURN ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("Stream.enable (ACE_NONBLOCK)")), - 0); - - unsigned char byte = BYTE_MESG; - - if (-1 == Stream.send_n (&byte, 1)) - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("Stream.send_n"))); - - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT ("(%P|%t) byte sent\n"))); - - // - // Abruptly terminate the association. - // - if (-1 == Stream.abort ()) - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("Association.abort"))); - - // - // Negative test: make sure that we cannot send on a closed association. - // - if (-1 != Stream.send_n (&byte, 1)) - //FUZZ: disable check_for_lack_ACE_OS - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) Negative test fail: Association") - ACE_TEXT(".send_n succeeded after abort()\n"))); - //FUZZ: enable check_for_lack_ACE_OS - - } - - // - // Close server socket. - // - if (-1 == AcceptorSocket->close ()) - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("AcceptorSocket.close"))); - - return 0; -} - -ACE_THR_FUNC_RETURN -Client(void *arg) -{ - ACE_Multihomed_INET_Addr *ServerAddr = - reinterpret_cast<ACE_Multihomed_INET_Addr *> (arg); - - ACE_SOCK_SEQPACK_Connector Connector; - - ACE_SOCK_SEQPACK_Association Stream; - - ACE_Time_Value tv (ACE_DEFAULT_TIMEOUT); - - char b; - size_t bytes; - - if (-1 == Connector.connect (Stream, - *ServerAddr, - &tv, - ACE_Addr::sap_any, - 1)) - { - ACE_ERROR_RETURN ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p to %s:%d\n"), - ACE_TEXT ("Connector.connect"), - ServerAddr->get_host_name (), - ServerAddr->get_port_number ()), - 0); - } - - if (-1 == Stream.disable (ACE_NONBLOCK)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("Association.disable (ACE_NONBLOCK)"))); - } - - - if (-1 == Stream.recv_n (&b, 1, &tv, &bytes)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("Association.recv_n"))); - } - - if (1 == bytes) - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT ("(%P|%t) Client received %B bytes\n"), - bytes)); - else - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) Client received %B bytes; expected 1\n"), - bytes)); - - // - // Give server a little time to abort the association. - // - ACE_OS::sleep(1); - - // abort closes the connection, so the recv should either see a closed - // socket or some failure other than a timeout. - ssize_t cnt = Stream.recv_n (&b, 1, &tv, &bytes); - if (cnt > 0 || (cnt == -1 && errno == ETIME)) - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) Negative test failed; Association") - ACE_TEXT (".recv_n returned %b (w/ %m) after abort\n"), - cnt)); - - return 0; -} - -// -// Spawn server and client threads and then wait until they complete the -// test. There must be a timeout on the wait, so executable does not hang the -// tests indefinitely. -// -int -spawn_test(bool ipv6_test) -{ - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT ("(%P|%t) spawn_test started ipv6 %d\n"), - ipv6_test)); - - ACE_SOCK_SEQPACK_Acceptor AcceptorSocket; - - const ACE_TCHAR *addrstr = -#ifdef ACE_HAS_IPV6 - ipv6_test ? ACE_IPV6_LOCALHOST : ACE_LOCALHOST; -#else - ACE_LOCALHOST; -#endif /* ACE_HAS_IPV6 */ - ACE_Multihomed_INET_Addr ServerAddr (TTCPPORT, - addrstr -#ifdef ACE_HAS_IPV6 - ,1, - ipv6_test ? AF_INET6 : AF_INET -#endif /* ACE_HAS_IPV6 */ - ); - - if (-1 == AcceptorSocket.open (ServerAddr, 1)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("AcceptorSocket.open"))); - } - - if (-1 == AcceptorSocket.get_local_addr (ServerAddr)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p\n"), - ACE_TEXT ("AcceptorSocket.get_local_addr"))); - } - -#ifndef ACE_LACKS_FORK - switch (ACE_OS::fork (ACE_TEXT ("child"))) - { - case -1: - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p"), - ACE_TEXT ("fork failed"))); - break; - case 0: - ACE_LOG_MSG->sync (ACE_TEXT ("SOCK_SEQPACK_SCTP_Test")); - Client (&ServerAddr); - ACE_OS::exit (0); - break; - default: - Server (reinterpret_cast<void *> (&AcceptorSocket)); - ACE_OS::wait (); - break; - } -#elif defined (ACE_HAS_THREADS) - if (-1 == ACE_Thread_Manager::instance ()->spawn - (Server, - reinterpret_cast<void *> (&AcceptorSocket), - THR_NEW_LWP | THR_DETACHED)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p%a"), - ACE_TEXT ("thread create failed"))); - } - - if (-1 == ACE_Thread_Manager::instance ()->spawn - (Client, - reinterpret_cast<void *> (&ServerAddr), - THR_NEW_LWP | THR_DETACHED)) - { - ACE_ERROR ((LM_ERROR, - ACE_TEXT ("(%P|%t) %p%a"), - ACE_TEXT ("thread create failed"))); - } - - ACE_Thread_Manager::instance ()->wait (); -#else /* ACE_LACKS_FORK && ! ACE_HAS_THREADS */ - ACE_ERROR ((LM_DEBUG, - ACE_TEXT ("(%P|%t)\n"), - ACE_TEXT ("only one thread may be run ") - ACE_TEXT ("in a process on this platform\n"))); -#endif /* ACE_LACKS_FORK && ! ACE_HAS_THREADS */ - - return 0; -} - -int -do_test(void) -{ - spawn_test(false); - -#ifdef ACE_HAS_IPV6 - spawn_test(true); -#endif - - return 0; -} - -int run_main (int argc, ACE_TCHAR *argv[]) -{ - ACE_UNUSED_ARG (argc); - ACE_UNUSED_ARG (argv); - - ACE_START_TEST (ACE_TEXT ("SOCK_SEQPACK_SCTP_Test")); - - // - // Check whether host OS has SCTP support before starting this test. - // If not, just pass because there is not a hope of testing - // SOCK_SEQPACK. - // - int status = 0; - -#ifdef ACE_HAS_SCTP - status = do_test(); -#else /* ! ACE_HAS_SCTP */ - ACE_DEBUG ((LM_DEBUG, - ACE_TEXT("SCTP not supported by ACE.\n") - ACE_TEXT("This test will not do anything.\n"))); -#endif /* ! ACE_HAS_SCTP */ - - ACE_END_TEST; - - return status; -} - +//============================================================================= +/** + * @file SOCK_SEQPACK_SCTP_Test.cpp + * + * $Id$ + * + * Performs several tests on the ACE_SOCK_SEQPACK_Connector, + * ACE_SOCK_SEQPACK_Acceptor, and ACE_SOCK_SEQPACK_Association classes + * specifically for SCTP using the loopback interface. Attempts to + * replicate behavior of SOCK_Test.cpp, but integrating IPv6 tests + * directly. + * + * diff --git a/ACE/tests/SOCK_Send_Recv_Test.cpp b/ACE/tests/SOCK_Send_Recv_Test.cpp index 9a14c9a4c1e..b3dc1145f60 100644 --- a/ACE/tests/SOCK_Send_Recv_Test.cpp +++ b/ACE/tests/SOCK_Send_Recv_Test.cpp @@ -1,28 +1,25 @@ -// $Id$ - -// =========================================================================== -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Send_Recv_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_SOCK>'s various send and receive -// methods. The test forks two processes or spawns two threads -// (depending upon the platform) and then executes client and -// server allowing them to connect and exchange data in ways -// designed to exercise the send and recv functions. -// -// Right now, it primarily tests the iov-like send and recv -// functions, but others should be added to completely cover the -// possible scenarios. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file SOCK_Send_Recv_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_SOCK>'s various send and receive + * methods. The test forks two processes or spawns two threads + * (depending upon the platform) and then executes client and + * server allowing them to connect and exchange data in ways + * designed to exercise the send and recv functions. + * + * Right now, it primarily tests the iov-like send and recv + * functions, but others should be added to completely cover the + * possible scenarios. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_sys_wait.h" diff --git a/ACE/tests/SOCK_Test.cpp b/ACE/tests/SOCK_Test.cpp index 730f0afffec..4345aa7113c 100644 --- a/ACE/tests/SOCK_Test.cpp +++ b/ACE/tests/SOCK_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// SOCK_Test.cpp -// -// = DESCRIPTION -// This is a test of the <ACE_SOCK_Acceptor> and -// <ACE_SOCK_Connector> classes. The test forks two processes or -// spawns two threads (depending upon the platform) and then -// executes client and server allowing them to connect and -// exchange data. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file SOCK_Test.cpp + * + * $Id$ + * + * This is a test of the <ACE_SOCK_Acceptor> and + * <ACE_SOCK_Connector> classes. The test forks two processes or + * spawns two threads (depending upon the platform) and then + * executes client and server allowing them to connect and + * exchange data. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/SPIPE_Test.cpp b/ACE/tests/SPIPE_Test.cpp index eb5b2d37df4..7e1e591435b 100644 --- a/ACE/tests/SPIPE_Test.cpp +++ b/ACE/tests/SPIPE_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// SPIPE_Test.cpp -// -// = DESCRIPTION -// This is a simple test of Named Pipes that uses -// ACE_SPIPE_Acceptor and ACE_SPIPE_Connector classes. The test -// forks two processes or spawns two threads (depending upon the -// platform) and then executes the client and server allowing -// them to use the named pipe to exchange data. No user input is -// required as far as command line arguments are concerned. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file SPIPE_Test.cpp + * + * $Id$ + * + * This is a simple test of Named Pipes that uses + * ACE_SPIPE_Acceptor and ACE_SPIPE_Connector classes. The test + * forks two processes or spawns two threads (depending upon the + * platform) and then executes the client and server allowing + * them to use the named pipe to exchange data. No user input is + * required as far as command line arguments are concerned. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread.h" diff --git a/ACE/tests/SSL/Main.cpp b/ACE/tests/SSL/Main.cpp index 44b92128394..241e8b54bec 100644 --- a/ACE/tests/SSL/Main.cpp +++ b/ACE/tests/SSL/Main.cpp @@ -1,21 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Main.cpp -// -// = DESCRIPTION -// This is a wrapper for the test programs. It obviates the test cpp's -// from having to always include OS.h. -// -// = AUTHOR -// Don Hinton <dhinton@dresystems.com> -// -// ============================================================================ +//============================================================================= +/** + * @file Main.cpp + * + * $Id$ + * + * This is a wrapper for the test programs. It obviates the test cpp's + * from having to always include OS.h. + * + * + * @author Don Hinton <dhinton@dresystems.com> + */ +//============================================================================= + #include "ace/OS_main.h" #if defined (ACE_HAS_WINCE) diff --git a/ACE/tests/SSL/SSL_Asynch_Stream_Test.cpp b/ACE/tests/SSL/SSL_Asynch_Stream_Test.cpp index ebae71d365b..31130e590d4 100644 --- a/ACE/tests/SSL/SSL_Asynch_Stream_Test.cpp +++ b/ACE/tests/SSL/SSL_Asynch_Stream_Test.cpp @@ -1,33 +1,30 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests/SSL -// -// = FILENAME -// SSL_Asynch_Stream_Test.cpp -// -// = DESCRIPTION -// This program is a functionality test of ACE_SSL_Asynch_Stream. -// It demonstrates one proper use case of ACE_SSL_Asynch_Stream in the -// Proactor framework and validates its basic functionality. -// -// Usage: SSL_Asynch_Stream_Test [-r <hostname:port#>] -// [-t <num threads>] [-d <delay>] -// [-i <client conn attempt#>] [-n <client request# per conn>] -// -// Default value: -// <hostname:port#>: ACE_DEFAULT_SERVER_HOST:ACE_DEFAULT_PORT -// <num threads>: ACE_MAX_THREADS -// <client conn attempt#>: ACE_MAX_ITERATIONS -// <client req# per conn>: 20 -// <delay>: 0 usec -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file SSL_Asynch_Stream_Test.cpp + * + * $Id$ + * + * This program is a functionality test of ACE_SSL_Asynch_Stream. + * It demonstrates one proper use case of ACE_SSL_Asynch_Stream in the + * Proactor framework and validates its basic functionality. + * + * Usage: SSL_Asynch_Stream_Test [-r <hostname:port#>] + * [-t <num threads>] [-d <delay>] + * [-i <client conn attempt#>] [-n <client request# per conn>] + * + * Default value: + * <hostname:port#>: ACE_DEFAULT_SERVER_HOST:ACE_DEFAULT_PORT + * <num threads>: ACE_MAX_THREADS + * <client conn attempt#>: ACE_MAX_ITERATIONS + * <client req# per conn>: 20 + * <delay>: 0 usec + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "../test_config.h" #include "ace/Default_Constants.h" diff --git a/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp b/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp index 94d41c85999..67acc430b42 100644 --- a/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp +++ b/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.cpp @@ -1,44 +1,40 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests/SSL -// -// = FILENAME -// Thread_Pool_Reactor_Test.cpp -// -// = DESCRIPTION -// This program is a torture test of threaded SSL usage. It -// is based on the tests/Thread_Pool_Reactor_Test and adds -// SSL stuff submitted by Robert Handl <robert.handl@ehpt.com>. -// It starts by spawning several server threads waiting to handle -// events. Several other client threads are spawned right after -// to initiate connections to server threads. Each connection -// adds a new Svc_Handler into the TP_Reactor and sends out -// several "requests" to the server thread. After the connection -// is closed, the Svc_Handler is removed from the TP_Reactor. -// Each message is treated as a separate request by the server so -// two consecutive requests might be serviced by two different -// threads. -// -// Usage: Thread_Pool_Reactor_Test_SSL [-r <hostname:port#>] -// [-s <server thr#>] [-c <client thr#>] [-d <delay>] -// [-i <client conn attempt#>] [-n <client request# per conn>] -// -// Default value: -// <hostname:port#>: ACE_DEFAULT_RENDEZVOUS -// <server thr#>: ACE_MAX_THREADS -// <client thr#>: ACE_MAX_ITERATIONS -// <client conn attempt#>: ACE_MAX_ITERATIONS -// <client req# per conn>: ACE_MAX_THREADS -// <delay>: 50 usec -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> and -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_SSL_Test.cpp + * + * $Id$ + * + * This program is a torture test of threaded SSL usage. It + * is based on the tests/Thread_Pool_Reactor_Test and adds + * SSL stuff submitted by Robert Handl <robert.handl@ehpt.com>. + * It starts by spawning several server threads waiting to handle + * events. Several other client threads are spawned right after + * to initiate connections to server threads. Each connection + * adds a new Svc_Handler into the TP_Reactor and sends out + * several "requests" to the server thread. After the connection + * is closed, the Svc_Handler is removed from the TP_Reactor. + * Each message is treated as a separate request by the server so + * two consecutive requests might be serviced by two different + * threads. + * + * Usage: Thread_Pool_Reactor_Test_SSL [-r <hostname:port#>] + * [-s <server thr#>] [-c <client thr#>] [-d <delay>] + * [-i <client conn attempt#>] [-n <client request# per conn>] + * + * Default value: + * <hostname:port#>: ACE_DEFAULT_RENDEZVOUS + * <server thr#>: ACE_MAX_THREADS + * <client thr#>: ACE_MAX_ITERATIONS + * <client conn attempt#>: ACE_MAX_ITERATIONS + * <client req# per conn>: ACE_MAX_THREADS + * <delay>: 50 usec + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "../test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.h b/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.h index 88d89c89477..521879fb26c 100644 --- a/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.h +++ b/ACE/tests/SSL/Thread_Pool_Reactor_SSL_Test.h @@ -1,23 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests/SSL -// -// = FILENAME -// Thread_Pool_Reactor_Test_SSL.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Thread_Pool_Reactor_Test_SSL.cpp. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_SSL_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Thread_Pool_Reactor_Test_SSL.cpp. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_THREAD_POOL_REACTOR_TEST_SSL_H #define ACE_TESTS_THREAD_POOL_REACTOR_TEST_SSL_H @@ -36,8 +32,8 @@ class Request_Handler : public ACE_Svc_Handler<ACE_SSL_SOCK_Stream, // = TITLE // This class is the Svc_Handler used by <Acceptor>. public: + /// The default constructor makes sure the right reactor is used. Request_Handler (ACE_Thread_Manager *tm = 0); - // The default constructor makes sure the right reactor is used. protected: virtual int handle_input (ACE_HANDLE fd = ACE_INVALID_HANDLE); diff --git a/ACE/tests/SString_Test.cpp b/ACE/tests/SString_Test.cpp index 1309e1cefa6..ac48df4d12b 100644 --- a/ACE/tests/SString_Test.cpp +++ b/ACE/tests/SString_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// SString_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the use of ACE_CString -// and ACE_WString. No command line arguments are needed to run -// the test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file SString_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the use of ACE_CString + * and ACE_WString. No command line arguments are needed to run + * the test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/SV_Shared_Memory_Test.cpp b/ACE/tests/SV_Shared_Memory_Test.cpp index 022a1a06ddb..bc505d1f57e 100644 --- a/ACE/tests/SV_Shared_Memory_Test.cpp +++ b/ACE/tests/SV_Shared_Memory_Test.cpp @@ -1,26 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// SV_Shared_Memory_Test.cpp -// -// = DESCRIPTION -// This is a simple test of <ACE_SV_Shared_Memory> and -// <ACE_Malloc> using the <ACE_Shared_Memory_Pool>. The test -// forks two processes and then executes client and server -// allowing them to exchange data using shared memory. No user -// input is required as far as command line arguments are -// concerned. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file SV_Shared_Memory_Test.cpp + * + * $Id$ + * + * This is a simple test of <ACE_SV_Shared_Memory> and + * <ACE_Malloc> using the <ACE_Shared_Memory_Pool>. The test + * forks two processes and then executes client and server + * allowing them to exchange data using shared memory. No user + * input is required as far as command line arguments are + * concerned. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Malloc_T.h" diff --git a/ACE/tests/Semaphore_Test.cpp b/ACE/tests/Semaphore_Test.cpp index 0b07213b0e4..08376b42734 100644 --- a/ACE/tests/Semaphore_Test.cpp +++ b/ACE/tests/Semaphore_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Semaphore Test -// -// = DESCRIPTION -// This test verifies the functionality of the <ACE_Thread_Semaphore> -// implementation. -// -// = AUTHOR -// Darrell Brunsch <brunsch@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Semaphore_Test.cpp + * + * $Id$ + * + * This test verifies the functionality of the <ACE_Thread_Semaphore> + * implementation. + * + * + * @author Darrell Brunsch <brunsch@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread_Semaphore.h" diff --git a/ACE/tests/Sig_Handlers_Test.cpp b/ACE/tests/Sig_Handlers_Test.cpp index 7fbab077ce7..ed6224f2e98 100644 --- a/ACE/tests/Sig_Handlers_Test.cpp +++ b/ACE/tests/Sig_Handlers_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Sig_Handlers_Test.cpp -// -// = DESCRIPTION -// This is a simple program that tests whether the ACE_Sig_Handlers -// class works properly. To run this test, start the application -// and then type ^C. If everything is working properly the test -// will shutdown gracefully. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@dre.vanderbilt.edu> and Andreas Drescher <ace at anticat dot ch> -// -// ============================================================================ + +//============================================================================= +/** + * @file Sig_Handlers_Test.cpp + * + * $Id$ + * + * This is a simple program that tests whether the ACE_Sig_Handlers + * class works properly. To run this test, start the application + * and then type ^C. If everything is working properly the test + * will shutdown gracefully. + * + * + * @author Douglas C. Schmidt <schmidt@dre.vanderbilt.edu> and Andreas Drescher <ace at anticat dot ch> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/Signal_Test.cpp b/ACE/tests/Signal_Test.cpp index 89f983e1b82..175aa9b004b 100644 --- a/ACE/tests/Signal_Test.cpp +++ b/ACE/tests/Signal_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Signal_Test.cpp -// -// = DESCRIPTION -// This program tests the signal handling capabilities of ACE on -// various OS platforms that support sending signals between -// processes. -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Signal_Test.cpp + * + * $Id$ + * + * This program tests the signal handling capabilities of ACE on + * various OS platforms that support sending signals between + * processes. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread_Manager.h" diff --git a/ACE/tests/Sigset_Ops_Test.cpp b/ACE/tests/Sigset_Ops_Test.cpp index 397e5911042..83b9f4b244d 100644 --- a/ACE/tests/Sigset_Ops_Test.cpp +++ b/ACE/tests/Sigset_Ops_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Sigset_Ops_Test.cpp -// -// = DESCRIPTION -// This program tests the correctness of following functions. -// sigfillset(), sigemptyset(), sigaddset(), sigdelset(), -// sigismember(). -// -// = AUTHOR -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Sigset_Ops_Test.cpp + * + * $Id$ + * + * This program tests the correctness of following functions. + * sigfillset(), sigemptyset(), sigaddset(), sigdelset(), + * sigismember(). + * + * + * @author Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_signal.h" diff --git a/ACE/tests/Simple_Message_Block_Test.cpp b/ACE/tests/Simple_Message_Block_Test.cpp index 3b8d6a89ce1..7c917410e38 100644 --- a/ACE/tests/Simple_Message_Block_Test.cpp +++ b/ACE/tests/Simple_Message_Block_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Simple_Message_Block_Test.cpp -// -// = DESCRIPTION -// This test program is a torture test that illustrates how -// ACE_Message_Block reference counting works, how and when locks -// are used, how memory is managed, and how continuation chains -// of message blocks are made. Ideally used with purify :-) -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Simple_Message_Block_Test.cpp + * + * $Id$ + * + * This test program is a torture test that illustrates how + * ACE_Message_Block reference counting works, how and when locks + * are used, how memory is managed, and how continuation chains + * of message blocks are made. Ideally used with purify :-) + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Message_Block.h" diff --git a/ACE/tests/Singleton_Test.cpp b/ACE/tests/Singleton_Test.cpp index f889377bcc8..49265ac06ee 100644 --- a/ACE/tests/Singleton_Test.cpp +++ b/ACE/tests/Singleton_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Singleton_Test.cpp -// -// = DESCRIPTION -// This is a simple test of ACE Singleton -// -// = AUTHOR -// Johnny Willemsen <jwillemsen@remedy.nl> -// -// ============================================================================ + +//============================================================================= +/** + * @file Singleton_Test.cpp + * + * $Id$ + * + * This is a simple test of ACE Singleton + * + * + * @author Johnny Willemsen <jwillemsen@remedy.nl> + */ +//============================================================================= + #include "test_config.h" #include "ace/Singleton.h" diff --git a/ACE/tests/Svc_Handler_Test.cpp b/ACE/tests/Svc_Handler_Test.cpp index c88b70f608b..7c7358c3e45 100644 --- a/ACE/tests/Svc_Handler_Test.cpp +++ b/ACE/tests/Svc_Handler_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Svc_Handler_Test.cpp -// -// = DESCRIPTION -// This tests illustrates the "buffering" strategy of the -// <ACE_Buffered_Svc_Handler>. This test also illustrates how the -// <ACE_FILE_IO> classes work. -// -// = AUTHORS -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Svc_Handler_Test.cpp + * + * $Id$ + * + * This tests illustrates the "buffering" strategy of the + * <ACE_Buffered_Svc_Handler>. This test also illustrates how the + * <ACE_FILE_IO> classes work. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/TP_Reactor_Test.cpp b/ACE/tests/TP_Reactor_Test.cpp index 63af910e8e3..1dcb7f5612e 100644 --- a/ACE/tests/TP_Reactor_Test.cpp +++ b/ACE/tests/TP_Reactor_Test.cpp @@ -1,52 +1,50 @@ -// $Id$ - -//============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// TPReactor_test.cpp -// -// = DESCRIPTION -// This program illustrates how the <ACE_TP_Reactor> can be used to -// implement an application that does various operations. -// usage: TP_Reactor_Test -// -n number threads in the TP_Reactor thread pool -// -d duplex mode 1 (full-duplex) vs. 0 (half-duplex) -// -p port to listen(Server)/connect(Client) -// -h host to connect (Client mode) -// -s number of sender's instances ( Client mode) -// -b run client and server (both modes ) at the same time -// -v log level -// 0 - log all messages -// 1 - log only errors and unusual cases -// -i time to run in seconds -// -u show this message -// -// The main differences between Thread_Pool_Reactor_Test.cpp and -// this test are: -// -// 1. Thread_Pool_Reactor_Test.cpp tests only handle_input() -// events on the server, whereas this one tests both handle_input() and -// handle_output() on both server and client, i.e., the receiver -// and sender are completely event-driven. -// -// 2. The receiver and sender in this test can work in full duplex -// mode, i.e., input and ouput events are processed independently. -// Half-duplex mode (request-reply) is also supported. -// -// This test is therefore a bit more stressful than the -// Thread_Pool_Reactor.cpp for the ACE_TP_Reactor since same -// thread pool is shared between client and server. -// -// This test is a "twin" of the Proactor_Test.cpp, so it can help for -// developers to provide independent of Reactor/Proactor solutions. -// -// = AUTHOR -// Alexander Libman <alibman@ihug.com.au>,<alexl@rumblgroup.com> -// -//============================================================================ + +//============================================================================= +/** + * @file TP_Reactor_Test.cpp + * + * $Id$ + * + * This program illustrates how the <ACE_TP_Reactor> can be used to + * implement an application that does various operations. + * usage: TP_Reactor_Test + * -n number threads in the TP_Reactor thread pool + * -d duplex mode 1 (full-duplex) vs. 0 (half-duplex) + * -p port to listen(Server)/connect(Client) + * -h host to connect (Client mode) + * -s number of sender's instances ( Client mode) + * -b run client and server (both modes ) at the same time + * -v log level + * 0 - log all messages + * 1 - log only errors and unusual cases + * -i time to run in seconds + * -u show this message + * + * The main differences between Thread_Pool_Reactor_Test.cpp and + * this test are: + * + * 1. Thread_Pool_Reactor_Test.cpp tests only handle_input() + * events on the server, whereas this one tests both handle_input() and + * handle_output() on both server and client, i.e., the receiver + * and sender are completely event-driven. + * + * 2. The receiver and sender in this test can work in full duplex + * mode, i.e., input and ouput events are processed independently. + * Half-duplex mode (request-reply) is also supported. + * + * This test is therefore a bit more stressful than the + * Thread_Pool_Reactor.cpp for the ACE_TP_Reactor since same + * thread pool is shared between client and server. + * + * This test is a "twin" of the Proactor_Test.cpp, so it can help for + * developers to provide independent of Reactor/Proactor solutions. + * + * + * @author Alexander Libman <alibman@ihug.com.au> + * @author <alexl@rumblgroup.com> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/TP_Reactor_Test.h b/ACE/tests/TP_Reactor_Test.h index 1955608b034..99eebc087b7 100644 --- a/ACE/tests/TP_Reactor_Test.h +++ b/ACE/tests/TP_Reactor_Test.h @@ -1,21 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// TP_Reactor_Test.h -// -// = DESCRIPTION -// Define class needed for generating templates. IBM C++ requires this to -// be in its own file for auto template instantiation. -// -// = AUTHOR -// Alexander Libman <alibman@ihug.com.au>,<alexl@rumblgroup.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file TP_Reactor_Test.h + * + * $Id$ + * + * Define class needed for generating templates. IBM C++ requires this to + * be in its own file for auto template instantiation. + * + * + * @author Alexander Libman <alibman@ihug.com.au> + * @author <alexl@rumblgroup.com> + */ +//============================================================================= + #ifndef ACE_TESTS_TP_REACTOR_TEST_H #define ACE_TESTS_TP_REACTOR_TEST_H diff --git a/ACE/tests/TSS_Static_Test.cpp b/ACE/tests/TSS_Static_Test.cpp index 1f22b486f13..fb6dd369bf2 100644 --- a/ACE/tests/TSS_Static_Test.cpp +++ b/ACE/tests/TSS_Static_Test.cpp @@ -1,21 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = FILENAME -// TSS_Static_Test.cpp -// -// = DESCRIPTION -// This program tests the interaction between TSS and thread keys -// created during static construction. VxWorks static construction -// is quite broken. This test is designed to test changes to work -// around a bug in the VxWorks loader that constructs static objects -// multiple times. It sounds hard to believe, but I've seen it! -// -// = AUTHOR -// Chad Elliott <elliott_c@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file TSS_Static_Test.cpp + * + * $Id$ + * + * This program tests the interaction between TSS and thread keys + * created during static construction. VxWorks static construction + * is quite broken. This test is designed to test changes to work + * around a bug in the VxWorks loader that constructs static objects + * multiple times. It sounds hard to believe, but I've seen it! + * + * + * @author Chad Elliott <elliott_c@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/ACE.h" diff --git a/ACE/tests/TSS_Test.cpp b/ACE/tests/TSS_Test.cpp index 1426d799101..850720f38a2 100644 --- a/ACE/tests/TSS_Test.cpp +++ b/ACE/tests/TSS_Test.cpp @@ -1,24 +1,21 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// TSS_Test.cpp -// -// = DESCRIPTION -// This program tests thread specific storage of data. The ACE_TSS -// wrapper transparently ensures that the objects of this class -// will be placed in thread-specific storage. All calls on -// ACE_TSS::operator->() are delegated to the appropriate method -// in the Errno class. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file TSS_Test.cpp + * + * $Id$ + * + * This program tests thread specific storage of data. The ACE_TSS + * wrapper transparently ensures that the objects of this class + * will be placed in thread-specific storage. All calls on + * ACE_TSS::operator->() are delegated to the appropriate method + * in the Errno class. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Doug Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/TSS_Test_Errno.h b/ACE/tests/TSS_Test_Errno.h index 7d822a7099b..38deffc3fe3 100644 --- a/ACE/tests/TSS_Test_Errno.h +++ b/ACE/tests/TSS_Test_Errno.h @@ -1,33 +1,35 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = FILENAME -// TSS_Test_Errno.h -// -// = DESCRIPTION -// This file contains the definition of Errno. Some compilers need -// it in a .h file for template instantiation (such as AIX C Set -// ++). -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file TSS_Test_Errno.h + * + * $Id$ + * + * This file contains the definition of Errno. Some compilers need + * it in a .h file for template instantiation (such as AIX C Set + * ++). + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "ace/Guard_T.h" #include "ace/Thread_Mutex.h" +/** + * @class Errno + * + * @brief Define a simple Errno abstraction + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by TSS_Test.cpp. + */ class Errno { - // = TITLE - // Define a simple Errno abstraction - // - // = DESCRIPTION - // This class gets its own header file to work around AIX C++ - // compiler "features" related to template instantiation... It is - // only used by TSS_Test.cpp. public: Errno() { diff --git a/ACE/tests/Task_Ex_Test.cpp b/ACE/tests/Task_Ex_Test.cpp index 332cf4b4118..2ddfb6634dc 100644 --- a/ACE/tests/Task_Ex_Test.cpp +++ b/ACE/tests/Task_Ex_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Task_Ex_Test.cpp -// -// = DESCRIPTION -// This test program illustrates the ACE_Task_Ex class which has the ACE_Message_Queue_Ex -// that has the capability to hold user-defined messages instead of ACE_Message_Block -// -// -// = AUTHOR -// Kobi Cohen-Arazi <kobi-co@barak-online.net> -// -// ============================================================================ + +//============================================================================= +/** + * @file Task_Ex_Test.cpp + * + * $Id$ + * + * This test program illustrates the ACE_Task_Ex class which has the ACE_Message_Queue_Ex + * that has the capability to hold user-defined messages instead of ACE_Message_Block + * + * + * + * @author Kobi Cohen-Arazi <kobi-co@barak-online.net> + */ +//============================================================================= + #include "test_config.h" #include "Task_Ex_Test.h" @@ -46,8 +43,8 @@ class Consumer : public ACE_Task_Ex<ACE_MT_SYNCH, User_Defined_Msg> public: //FUZZ: disable check_for_lack_ACE_OS /// activate/spawn the threads. + ///FUZZ: enable check_for_lack_ACE_OS int open (void*); - //FUZZ: enable check_for_lack_ACE_OS /// svc thread entry point virtual int svc (void); diff --git a/ACE/tests/Task_Test.cpp b/ACE/tests/Task_Test.cpp index cee1ee89545..2c64fe4624e 100644 --- a/ACE/tests/Task_Test.cpp +++ b/ACE/tests/Task_Test.cpp @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Task_Test.cpp -// -// = DESCRIPTION -// This test program illustrates how the ACE barrier -// synchronization mechanisms work in conjunction with the -// <ACE_Task> and the <ACE_Thread_Manager>. This also illustrates -// how the <ACE_Thread_Hook> mechanism works. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Task_Test.cpp + * + * $Id$ + * + * This test program illustrates how the ACE barrier + * synchronization mechanisms work in conjunction with the + * <ACE_Task> and the <ACE_Thread_Manager>. This also illustrates + * how the <ACE_Thread_Hook> mechanism works. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -49,20 +45,20 @@ public: int n_iterations); //FUZZ: disable check_for_lack_ACE_OS + ///FUZZ: enable check_for_lack_ACE_OS virtual int close (u_long flags = 0); - //FUZZ: enable check_for_lack_ACE_OS + /// Iterate <n_iterations> time printing off a message and "waiting" + /// for all other threads to complete this iteration. virtual int svc (void); - // Iterate <n_iterations> time printing off a message and "waiting" - // for all other threads to complete this iteration. private: + /// Reference to the tester barrier. This controls each iteration of + /// the tester function running in every thread. ACE_Barrier barrier_; - // Reference to the tester barrier. This controls each iteration of - // the tester function running in every thread. + /// Number of iterations to run. int n_iterations_; - // Number of iterations to run. }; ACE_THR_FUNC_RETURN diff --git a/ACE/tests/Thread_Attrs_Test.cpp b/ACE/tests/Thread_Attrs_Test.cpp index e1dfed3f2ae..270401efdc7 100644 --- a/ACE/tests/Thread_Attrs_Test.cpp +++ b/ACE/tests/Thread_Attrs_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Attrs_Test.cpp -// -// = DESCRIPTION -// This test program ensures that attributes set on a thread via the -// ACE_Task/ACE_Thread_Manager are honored. -// -// = AUTHOR -// Steve Huston <shuston@riverace.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Attrs_Test.cpp + * + * $Id$ + * + * This test program ensures that attributes set on a thread via the + * ACE_Task/ACE_Thread_Manager are honored. + * + * + * @author Steve Huston <shuston@riverace.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -44,8 +41,8 @@ public: // Check the cancel settings against what is expected then exit. virtual int svc (void); + /// Returns true iff settings match what was requested. bool operator! (); - // Returns true iff settings match what was requested. private: bool enable_req_; @@ -133,31 +130,34 @@ Cancel_Check::open (void *) } +/** + * @class Stack_Size_Check + * + * @brief Defines a task that verifies its stack size. + */ class Stack_Size_Check : public ACE_Task<ACE_MT_SYNCH> { - // = TITLE - // Defines a task that verifies its stack size. public: + /// Create the thread with specified stack size Stack_Size_Check (size_t stack_size); - // Create the thread with specified stack size //FUZZ: disable check_for_lack_ACE_OS + /// Spawn the thread virtual int open (void * = 0); - // Spawn the thread //FUZZ: enable check_for_lack_ACE_OS + /// Check the stack size against what is expected then exit. virtual int svc (void); - // Check the stack size against what is expected then exit. + /// Returns true iff failed_ == false. bool operator! (); - // Returns true iff failed_ == false. private: size_t stack_size_; + /// Flag indicating the test failed. bool failed_; - // Flag indicating the test failed. }; bool diff --git a/ACE/tests/Thread_Creation_Threshold_Test.cpp b/ACE/tests/Thread_Creation_Threshold_Test.cpp index f5f62b84e82..c7b2ddd0dc7 100644 --- a/ACE/tests/Thread_Creation_Threshold_Test.cpp +++ b/ACE/tests/Thread_Creation_Threshold_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Creation_Threshold_Test.cpp -// -// = DESCRIPTION -// This test program stresses how many threads can be -// consecutively (not simultaneously) created on a platform. -// Rather than testing exhaustively, it establishes a -// semi-arbitrary upper limit (MAX_THREAD)of threads. The limit -// is only partly arbitrary because it was chosen as a value that -// exceeded an observed upper limit on the values that Solaris 9 -// will accept as arguments to thr_concurrency(), used by -// ACE_OS::thr_create(THR_NEW_LWP). -// -// = AUTHOR -// Chris Cleeland <cleeland@ociweb.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Creation_Threshold_Test.cpp + * + * $Id$ + * + * This test program stresses how many threads can be + * consecutively (not simultaneously) created on a platform. + * Rather than testing exhaustively, it establishes a + * semi-arbitrary upper limit (MAX_THREAD)of threads. The limit + * is only partly arbitrary because it was chosen as a value that + * exceeded an observed upper limit on the values that Solaris 9 + * will accept as arguments to thr_concurrency(), used by + * ACE_OS::thr_create(THR_NEW_LWP). + * + * + * @author Chris Cleeland <cleeland@ociweb.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -49,53 +46,56 @@ namespace const bool PRINT_DEBUG_MSGS = true; } +/** + * @class Thread_Pool + * + * @brief Defines a thread pool abstraction based on the <ACE_Task>. + */ class Thread_Pool : public ACE_Task<ACE_MT_SYNCH> { - // = TITLE - // Defines a thread pool abstraction based on the <ACE_Task>. public: + /// Create the thread pool containing <n_threads>. Thread_Pool (int n_threads); - // Create the thread pool containing <n_threads>. + /// Destructor... ~Thread_Pool (void); - // Destructor... + /// Iterate <n_iterations> time printing off a message and "waiting" + /// for all other threads to complete this iteration. virtual int svc (void); - // Iterate <n_iterations> time printing off a message and "waiting" - // for all other threads to complete this iteration. + /// Start the threads in the pool. void start(); - // Start the threads in the pool. unsigned long total_threads() { return this->total_activated_threads_.value(); } + /// Number of threads to spawn. int n_threads_; - // Number of threads to spawn. + /// Returns true iff failed_ == false. bool operator! (); - // Returns true iff failed_ == false. private: //FUZZ: disable check_for_lack_ACE_OS + /// Spawn the threads in the pool. virtual int open (void * = 0); - // Spawn the threads in the pool. + /// Close hook. + ///FUZZ: enable check_for_lack_ACE_OS virtual int close (u_long); - // Close hook. - //FUZZ: enable check_for_lack_ACE_OS + /// Total number of threads activated through this thread pool ever. ACE_Atomic_Op<ACE_Thread_Mutex, unsigned long> total_activated_threads_; - // Total number of threads activated through this thread pool ever. + /// Flag set only in worker threads to indicate whether they should print + /// debug messages. bool doprint_; - // Flag set only in worker threads to indicate whether they should print - // debug messages. + /// Flag indicating that start() failed. bool failed_; - // Flag indicating that start() failed. }; bool diff --git a/ACE/tests/Thread_Manager_Test.cpp b/ACE/tests/Thread_Manager_Test.cpp index ba9fb260c15..038add75f0a 100644 --- a/ACE/tests/Thread_Manager_Test.cpp +++ b/ACE/tests/Thread_Manager_Test.cpp @@ -1,24 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Manager_Test.cpp -// -// = DESCRIPTION -// This program tests the group management mechanisms provided by -// the <ACE_Thread_Manager>, including the group signal handling, -// group suspension and resumption, and cooperative thread -// cancellation mechanisms. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt -// <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Manager_Test.cpp + * + * $Id$ + * + * This program tests the group management mechanisms provided by + * the <ACE_Thread_Manager>, including the group signal handling, + * group suspension and resumption, and cooperative thread + * cancellation mechanisms. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread_Manager.h" diff --git a/ACE/tests/Thread_Mutex_Test.cpp b/ACE/tests/Thread_Mutex_Test.cpp index 73893c8a8d3..e6b80dc79ab 100644 --- a/ACE/tests/Thread_Mutex_Test.cpp +++ b/ACE/tests/Thread_Mutex_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Mutex_Test.cpp -// -// = DESCRIPTION -// This test illustrates the functionality of the -// ACE_Thread_Mutex. The test acquires and releases mutexes. No -// command line arguments are needed to run the test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Mutex_Test.cpp + * + * $Id$ + * + * This test illustrates the functionality of the + * ACE_Thread_Mutex. The test acquires and releases mutexes. No + * command line arguments are needed to run the test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Thread_Manager.h" diff --git a/ACE/tests/Thread_Pool_Reactor_Resume_Test.cpp b/ACE/tests/Thread_Pool_Reactor_Resume_Test.cpp index 36455983a4a..b82be95041a 100644 --- a/ACE/tests/Thread_Pool_Reactor_Resume_Test.cpp +++ b/ACE/tests/Thread_Pool_Reactor_Resume_Test.cpp @@ -1,38 +1,35 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Pool_Reactor_Resume_Test.cpp -// -// = DESCRIPTION -// This program is an additional torture test of thread pool -// reactors. This test is based on Thread_Pool_Reactor_Test.cpp -// in $ACE_ROOT/tests. This test differs from the other one -// slightly. The TP reactor is instantiated with the -// with a value of 1 for the <resume_flag> argument. The server -// threads during the handle_input call resumes the handle that -// would have been suspended by the reactor. -// -// Usage: Thread_Pool_Reactor_Test [-r <hostname:port#>] -// [-s <server thr#>] [-c <client thr#>] [-d <delay>] -// [-i <client conn attempt#>] [-n <client request# per conn>] -// -// Default value: -// <hostname:port#>: ACE_DEFAULT_RENDEZVOUS -// <server thr#>: ACE_MAX_THREADS -// <client thr#>: ACE_MAX_ITERATIONS -// <client conn attempt#>: ACE_MAX_ITERATIONS -// <client req# per conn>: ACE_MAX_THREADS -// <delay>: 50 usec -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_Resume_Test.cpp + * + * $Id$ + * + * This program is an additional torture test of thread pool + * reactors. This test is based on Thread_Pool_Reactor_Test.cpp + * in $ACE_ROOT/tests. This test differs from the other one + * slightly. The TP reactor is instantiated with the + * with a value of 1 for the <resume_flag> argument. The server + * threads during the handle_input call resumes the handle that + * would have been suspended by the reactor. + * + * Usage: Thread_Pool_Reactor_Test [-r <hostname:port#>] + * [-s <server thr#>] [-c <client thr#>] [-d <delay>] + * [-i <client conn attempt#>] [-n <client request# per conn>] + * + * Default value: + * <hostname:port#>: ACE_DEFAULT_RENDEZVOUS + * <server thr#>: ACE_MAX_THREADS + * <client thr#>: ACE_MAX_ITERATIONS + * <client conn attempt#>: ACE_MAX_ITERATIONS + * <client req# per conn>: ACE_MAX_THREADS + * <delay>: 50 usec + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Thread_Pool_Reactor_Resume_Test.h b/ACE/tests/Thread_Pool_Reactor_Resume_Test.h index f3f18a5c712..4d7696603c4 100644 --- a/ACE/tests/Thread_Pool_Reactor_Resume_Test.h +++ b/ACE/tests/Thread_Pool_Reactor_Resume_Test.h @@ -1,23 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Pool_Reactor_Test.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Thread_Pool_Reactor_Test.cpp. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_Resume_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Thread_Pool_Reactor_Test.cpp. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_THREAD_POOL_REACTOR_RESUME_TEST_H #define ACE_TESTS_THREAD_POOL_REACTOR_RESUME_TEST_H @@ -30,10 +26,13 @@ #include "ace/Svc_Handler.h" +/** + * @class Request_Handler + * + * @brief This class is the Svc_Handler used by <Acceptor>. + */ class Request_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_MT_SYNCH> { - // = TITLE - // This class is the Svc_Handler used by <Acceptor>. public: /// The default constructor makes sure the right reactor is used. diff --git a/ACE/tests/Thread_Pool_Reactor_Test.cpp b/ACE/tests/Thread_Pool_Reactor_Test.cpp index a1a54fd8203..acc2781c317 100644 --- a/ACE/tests/Thread_Pool_Reactor_Test.cpp +++ b/ACE/tests/Thread_Pool_Reactor_Test.cpp @@ -1,42 +1,38 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Pool_Reactor_Test.cpp -// -// = DESCRIPTION -// This program is a torture test of thread pool reactors. It -// starts by spawning several server threads waiting to handle -// events. Several other client threads are spawned right after -// to initiate connections to server threads. Each connection -// adds a new Svc_Handler into the TP_Reactor and sends out -// several "requests" to the server thread. After the connection -// is closed, the Svc_Handler is removed from the TP_Reactor. -// Each message is treated as a separate request by the server so -// two consecutive requests might be serviced by two different -// threads. -// -// Usage: Thread_Pool_Reactor_Test [-r <hostname:port#>] -// [-s <server thr#>] [-c <client thr#>] [-d <delay>] -// [-i <client conn attempt#>] [-n <client request# per conn>] -// -// Default value: -// <hostname:port#>: ACE_DEFAULT_RENDEZVOUS -// <server thr#>: ACE_MAX_THREADS -// <client thr#>: ACE_MAX_ITERATIONS -// <client conn attempt#>: ACE_MAX_ITERATIONS -// <client req# per conn>: ACE_MAX_THREADS -// <delay>: 50 usec -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> and -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_Test.cpp + * + * $Id$ + * + * This program is a torture test of thread pool reactors. It + * starts by spawning several server threads waiting to handle + * events. Several other client threads are spawned right after + * to initiate connections to server threads. Each connection + * adds a new Svc_Handler into the TP_Reactor and sends out + * several "requests" to the server thread. After the connection + * is closed, the Svc_Handler is removed from the TP_Reactor. + * Each message is treated as a separate request by the server so + * two consecutive requests might be serviced by two different + * threads. + * + * Usage: Thread_Pool_Reactor_Test [-r <hostname:port#>] + * [-s <server thr#>] [-c <client thr#>] [-d <delay>] + * [-i <client conn attempt#>] [-n <client request# per conn>] + * + * Default value: + * <hostname:port#>: ACE_DEFAULT_RENDEZVOUS + * <server thr#>: ACE_MAX_THREADS + * <client thr#>: ACE_MAX_ITERATIONS + * <client conn attempt#>: ACE_MAX_ITERATIONS + * <client req# per conn>: ACE_MAX_THREADS + * <delay>: 50 usec + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_string.h" diff --git a/ACE/tests/Thread_Pool_Reactor_Test.h b/ACE/tests/Thread_Pool_Reactor_Test.h index 0dfeab64528..f9bbe258c5f 100644 --- a/ACE/tests/Thread_Pool_Reactor_Test.h +++ b/ACE/tests/Thread_Pool_Reactor_Test.h @@ -1,23 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Pool_Reactor_Test.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Thread_Pool_Reactor_Test.cpp. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// Nanbor Wang <nanbor@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Reactor_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Thread_Pool_Reactor_Test.cpp. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> Nanbor Wang <nanbor@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_THREAD_POOL_REACTOR_TEST_H #define ACE_TESTS_THREAD_POOL_REACTOR_TEST_H @@ -30,13 +26,16 @@ #include "ace/Svc_Handler.h" +/** + * @class Request_Handler + * + * @brief This class is the Svc_Handler used by <Acceptor>. + */ class Request_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_MT_SYNCH> { - // = TITLE - // This class is the Svc_Handler used by <Acceptor>. public: + /// The default constructor makes sure the right reactor is used. Request_Handler (ACE_Thread_Manager *tm = 0); - // The default constructor makes sure the right reactor is used. protected: virtual int handle_input (ACE_HANDLE fd = ACE_INVALID_HANDLE); diff --git a/ACE/tests/Thread_Pool_Test.cpp b/ACE/tests/Thread_Pool_Test.cpp index 1544503131b..becb44b8938 100644 --- a/ACE/tests/Thread_Pool_Test.cpp +++ b/ACE/tests/Thread_Pool_Test.cpp @@ -1,28 +1,25 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Thread_Pool_Test.cpp -// -// = DESCRIPTION -// This test program illustrates how the <ACE_Task> -// synchronization mechanisms work in conjunction with the -// <ACE_Thread_Manager>. If the <manual> flag is set input comes -// from stdin until the user enters a return -- otherwise, the -// input is generated automatically. All worker threads shutdown -// when (1) they receive a message block of length 0 or (2) the -// queue is deactivated. -// -// = AUTHOR -// Karlheinz Dorn <Karlheinz.Dorn@med.siemens.de>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, and -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Thread_Pool_Test.cpp + * + * $Id$ + * + * This test program illustrates how the <ACE_Task> + * synchronization mechanisms work in conjunction with the + * <ACE_Thread_Manager>. If the <manual> flag is set input comes + * from stdin until the user enters a return -- otherwise, the + * input is generated automatically. All worker threads shutdown + * when (1) they receive a message block of length 0 or (2) the + * queue is deactivated. + * + * + * @author Karlheinz Dorn <Karlheinz.Dorn@med.siemens.de> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author and Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Task.h" @@ -39,51 +36,58 @@ static size_t n_iterations = 100; // Controls whether the input is generated "manually" or automatically. static int manual = 0; +/** + * @class Thread_Pool + * + * @brief Defines a thread pool abstraction based on the <ACE_Task>. + */ class Thread_Pool : public ACE_Task<ACE_MT_SYNCH> { - // = TITLE - // Defines a thread pool abstraction based on the <ACE_Task>. public: + /// Create the thread pool containing <n_threads>. Thread_Pool (int n_threads); - // Create the thread pool containing <n_threads>. + /// Destructor... ~Thread_Pool (void); - // Destructor... + /** + * Activate the task's thread pool, produce the messages that are + * consumed by the threads in the thread pool, and demonstate how to + * shutdown using the <ACE_Message_Queue::deactivate> method. + */ int test_queue_deactivation_shutdown (void); - // Activate the task's thread pool, produce the messages that are - // consumed by the threads in the thread pool, and demonstate how to - // shutdown using the <ACE_Message_Queue::deactivate> method. + /** + * Activate the task's thread pool, produce the messages that are, + * produce the messages that are consumed by the threads in the + * thread pool, and demonstrate how to shutdown by enqueueing + * "empty" messages into the queue. + */ int test_empty_message_shutdown (void); - // Activate the task's thread pool, produce the messages that are, - // produce the messages that are consumed by the threads in the - // thread pool, and demonstrate how to shutdown by enqueueing - // "empty" messages into the queue. + /// Iterate <n_iterations> time printing off a message and "waiting" + /// for all other threads to complete this iteration. virtual int svc (void); - // Iterate <n_iterations> time printing off a message and "waiting" - // for all other threads to complete this iteration. + /// Allows the producer to pass messages to the <Thread_Pool>. virtual int put (ACE_Message_Block *mb, ACE_Time_Value *tv = 0); - // Allows the producer to pass messages to the <Thread_Pool>. private: //FUZZ: disable check_for_lack_ACE_OS + /// Spawn the threads in the pool. virtual int open (void * = 0); - // Spawn the threads in the pool. + //FUZZ: enable check_for_lack_ACE_OS + /// Close hook. virtual int close (u_long); - // Close hook. - //FUZZ: enable check_for_lack_ACE_OS + /// Serialize access to <ACE_Message_Block> reference count, which + /// will be decremented by multiple threads. ACE_Lock_Adapter<ACE_Thread_Mutex> lock_adapter_; - // Serialize access to <ACE_Message_Block> reference count, which - // will be decremented by multiple threads. + /// Number of threads to spawn. int n_threads_; - // Number of threads to spawn. }; Thread_Pool::~Thread_Pool (void) diff --git a/ACE/tests/Time_Service_Test.cpp b/ACE/tests/Time_Service_Test.cpp index b70067e0cce..b63acac5dd6 100644 --- a/ACE/tests/Time_Service_Test.cpp +++ b/ACE/tests/Time_Service_Test.cpp @@ -1,25 +1,22 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Time_Service_Test -// -// = DESCRIPTION -// This example tests the Time Service server and clerk -// components. The test forks and execs two processes to run both -// the clerk and the time server. The clerk and the server -// communicate for a short duration after which the main process -// kills both the processes. No command line arguments are needed -// to run the test. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Time_Service_Test.cpp + * + * $Id$ + * + * This example tests the Time Service server and clerk + * components. The test forks and execs two processes to run both + * the clerk and the time server. The clerk and the server + * communicate for a short duration after which the main process + * kills both the processes. No command line arguments are needed + * to run the test. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/Time_Value_Test.cpp b/ACE/tests/Time_Value_Test.cpp index 04bdde58e22..fc7439b1abd 100644 --- a/ACE/tests/Time_Value_Test.cpp +++ b/ACE/tests/Time_Value_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Time_Value_Test.cpp -// -// = DESCRIPTION -// This is a simple test of ACE_Time_Value. No command line arguments -// are needed to run the test. It also tests the ACE_U_LongLong class. -// Because ACE_U_LongLong is used for ACE_hrtime_t on some platforms, -// this seems like a reasonable place to test it. -// -// = AUTHOR -// Prashant Jain <pjain@cs.wustl.edu> and David Levine <levine@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Time_Value_Test.cpp + * + * $Id$ + * + * This is a simple test of ACE_Time_Value. No command line arguments + * are needed to run the test. It also tests the ACE_U_LongLong class. + * Because ACE_U_LongLong is used for ACE_hrtime_t on some platforms, + * this seems like a reasonable place to test it. + * + * + * @author Prashant Jain <pjain@cs.wustl.edu> and David Levine <levine@cs.wustl.edu> + */ +//============================================================================= + // Note, for this test the config.h file *must* come first! #include "ace/config-all.h" diff --git a/ACE/tests/Timeprobe_Test.cpp b/ACE/tests/Timeprobe_Test.cpp index 31ed6da4a05..42b5e7811f9 100644 --- a/ACE/tests/Timeprobe_Test.cpp +++ b/ACE/tests/Timeprobe_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Timeprobe_Test.cpp -// -// = DESCRIPTION -// This is a simple test of ACE Timeprobes. -// -// = AUTHOR -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Timeprobe_Test.cpp + * + * $Id$ + * + * This is a simple test of ACE Timeprobes. + * + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + //#define ACE_ENABLE_TIMEPROBES //#define ACE_MT_TIMEPROBES diff --git a/ACE/tests/Timer_Cancellation_Test.cpp b/ACE/tests/Timer_Cancellation_Test.cpp index 5f5992b10b7..838a55fdd85 100644 --- a/ACE/tests/Timer_Cancellation_Test.cpp +++ b/ACE/tests/Timer_Cancellation_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Timer_Cancellation_Test.cpp -// -// = DESCRIPTION -// A test to ensure the timer cancellation works correctly. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Timer_Cancellation_Test.cpp + * + * $Id$ + * + * A test to ensure the timer cancellation works correctly. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/OS_NS_unistd.h" diff --git a/ACE/tests/Timer_Queue_Reference_Counting_Test.cpp b/ACE/tests/Timer_Queue_Reference_Counting_Test.cpp index 0faa97b9b2f..400a8711b1c 100644 --- a/ACE/tests/Timer_Queue_Reference_Counting_Test.cpp +++ b/ACE/tests/Timer_Queue_Reference_Counting_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Timer_Queue_Reference_Counting_Test.cpp -// -// = DESCRIPTION -// This test is used to check reference counting of the Event -// Handler when it interacts with Timer Queues. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Timer_Queue_Reference_Counting_Test.cpp + * + * $Id$ + * + * This test is used to check reference counting of the Event + * Handler when it interacts with Timer Queues. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Get_Opt.h" diff --git a/ACE/tests/Timer_Queue_Test.cpp b/ACE/tests/Timer_Queue_Test.cpp index 6cec83d8e09..209ea014356 100644 --- a/ACE/tests/Timer_Queue_Test.cpp +++ b/ACE/tests/Timer_Queue_Test.cpp @@ -1,27 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Timer_Queue_Test.cpp -// -// = DESCRIPTION -// This is a simple test of <ACE_Timer_Queue> and four of its -// subclasses (<ACE_Timer_List>, <ACE_Timer_Heap>, -// <ACE_Timer_Wheel>, and <ACE_Timer_Hash>). The test sets up a -// bunch of timers and then adds them to a timer queue. The -// functionality of the timer queue is then tested. No command -// line arguments are needed to run the test. -// -// = AUTHORS -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, -// Prashant Jain <pjain@cs.wustl.edu>, and -// Darrell Brunsch <brunsch@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Timer_Queue_Test.cpp + * + * $Id$ + * + * This is a simple test of <ACE_Timer_Queue> and four of its + * subclasses (<ACE_Timer_List>, <ACE_Timer_Heap>, + * <ACE_Timer_Wheel>, and <ACE_Timer_Hash>). The test sets up a + * bunch of timers and then adds them to a timer queue. The + * functionality of the timer queue is then tested. No command + * line arguments are needed to run the test. + * + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author Prashant Jain <pjain@cs.wustl.edu> + * @author and Darrell Brunsch <brunsch@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "randomize.h" @@ -83,8 +80,8 @@ public: return result; } + /// Keeps track of the number of times that <handle_close> is called. int close_count_; - // Keeps track of the number of times that <handle_close> is called. }; @@ -581,13 +578,15 @@ test_unique_timer_heap_ids (void) return; } +/** + * @class Timer_Queue_Stack + * + * @brief Keeps track of the <Timer_Queue>s that we're going to test. + * + * This data structure is organized as a stack to make it easy to implement. + */ class Timer_Queue_Stack { - // = TITLE - // Keeps track of the <Timer_Queue>s that we're going to test. - // - // = DESCRIPTION - // This data structure is organized as a stack to make it easy to implement. public: // = Initialization method Timer_Queue_Stack (ACE_Timer_Queue *queue, @@ -599,14 +598,14 @@ public: {} // "Push" a new <queue> on the stack of <queue>s. + /// Pointer to the subclass of <ACE_Timer_Queue> that we're testing. ACE_Timer_Queue *queue_; - // Pointer to the subclass of <ACE_Timer_Queue> that we're testing. + /// Name of the Queue that we're testing. const ACE_TCHAR *name_; - // Name of the Queue that we're testing. + /// Pointer to the next <Timer_Queue>. Timer_Queue_Stack *next_; - // Pointer to the next <Timer_Queue>. }; int diff --git a/ACE/tests/TkReactor_Test.cpp b/ACE/tests/TkReactor_Test.cpp index 6835b9979f6..52a75ca8eb6 100644 --- a/ACE/tests/TkReactor_Test.cpp +++ b/ACE/tests/TkReactor_Test.cpp @@ -1,28 +1,25 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// TkReactor_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the possibility to integrate -// ACE to the Tk Main Loop. This program uses ACE_TkReactor class to -// schedule three additional event sources: -// 1. Events from button "Stop Test" (registed with Tk_CreateEventHandler) -// 2. Events from button "Press Me" (registed with Tk_CreateEventHandler) -// 3. Events from X timer (registed with Tk_CreateTimerHandler) -// 4. Events from ACE timer (registed with ACE_TkReactor::schedule_timer) -// 5. Events from the TCP/IP channel using ACE_Acceptor -// No command line arguments are needed to run the test. -// -// = AUTHOR -// Nagarajan Surendran <naga@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file TkReactor_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the possibility to integrate + * ACE to the Tk Main Loop. This program uses ACE_TkReactor class to + * schedule three additional event sources: + * 1. Events from button "Stop Test" (registed with Tk_CreateEventHandler) + * 2. Events from button "Press Me" (registed with Tk_CreateEventHandler) + * 3. Events from X timer (registed with Tk_CreateTimerHandler) + * 4. Events from ACE timer (registed with ACE_TkReactor::schedule_timer) + * 5. Events from the TCP/IP channel using ACE_Acceptor + * No command line arguments are needed to run the test. + * + * + * @author Nagarajan Surendran <naga@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/Tokens_Test.cpp b/ACE/tests/Tokens_Test.cpp index 5c2f715d365..8b8b3f7c3a4 100644 --- a/ACE/tests/Tokens_Test.cpp +++ b/ACE/tests/Tokens_Test.cpp @@ -1,29 +1,26 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Tokens_Test.cpp -// -// = DESCRIPTION -// This application tests the ACE Token library including local -// and remote readers/writer and mutex locks, and token -// collections. This is accomplished with the ACE Token Invariant -// utilities that allow and application to check that -// readers/writer and mutex lock invariants are always satisfied. -// Throughout this test, ACE_TEST_ASSERTs are used in conjunction with -// Token Invariant operations, so that errors are reported using -// the ACE tests convention. This application performs a local -// test and then fork_execs a token server and performs the same -// test remotely. -// -// = AUTHOR -// Tim Harrison <harrison@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Tokens_Test.cpp + * + * $Id$ + * + * This application tests the ACE Token library including local + * and remote readers/writer and mutex locks, and token + * collections. This is accomplished with the ACE Token Invariant + * utilities that allow and application to check that + * readers/writer and mutex lock invariants are always satisfied. + * Throughout this test, ACE_TEST_ASSERTs are used in conjunction with + * Token Invariant operations, so that errors are reported using + * the ACE tests convention. This application performs a local + * test and then fork_execs a token server and performs the same + * test remotely. + * + * + * @author Tim Harrison <harrison@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Process.h" diff --git a/ACE/tests/UPIPE_SAP_Test.cpp b/ACE/tests/UPIPE_SAP_Test.cpp index 0c059cde7b3..f40b533059a 100644 --- a/ACE/tests/UPIPE_SAP_Test.cpp +++ b/ACE/tests/UPIPE_SAP_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// UPIPE_SAP_Test.cpp -// -// = DESCRIPTION -// This is a test that uses <ACE_UPIPE_SAP> and <ACE_Thread> for -// intra-process communication. -// -// = AUTHOR -// Gerhard Lenzer <Gerhard.Lenzer@med.siemens.de>, -// Douglas C. Schmidt <schmidt@cs.wustl.edu>, and -// Prashant Jain <pjain@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file UPIPE_SAP_Test.cpp + * + * $Id$ + * + * This is a test that uses <ACE_UPIPE_SAP> and <ACE_Thread> for + * intra-process communication. + * + * + * @author Gerhard Lenzer <Gerhard.Lenzer@med.siemens.de> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + * @author and Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + #include "test_config.h" #include "ace/Stream.h" diff --git a/ACE/tests/UUID_Test.cpp b/ACE/tests/UUID_Test.cpp index 2c753475ebf..3ef3eaffa85 100644 --- a/ACE/tests/UUID_Test.cpp +++ b/ACE/tests/UUID_Test.cpp @@ -1,20 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// UUID_Test.cpp -// -// = DESCRIPTION -// Test the ACE UUID class which generates unique id's -// -// = AUTHOR -// Andrew T. Finnel <andrew@activesol.net> and -// Yamuna Krishnmaurthy <yamuna@oomworks.com> -// ============================================================================ + +//============================================================================= +/** + * @file UUID_Test.cpp + * + * $Id$ + * + * Test the ACE UUID class which generates unique id's + * + * + * @author Andrew T. Finnel <andrew@activesol.net> and Yamuna Krishnmaurthy <yamuna@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/UUID.h" diff --git a/ACE/tests/Unbounded_Set_Test.cpp b/ACE/tests/Unbounded_Set_Test.cpp index ff72e56e728..960a4dd0ef5 100644 --- a/ACE/tests/Unbounded_Set_Test.cpp +++ b/ACE/tests/Unbounded_Set_Test.cpp @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Unbounded_Set_Test.cpp -// -// = DESCRIPTION -// This test illustrates the use of ACE_Unbounded_Set. -// No command line arguments are needed to run the test. -// -// = AUTHOR -// Rudolf Weber <rfweber@tesionmail.de>, -// ace/tests integration <Oliver.Kellogg@sysde.eads.net> -// -// ============================================================================ + +//============================================================================= +/** + * @file Unbounded_Set_Test.cpp + * + * $Id$ + * + * This test illustrates the use of ACE_Unbounded_Set. + * No command line arguments are needed to run the test. + * + * + * @author Rudolf Weber <rfweber@tesionmail.de> + * @author ace/tests integration <Oliver.Kellogg@sysde.eads.net> + */ +//============================================================================= + #include "test_config.h" #include <ace/Unbounded_Set.h> diff --git a/ACE/tests/Unload_libACE.cpp b/ACE/tests/Unload_libACE.cpp index 4a88cda8e45..83d43ec8640 100644 --- a/ACE/tests/Unload_libACE.cpp +++ b/ACE/tests/Unload_libACE.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Unload_libACE.cpp -// -// = DESCRIPTION -// This is a simple test of library unloading that uses -// an application which has _not_ been linked with libACE -// but uses dlopen() to dynamically load libACE -// and then uses dlclose() to unload it. -// -// = AUTHORS -// David Smith <dts@prismtech.com> and Don Sharp <Donald.Sharp@prismtech.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file Unload_libACE.cpp + * + * $Id$ + * + * This is a simple test of library unloading that uses + * an application which has _not_ been linked with libACE + * but uses dlopen() to dynamically load libACE + * and then uses dlclose() to unload it. + * + * + * @author David Smith <dts@prismtech.com> and Don Sharp <Donald.Sharp@prismtech.com> + */ +//============================================================================= + //FUZZ: disable check_for_lack_ACE_OS //FUZZ: disable check_for_improper_main_declaration diff --git a/ACE/tests/Upgradable_RW_Test.cpp b/ACE/tests/Upgradable_RW_Test.cpp index 818811b1537..83f1b38bf16 100644 --- a/ACE/tests/Upgradable_RW_Test.cpp +++ b/ACE/tests/Upgradable_RW_Test.cpp @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Upgradable_RW_Test.cpp -// -// = DESCRIPTION -// This test program verifies the functionality of the ACE_OS -// implementation of readers/writer locks on Win32 and Posix -// pthreads. Use the RW_Mutex define switch to use -// readers/writer mutexes or regular mutexes. -// -// = AUTHOR -// Michael Kircher <mk1@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Upgradable_RW_Test.cpp + * + * $Id$ + * + * This test program verifies the functionality of the ACE_OS + * implementation of readers/writer locks on Win32 and Posix + * pthreads. Use the RW_Mutex define switch to use + * readers/writer mutexes or regular mutexes. + * + * + * @author Michael Kircher <mk1@cs.wustl.edu> + */ +//============================================================================= + #include "Upgradable_RW_Test.h" #include "ace/OS_NS_stdio.h" diff --git a/ACE/tests/Upgradable_RW_Test.h b/ACE/tests/Upgradable_RW_Test.h index 41c6c0dba1e..d9f79c313bf 100644 --- a/ACE/tests/Upgradable_RW_Test.h +++ b/ACE/tests/Upgradable_RW_Test.h @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Upgradable_RW_Test.h -// -// = DESCRIPTION -// This class gets its own header file to work around AIX C++ -// compiler "features" related to template instantiation... It is -// only used by Upgradable_RW_Test.cpp. -// -// = AUTHOR -// Michael Kircher <mk1@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Upgradable_RW_Test.h + * + * $Id$ + * + * This class gets its own header file to work around AIX C++ + * compiler "features" related to template instantiation... It is + * only used by Upgradable_RW_Test.cpp. + * + * + * @author Michael Kircher <mk1@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_TESTS_UPGRADABLE_RW_TEST_H #define ACE_TESTS_UPGRADABLE_RW_TEST_H @@ -37,10 +34,13 @@ class Element; + /** + * @class Element + * + * @brief The members for the double linked list. + */ class Element { - // = TITLE - // The members for the double linked list. friend class ACE_Double_Linked_List<Element>; friend class ACE_Double_Linked_List_Iterator_Base<Element>; friend class ACE_Double_Linked_List_Iterator<Element>; @@ -69,10 +69,13 @@ private: typedef ACE_Double_Linked_List<Element> Linked_List; +/** + * @class Time_Calculation + * + * @brief class to do time calculations thread safe + */ class Time_Calculation { - // = TITLE - // class to do time calculations thread safe public: Time_Calculation (void) : reported_times_ (0) @@ -82,26 +85,29 @@ public: times_.system_time = 0; } + /// take the time of the thread and add it to void report_time (ACE_Profile_Timer::ACE_Elapsed_Time &elapsed_time); - // take the time of the thread and add it to void print_stats (void); private: + /// add the times incrementally ACE_Profile_Timer::ACE_Elapsed_Time times_; - // add the times incrementally + /// protect the time ACE_SYNCH_MUTEX mutex_; - // protect the time + /// count how many threads gave me the elapsed_time unsigned int reported_times_; - // count how many threads gave me the elapsed_time }; +/** + * @class Reader_Task + * + * @brief A Task for readers + */ class Reader_Task : public ACE_Task_Base { - // = TITLE - // A Task for readers public: Reader_Task (Time_Calculation &time_Calculation, ACE_Barrier &barrier) @@ -113,18 +119,21 @@ public: virtual int svc (void); private: + /// keep a reference to the time calculation class Time_Calculation &time_Calculation_; - // keep a reference to the time calculation class + /// keep this reference for the barrier, in order + /// to allow a "nice" start ACE_Barrier &barrier_; - // keep this reference for the barrier, in order - // to allow a "nice" start }; +/** + * @class Writer_Task + * + * @brief A Task for wirters. + */ class Writer_Task : public ACE_Task_Base { - // = TITLE - // A Task for wirters. public: Writer_Task (Time_Calculation &time_Calculation, ACE_Barrier &barrier) @@ -136,12 +145,12 @@ public: virtual int svc (void); private: + /// keep a reference to the time calculation class Time_Calculation &time_Calculation_; - // keep a reference to the time calculation class + /// keep this reference for the barrier, in order + /// to allow a "nice" start ACE_Barrier &barrier_; - // keep this reference for the barrier, in order - // to allow a "nice" start }; #endif /* ACE_TESTS_UPGRADABLE_RW_TEST_H */ diff --git a/ACE/tests/Vector_Test.cpp b/ACE/tests/Vector_Test.cpp index 31107386692..581202129d7 100644 --- a/ACE/tests/Vector_Test.cpp +++ b/ACE/tests/Vector_Test.cpp @@ -1,21 +1,17 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// Vector_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the ACE_Vector class and its iterators. -// -// = AUTHOR -// Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> and -// Karl-Heinz Wind <wind@itq.de> -// -// ============================================================================ + +//============================================================================= +/** + * @file Vector_Test.cpp + * + * $Id$ + * + * This is a simple test of the ACE_Vector class and its iterators. + * + * + * @author Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com> and Karl-Heinz Wind <wind@itq.de> + */ +//============================================================================= + #include "test_config.h" diff --git a/ACE/tests/WFMO_Reactor_Test.cpp b/ACE/tests/WFMO_Reactor_Test.cpp index 83c7475dfbe..e72d57b6300 100644 --- a/ACE/tests/WFMO_Reactor_Test.cpp +++ b/ACE/tests/WFMO_Reactor_Test.cpp @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// WFMO_Reactor_Test.cpp -// -// = DESCRIPTION -// This is a simple test of the WFMO_Reactor. It makes sure that -// removals and suspensions work correctly. -// -// = AUTHOR -// Irfan Pyarali <irfan@oomworks.com> -// -// ============================================================================ + +//============================================================================= +/** + * @file WFMO_Reactor_Test.cpp + * + * $Id$ + * + * This is a simple test of the WFMO_Reactor. It makes sure that + * removals and suspensions work correctly. + * + * + * @author Irfan Pyarali <irfan@oomworks.com> + */ +//============================================================================= + #include "test_config.h" #include "ace/Reactor.h" diff --git a/ACE/tests/XtAthenaReactor_Test.cpp b/ACE/tests/XtAthenaReactor_Test.cpp index 3cfdd7794d3..977fd32480f 100644 --- a/ACE/tests/XtAthenaReactor_Test.cpp +++ b/ACE/tests/XtAthenaReactor_Test.cpp @@ -1,30 +1,27 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// XtReactor_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the possibility to integrate -// ACE to the X Main Loop. This program uses ACE_XtReactor class to -// schedule three additional event sources: -// 1. Events from button "Stop Test" (registed with XtAddCallback) -// 2. Events from button "Press Me" (registed with XtAddCallback) -// 3. Events from X timer (registed with XtAppAddTimeOut) -// 4. Events from ACE timer (registed with ACE_XtReactor::schedule_timer) -// 5. Events from the TCP/IP channel using ACE_Acceptor -// No command line arguments are needed to run the test. -// Programs needs Athena Widgets to be compiled and run. -// -// = AUTHOR -// Kirill Rybaltchenko <Kirill.Rybaltchenko@cern.ch> -// -// ============================================================================ + +//============================================================================= +/** + * @file XtAthenaReactor_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the possibility to integrate + * ACE to the X Main Loop. This program uses ACE_XtReactor class to + * schedule three additional event sources: + * 1. Events from button "Stop Test" (registed with XtAddCallback) + * 2. Events from button "Press Me" (registed with XtAddCallback) + * 3. Events from X timer (registed with XtAppAddTimeOut) + * 4. Events from ACE timer (registed with ACE_XtReactor::schedule_timer) + * 5. Events from the TCP/IP channel using ACE_Acceptor + * No command line arguments are needed to run the test. + * Programs needs Athena Widgets to be compiled and run. + * + * + * @author Kirill Rybaltchenko <Kirill.Rybaltchenko@cern.ch> + */ +//============================================================================= + #include "test_config.h" #include "ace/XtReactor/XtReactor.h" diff --git a/ACE/tests/XtMotifReactor_Test.cpp b/ACE/tests/XtMotifReactor_Test.cpp index f80b2e5986e..d168b74f19a 100644 --- a/ACE/tests/XtMotifReactor_Test.cpp +++ b/ACE/tests/XtMotifReactor_Test.cpp @@ -1,30 +1,27 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tests -// -// = FILENAME -// XtReactor_Test.cpp -// -// = DESCRIPTION -// This is a simple test that illustrates the possibility to integrate -// ACE to the X Main Loop. This program uses ACE_XtReactor class to -// schedule three additional event sources: -// 1. Events from button "Stop Test" (registed with XtAddCallback) -// 2. Events from button "Press Me" (registed with XtAddCallback) -// 3. Events from X timer (registed with XtAppAddTimeOut) -// 4. Events from ACE timer (registed with ACE_XtReactor::schedule_timer) -// 5. Events from the TCP/IP channel using ACE_Acceptor -// No command line arguments are needed to run the test. -// The program needs Motif or lestiff to be compiled and run. -// -// = AUTHOR -// Kirill Rybaltchenko <Kirill.Rybaltchenko@cern.ch> -// -// ============================================================================ + +//============================================================================= +/** + * @file XtMotifReactor_Test.cpp + * + * $Id$ + * + * This is a simple test that illustrates the possibility to integrate + * ACE to the X Main Loop. This program uses ACE_XtReactor class to + * schedule three additional event sources: + * 1. Events from button "Stop Test" (registed with XtAddCallback) + * 2. Events from button "Press Me" (registed with XtAddCallback) + * 3. Events from X timer (registed with XtAppAddTimeOut) + * 4. Events from ACE timer (registed with ACE_XtReactor::schedule_timer) + * 5. Events from the TCP/IP channel using ACE_Acceptor + * No command line arguments are needed to run the test. + * The program needs Motif or lestiff to be compiled and run. + * + * + * @author Kirill Rybaltchenko <Kirill.Rybaltchenko@cern.ch> + */ +//============================================================================= + #include "test_config.h" |