diff options
Diffstat (limited to 'ace/System_Time.h')
| -rw-r--r-- | ace/System_Time.h | 77 |
1 files changed, 40 insertions, 37 deletions
diff --git a/ace/System_Time.h b/ace/System_Time.h index ca3afa1a7a7..3374d031cac 100644 --- a/ace/System_Time.h +++ b/ace/System_Time.h @@ -1,19 +1,17 @@ /* -*- C++ -*- */ -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// System_Time.h -// -// = AUTHOR -// Prashant Jain, Tim H. Harrison and Douglas C. Schmidt -// -// ============================================================================ + + +//============================================================================= +/** + * @file System_Time.h + * + * $Id$ + * + * @author Prashant Jain + * @author Tim H. Harrison and Douglas C. Schmidt + */ +//============================================================================= + #ifndef ACE_SYSTEM_TIME_H #define ACE_SYSTEM_TIME_H @@ -28,56 +26,61 @@ #include "ace/Memory_Pool.h" #include "ace/Malloc_T.h" +/** + * @class ACE_System_Time + * + * @brief Defines the timer services of the OS interface to access the + * system time either on the local host or on the central time + * server in the network. + */ class ACE_Export ACE_System_Time { - // = TITLE - // Defines the timer services of the OS interface to access the - // system time either on the local host or on the central time - // server in the network. public: + /** + * enumeration types to specify mode of synchronization with master + * clock. Jump will set local system time directly (thus possibly + * producing time gaps or ambiguous local system times. Adjust will + * smoothly slow down or speed up the local system clock to reach + * the system time of the master clock. + */ enum Sync_Mode { Jump, Adjust }; - // enumeration types to specify mode of synchronization with master - // clock. Jump will set local system time directly (thus possibly - // producing time gaps or ambiguous local system times. Adjust will - // smoothly slow down or speed up the local system clock to reach - // the system time of the master clock. + /// Default constructor. ACE_System_Time (const ACE_TCHAR *poolname = 0); - // Default constructor. + /// Default destructor. ~ACE_System_Time (void); - // Default destructor. + /// Get the local system time, i.e., the value returned by + /// <ACE_OS::time>. static int get_local_system_time (ACE_UINT32 &time_out); - // Get the local system time, i.e., the value returned by - // <ACE_OS::time>. + /// Get the local system time, i.e., the value returned by + /// <ACE_OS::time>. static int get_local_system_time (ACE_Time_Value &time_out); - // Get the local system time, i.e., the value returned by - // <ACE_OS::time>. + /// Get the system time of the central time server. int get_master_system_time (ACE_UINT32 &time_out); - // Get the system time of the central time server. + /// Get the system time of the central time server. int get_master_system_time (ACE_Time_Value &time_out); - // Get the system time of the central time server. + /// synchronize local system time with the central time server using + /// specified mode. int sync_local_system_time (ACE_System_Time::Sync_Mode mode); - // synchronize local system time with the central time server using - // specified mode. private: typedef ACE_Malloc <ACE_MMAP_MEMORY_POOL, ACE_Null_Mutex> MALLOC; typedef ACE_Allocator_Adapter<MALLOC> ALLOCATOR; + /// Our allocator (used for obtaining system time from shared memory). ALLOCATOR *shmem_; - // Our allocator (used for obtaining system time from shared memory). + /// The name of the pool used by the allocator. ACE_TCHAR poolname_[MAXPATHLEN + 1]; - // The name of the pool used by the allocator. + /// Pointer to delta time kept in shared memory. long *delta_time_; - // Pointer to delta time kept in shared memory. }; #include "ace/post.h" |