summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Time_Utilities.h
blob: 86759d4ae66fd866ba7e0a0a6541509510240911 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    orbsvcs
//
// = FILENAME
//    Time_Utilities.h
//
// = AUTHOR
//     David Levine <levine@cs.wustl.edu>
//
// ============================================================================

#ifndef ORBSVCS_TIME_UTILITIES_H
#define ORBSVCS_TIME_UTILITIES_H
#include /**/ "ace/pre.h"

#include "orbsvcs/TimeBaseC.h"
#include "orbsvcs/svc_utils_export.h"
#include "ace/OS_NS_time.h"

class TAO_Svc_Utils_Export ORBSVCS_Time
{
  // = TITLE
  //   Time conversion utilities.
  //
  // = DESCRIPTION
  //   This class define several static methods to convert between
  //   several time structures and the CORBA TimeT structure.
  //
  //   Recall that TimeT stores time in a 64-bit long long (or
  //   structure when that is not available) and uses hundreds of
  //   nanoseconds as time units (i.e. 1 second is 10^7 TimeT units).
public:
  // = A helper constant, IDL does not have constant for structures.
  static TimeBase::TimeT zero ();

  // = ACE_hrtime_t conversion routines.

  // We interpret an ACE_hrtime_t as nanoseconds.

  static void hrtime_to_TimeT (TimeBase::TimeT &lhs,
                               ACE_hrtime_t rhs);
  // Convert high-resolution time to a <TimeT>.

  static void TimeT_to_hrtime (ACE_hrtime_t &lhs,
                               const TimeBase::TimeT &rhs);
  // Convert <TimeT> to a high-resolution time.

  static ACE_hrtime_t to_hrtime (const TimeBase::TimeT &t);
  // Convert <TimeT> to a high-resolution time.

  // = ACE_Time_Value conversion routines.

  // Recall that <ACE_Time_Value>s are <seconds, useconds> pairs.

  static void Time_Value_to_TimeT (TimeBase::TimeT& lhs,
                                   const ACE_Time_Value& rhs);
  // Convert an <ACE_Time_Value> to a <TimeT>.
  static void TimeT_to_Time_Value (ACE_Time_Value& lrs,
                                   const TimeBase::TimeT& rhs);
  // Convert an <TimeT> to a <ACE_Time_Value>.

  static ACE_Time_Value to_Time_Value (const TimeBase::TimeT &rhs);
  // Convert an <TimeT> to a <ACE_Time_Value>.
};

#if defined (__ACE_INLINE__)
#include "orbsvcs/Time_Utilities.i"
#endif /* __ACE_INLINE__ */

#include /**/ "ace/post.h"
#endif /* ORBSVCS_TIME_UTILITIES_H */