Public Types | Public Member Functions | Public Attributes | Private Attributes | Friends

TAO_Time_Service_Clerk Class Reference

TimeService Object Implementation. More...

#include <TAO_Time_Service_Clerk.h>

Collaboration diagram for TAO_Time_Service_Clerk:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ACE_Array_Base
< CosTime::TimeService_var > 
IORS
 Unbounded set of IORs.

Public Member Functions

 TAO_Time_Service_Clerk (int timer_value, int timer_value_usecs, const IORS &server)
 Constructor.
 ~TAO_Time_Service_Clerk (void)
 Destructor.
virtual CosTime::UTO_ptr universal_time (void)
virtual CosTime::UTO_ptr secure_universal_time (void)
virtual CosTime::UTO_ptr new_universal_time (TimeBase::TimeT time, TimeBase::InaccuracyT inaccuracy, TimeBase::TdfT tdf)
 This creates a new UTO based on the given parameters.
virtual CosTime::UTO_ptr uto_from_utc (const TimeBase::UtcT &utc)
 This creates a new UTO given a time in the UtcT form.
virtual CosTime::TIO_ptr new_interval (TimeBase::TimeT lower, TimeBase::TimeT upper)
 This creates a new TIO with the given parameters.
virtual CORBA::ULongLong get_time (void)
 Return the globally synchronized time.
CORBA::Short time_displacement_factor (void)
 Returns the time displacement factor.
void time_displacement_factor (CORBA::Short)
 Set the TDF.
TimeBase::InaccuracyT inaccuracy (void)
 Get method for inaccuracy.
void inaccuracy (TimeBase::InaccuracyT inaccuracy)
 Set method for inaccuracy.

Public Attributes

CORBA::ULongLong time_
 Clerk's notion of time.

Private Attributes

CORBA::Short time_displacement_factor_
 Time displacement factor in minutes.
TimeBase::InaccuracyT inaccuracy_
 Inaccuracy in the time.
IORS server_
 Set of server Time Server IORs.
CORBA::ULongLong update_timestamp_
 Time when last global synchronization was done.
Timer_Helper helper_

Friends

class Timer_Helper
 Helper class to help in the updation of time.

Detailed Description

TimeService Object Implementation.

The Object implementation implements methods to retrieve GLOBAL time as well as secure GLOBAL time. The times are retrieved as UTOs. The object also allows creation of a TIO for a given time interval. In general, the TimeService clerk manages the UTOs and the TIOs. The notion of time returned here is the globally synchronized time.

Definition at line 42 of file TAO_Time_Service_Clerk.h.


Member Typedef Documentation

typedef ACE_Array_Base<CosTime::TimeService_var> TAO_Time_Service_Clerk::IORS

Unbounded set of IORs.

Definition at line 50 of file TAO_Time_Service_Clerk.h.


Constructor & Destructor Documentation

TAO_Time_Service_Clerk::TAO_Time_Service_Clerk ( int  timer_value,
int  timer_value_usecs,
const IORS server 
)

Constructor.

Definition at line 14 of file TAO_Time_Service_Clerk.cpp.

  : server_ (servers),
    helper_ (this)
{
  // Schedule the helper to be invoked by the reactor
  // periodically.

  if (TAO_ORB_Core_instance ()->reactor ()->schedule_timer
      (&helper_,
       0,
       ACE_Time_Value::zero,
       ACE_Time_Value(timer_value,timer_value_usecs)) == -1)
    ACE_ERROR ((LM_ERROR,
                "%p\n",
                "schedule_timer ()"));
}

TAO_Time_Service_Clerk::~TAO_Time_Service_Clerk ( void   ) 

Destructor.

Definition at line 35 of file TAO_Time_Service_Clerk.cpp.

{
}


Member Function Documentation

CORBA::ULongLong TAO_Time_Service_Clerk::get_time ( void   )  [virtual]

Return the globally synchronized time.

Definition at line 123 of file TAO_Time_Service_Clerk.cpp.

{
  // Globally sync. time is the latest global time plus the time
  // elapsed since last updation was done.

  const ACE_Time_Value timeofday = ACE_OS::gettimeofday ();

  return (CORBA::ULongLong) (static_cast<CORBA::ULongLong> (timeofday.sec ()) *
                             static_cast<ACE_UINT32> (10000000) +
                             static_cast<CORBA::ULongLong> (timeofday.usec () * 10))
    - this->update_timestamp_
    + this->time_;
}

TimeBase::InaccuracyT TAO_Time_Service_Clerk::inaccuracy ( void   ) 

Get method for inaccuracy.

Definition at line 154 of file TAO_Time_Service_Clerk.cpp.

{
  return this->inaccuracy_;
}

void TAO_Time_Service_Clerk::inaccuracy ( TimeBase::InaccuracyT  inaccuracy  ) 

Set method for inaccuracy.

Definition at line 161 of file TAO_Time_Service_Clerk.cpp.

{
  this->inaccuracy_ = inaccuracy;
}

CosTime::TIO_ptr TAO_Time_Service_Clerk::new_interval ( TimeBase::TimeT  lower,
TimeBase::TimeT  upper 
) [virtual]

This creates a new TIO with the given parameters.

Definition at line 110 of file TAO_Time_Service_Clerk.cpp.

{
  TAO_TIO *tio = 0;

  ACE_NEW_THROW_EX (tio,
                    TAO_TIO (lower,
                             upper),
                    CORBA::NO_MEMORY ());
  return tio->_this ();
}

CosTime::UTO_ptr TAO_Time_Service_Clerk::new_universal_time ( TimeBase::TimeT  time,
TimeBase::InaccuracyT  inaccuracy,
TimeBase::TdfT  tdf 
) [virtual]

This creates a new UTO based on the given parameters.

Definition at line 70 of file TAO_Time_Service_Clerk.cpp.

{
  TAO_UTO *uto = 0;

  ACE_NEW_THROW_EX (uto,
                    TAO_UTO (time,
                             inaccuracy,
                             tdf),
                    CORBA::NO_MEMORY ());

  return uto->_this ();
}

CosTime::UTO_ptr TAO_Time_Service_Clerk::secure_universal_time ( void   )  [virtual]

This operation returns the global time in a UTO only if the time can be guaranteed to have been obtained securely. Currently this operation is not implemented and throws a CORBA::NO_IMPLEMENT exception, if called.

Definition at line 62 of file TAO_Time_Service_Clerk.cpp.

{
  throw CORBA::NO_IMPLEMENT ();
}

CORBA::Short TAO_Time_Service_Clerk::time_displacement_factor ( void   ) 

Returns the time displacement factor.

Definition at line 140 of file TAO_Time_Service_Clerk.cpp.

void TAO_Time_Service_Clerk::time_displacement_factor ( CORBA::Short  tdf  ) 

Set the TDF.

Definition at line 147 of file TAO_Time_Service_Clerk.cpp.

{
  this->time_displacement_factor_ = tdf;
}

CosTime::UTO_ptr TAO_Time_Service_Clerk::universal_time ( void   )  [virtual]

This operation returns the global time and an estimate of inaccuracy in a UTO.

Definition at line 43 of file TAO_Time_Service_Clerk.cpp.

{
  TAO_UTO *uto = 0;

  ACE_NEW_THROW_EX (uto,
                    TAO_UTO (this->get_time (),
                             this->inaccuracy (),
                             this->time_displacement_factor ()),
                    CORBA::NO_MEMORY ());
  // Return the global time as a UTO.

  return uto->_this ();
}

CosTime::UTO_ptr TAO_Time_Service_Clerk::uto_from_utc ( const TimeBase::UtcT &  utc  )  [virtual]

This creates a new UTO given a time in the UtcT form.

Definition at line 88 of file TAO_Time_Service_Clerk.cpp.

{
  TAO_UTO *uto = 0;

  // Use the low and high values of inaccuracy
  // to calculate the total inaccuracy.

  TimeBase::InaccuracyT inaccuracy = utc.inacchi;
  inaccuracy <<= 32;
  inaccuracy |= utc.inacclo;

  ACE_NEW_THROW_EX (uto,
                    TAO_UTO (utc.time,
                             inaccuracy,
                             utc.tdf),
                    CORBA::NO_MEMORY ());
  return uto->_this ();
}


Friends And Related Function Documentation

friend class Timer_Helper [friend]

Helper class to help in the updation of time.

Definition at line 47 of file TAO_Time_Service_Clerk.h.


Member Data Documentation

This is a friend class that inherits from the Event Handler class. The handle_timeout method of this class is scheduled for periodic invocation by the reactor. This method, in turn, updates the clerks notion of time. Using this class obviates the need for the clerk to multiple inherit from the servant base as well as the event handler.

Definition at line 125 of file TAO_Time_Service_Clerk.h.

TimeBase::InaccuracyT TAO_Time_Service_Clerk::inaccuracy_ [private]

Inaccuracy in the time.

Definition at line 109 of file TAO_Time_Service_Clerk.h.

Set of server Time Server IORs.

Definition at line 112 of file TAO_Time_Service_Clerk.h.

Clerk's notion of time.

Definition at line 101 of file TAO_Time_Service_Clerk.h.

Time displacement factor in minutes.

Definition at line 106 of file TAO_Time_Service_Clerk.h.

Time when last global synchronization was done.

Definition at line 115 of file TAO_Time_Service_Clerk.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines