summaryrefslogtreecommitdiff
path: root/ACE/ace/Reactor_Timer_Interface.h
blob: 71202e0ccf7c042fc474a3dd214eac441f41caa4 (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++ -*-

//=============================================================================
/**
 *  @file    Reactor_Timer_Interface.h
 *
 *  @author Irfan Pyarali <irfan@oomworks.com>
 */
//=============================================================================

#ifndef ACE_REACTOR_TIMER_INTERFACE_H
#define ACE_REACTOR_TIMER_INTERFACE_H

#include /**/ "ace/pre.h"

#include "ace/Time_Value.h"

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

ACE_BEGIN_VERSIONED_NAMESPACE_DECL

class ACE_Event_Handler;

/**
 * @class ACE_Reactor_Timer_Interface
 *
 * @brief Interface for timer related methods on the Reactor.
 */
class ACE_Export ACE_Reactor_Timer_Interface
{
public:
  virtual ~ACE_Reactor_Timer_Interface ();

  virtual long schedule_timer (ACE_Event_Handler *event_handler,
                               const void *arg,
                               const ACE_Time_Value &delay,
                               const ACE_Time_Value &interval = ACE_Time_Value::zero) = 0;

  template<class Rep1, class Period1, class Rep2 = int, class Period2 = std::ratio<1>>
  long schedule_timer (ACE_Event_Handler *event_handler,
                       const void *arg,
                       const std::chrono::duration<Rep1, Period1>& delay,
                       const std::chrono::duration<Rep2, Period2>& interval = std::chrono::duration<Rep2, Period2>::zero ())
  {
    ACE_Time_Value const tv_delay (delay);
    ACE_Time_Value const tv_interval (interval);
    return this->schedule_timer (event_handler, arg, tv_delay, tv_interval);
  }

  virtual int reset_timer_interval (long timer_id,
                                    const ACE_Time_Value &interval) = 0;

  template<class Rep, class Period>
  int reset_timer_interval (long timer_id,
                            const std::chrono::duration<Rep, Period>& interval)
  {
    ACE_Time_Value const tv_interval (interval);
    return this->reset_timer_interval (timer_id, tv_interval);
  }

  virtual int cancel_timer (long timer_id,
                            const void **arg = 0,
                            int dont_call_handle_close = 1) = 0;

  virtual int cancel_timer (ACE_Event_Handler *event_handler,
                            int dont_call_handle_close = 1) = 0;

};

ACE_END_VERSIONED_NAMESPACE_DECL

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

#endif /* ACE_REACTOR_TIMER_INTERFACE_H */