summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Time/Timer_Helper.h
blob: 20f0ef93545f3faf4e82794b6182d756eb5b9b87 (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
// -*- C++ -*-
// $Id$

// ============================================================================
//
// = LIBRARY
//    TAO/orbsvcs/Time_Service
//
// = FILENAME
//    Timer_Helper.cpp
//
// = DESCRIPTION
//    This class is registered with the Reactor and extends from the
//    event handler.It is a friend of the TAO_Time_Service_Clerk and
//    helps to update the clerk's notion of globally synchronized
//    time. This class obviates the need for multiple inheritance in
//    the clerk.
//
// = AUTHOR
//    Vishal Kachroo  <vishal@cs.wustl.edu>
//
// ============================================================================

#ifndef TIMER_HELPER_H
#define	TIMER_HELPER_H

#include "ace/Event_Handler.h"
#include "ace/Containers.h"

#include "orbsvcs/TimeServiceS.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

class TAO_Time_Service_Clerk;

class TAO_ORBSVCS_Export Timer_Helper : public ACE_Event_Handler
{
  // = TITLE
  //    Timer Helper for the clerk.
  //
  // = DESCRIPTION
  //    The handle timeout method of this class is called periodically
  //    by the reactor. This method updates the clerk's notion of
  //    globally synchronized time by contacting the various Time
  //    Servers.
public:
  // = Initialization and termination methods.
  Timer_Helper (void);
  // Constructor.

  ~Timer_Helper (void);
  // Destructor.

  Timer_Helper (TAO_Time_Service_Clerk *clerk);
  // Constructor that sets the clerk.

  int handle_timeout (const ACE_Time_Value &time,
		      const void *arg);
  // This method is called periodically by the Reactor to update the
  // clerk's time.

protected:
  TAO_Time_Service_Clerk *clerk_;
  // Clerk's instance that this class helps to update time.

  typedef ACE_Array_Base<CosTime::TimeService_var> IORS;
  // The set of server IORs.
};

#endif /* TIMER_HELPER_H */