File: heartbeat_service_client.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (65 lines) | stat: -rw-r--r-- 2,484 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef REMOTING_HOST_HEARTBEAT_SERVICE_CLIENT_H_
#define REMOTING_HOST_HEARTBEAT_SERVICE_CLIENT_H_

#include <optional>
#include <string>

#include "base/functional/callback.h"

namespace base {
class TimeDelta;
}  // namespace base

namespace remoting {

class HttpStatus;

// HeartbeatServiceClient is an interface which is used by the HeartbeatSender
// to target a specific backend API and hide implementation details of that API
// from the HeartbeatSender class.
class HeartbeatServiceClient {
 public:
  // |status| will be valid for all invocations, the other args must be checked
  // as they may not be populated for all APIs.
  using HeartbeatResponseCallback =
      base::OnceCallback<void(const HttpStatus& status,
                              std::optional<base::TimeDelta> wait_interval,
                              const std::string& primary_user_email,
                              std::optional<bool> require_session_authorization,
                              std::optional<bool> use_lite_heartbeat)>;

  HeartbeatServiceClient();

  HeartbeatServiceClient(const HeartbeatServiceClient&) = delete;
  HeartbeatServiceClient& operator=(const HeartbeatServiceClient&) = delete;

  virtual ~HeartbeatServiceClient();

  // Updates a set of attributes for |directory_id_| based on the args provided
  // as well as inherent properties (e.g. host version) when
  // |is_initial_heartbeat| is set.
  // TODO: joedow - Refactor this when we no longer support the LegacyHeartbeat
  // service API.
  virtual void SendFullHeartbeat(bool is_initial_heartbeat,
                                 std::optional<std::string> signaling_id,
                                 std::optional<std::string> offline_reason,
                                 HeartbeatResponseCallback callback) = 0;

  // Updates the last_seen_time for |directory_id_| in the Directory service.
  virtual void SendLiteHeartbeat(HeartbeatResponseCallback callback) = 0;

  // Cancels any pending service requests.
  virtual void CancelPendingRequests() = 0;

  // Common error handler for all HeartbeatServiceClients. Should only be called
  // if the status response for a heartbeat is an error.
  void OnError(HeartbeatResponseCallback callback, const HttpStatus& status);
};

}  // namespace remoting

#endif  // REMOTING_HOST_HEARTBEAT_SERVICE_CLIENT_H_