summaryrefslogtreecommitdiff
path: root/src/components/connection_handler/include/connection_handler/heartbeat_monitor.h
blob: d5ee0946ffc8a98f10e6d4cc99b97958bc431e77 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * Copyright (c) 2013, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef SRC_COMPONENTS_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_HEARTBEAT_MONITOR_H_
#define SRC_COMPONENTS_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_HEARTBEAT_MONITOR_H_

#include <stdint.h>
#include <map>

#include "utils/threads/thread.h"
#include "utils/threads/thread_delegate.h"
#include "utils/date_time.h"
#include "utils/macro.h"
#include "utils/lock.h"

namespace connection_handler {

class Connection;

/*
 * Starts hearbeat timer for session and when it elapses closes it
 */
class HeartBeatMonitor : public threads::ThreadDelegate {
 public:
  HeartBeatMonitor(uint32_t heartbeat_timeout_mseconds, Connection* connection);

  /**
   * Thread procedure.
   */
  virtual void threadMain();

  /**
   * \brief add and remove session
   */
  void AddSession(uint8_t session_id);
  void RemoveSession(uint8_t session_id);

  /**
  * \brief Resets timer preventing session from being killed
   */
  void KeepAlive(uint8_t session_id);

  /**
   * @brief Check is heartbeat monitoring started for specified session
   * @param  session_id session id
   * @return returns true if heartbeat monitoring started for specified session
   * otherwise returns false
   */
  bool IsSessionHeartbeatTracked(const uint8_t session_id) const;

  /**
   * \brief Thread exit procedure.
   */
  virtual void exitThreadMain();
  /**
   * @brief Update heart beat timeout for session
   * @param timeout contains timeout for updating
   * @param session_id contain id session for which update timeout
   * timeout
   **/
  void set_heartbeat_timeout_milliseconds(uint32_t timeout, uint8_t session_id);

 private:
  // \brief Heartbeat timeout
  uint32_t default_heartbeat_timeout_;
  // \brief Connection that must be closed when timeout elapsed
  Connection* connection_;

  // Default HeartBeat cycle timeout (in miliseconds)
  static const int32_t kDefaultCycleTimeout = 100;

  class SessionState {
   public:
    explicit SessionState(uint32_t heartbeat_timeout_mseconds = 0);
    void UpdateTimeout(uint32_t heartbeat_timeout_mseconds);
    void PrepareToClose();
    bool IsReadyToClose() const;
    void KeepAlive();
    bool HasTimeoutElapsed();

   private:
    void RefreshExpiration();

    uint32_t heartbeat_timeout_mseconds_;
    TimevalStruct heartbeat_expiration_;
    bool is_heartbeat_sent_;
  };

  // \brief monitored sessions collection

  typedef std::map<uint8_t, SessionState> SessionMap;
  SessionMap sessions_;

  mutable sync_primitives::Lock sessions_list_lock_;  // recurcive
  sync_primitives::Lock main_thread_lock_;
  mutable sync_primitives::Lock heartbeat_timeout_seconds_lock_;
  sync_primitives::ConditionalVariable heartbeat_monitor_;

  volatile bool run_;

  void Process();

  DISALLOW_COPY_AND_ASSIGN(HeartBeatMonitor);
};

}  // namespace connection_handler

#endif  // SRC_COMPONENTS_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_HEARTBEAT_MONITOR_H_