Reporting of policy errors via host-offline-reason: part 3

remoting/host/host_signaling_manager.h

Index: remoting/host/host_signaling_manager.h
diff --git a/remoting/host/host_signaling_manager.h b/remoting/host/host_signaling_manager.h
new file mode 100644
index 0000000000000000000000000000000000000000..92f9c8596ef315bd13fd0f9ad533bf317ab42347
--- /dev/null
+++ b/remoting/host/host_signaling_manager.h
@@ -0,0 +1,111 @@
+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef REMOTING_HOST_HOST_SIGNALING_MANAGER_H_
+#define REMOTING_HOST_HOST_SIGNALING_MANAGER_H_
+
+#include <string>
+
+#include "base/callback.h"
+#include "base/memory/scoped_ptr.h"
+#include "remoting/base/auto_thread_task_runner.h"
+#include "remoting/base/rsa_key_pair.h"
+#include "remoting/host/heartbeat_sender.h"
+#include "remoting/signaling/xmpp_signal_strategy.h"
+
+namespace base {
+class TimeDelta;
+}
+
+namespace net {
+class NetworkChangeNotifier;
+}
+
+namespace remoting {
+
+class ChromotingHostContext;
+class DnsBlackholeChecker;
+class HeartbeatSender;
+class OAuthTokenGetter;
+class SignalStrategy;
+class SignalingConnector;
+
+// HostSignalingManager has 2 functions:
+// 1. Keep sending regular heartbeats to the service.
+// 2. Keep the host process alive while sending host-offline-reason heartbeat.
+class HostSignalingManager {
+ public:
+  // TODO(lukasza): Refactor to limit the number of parameters below.
+  // Probably necessitates refactoring HostProcess to extract a new
+  // class to read and store config/policy/cmdline values.
+  static scoped_ptr<HostSignalingManager> Create(
+      // Invoked after the first successful heartbeat.
+      const base::Closure& on_heartbeat_successful_callback,
+
+      // Invoked when the host ID is permanently not recognized by the server.
+      const base::Closure& on_unknown_host_id_error_callback,
+
+      // Invoked when authentication fails.
+      const base::Closure& on_auth_failed_callback,
+
+      const ChromotingHostContext& host_context,
+      const XmppSignalStrategy::XmppServerConfig& xmpp_server_config,
+      const std::string& talkgadget_prefix_policy,
+      const std::string& host_id,
+      const scoped_refptr<const RsaKeyPair>& host_key_pair,
+
+      // Directory Bot's JID - i.e. "remoting@bot.talk.google.com".
+      const std::string& directory_bot_jid,
+
+      const std::string& oauth_refresh_token,
+
+      // Controls which API key gets used.
+      bool use_service_account);
+
+  ~HostSignalingManager();

[Wez, 2014/12/19 22:05:37]

What is the behaviour of this class wrt the offline reason if it is explicitly
deleted by the caller rather than via SendOfflineReason, below?

[Łukasz Anforowicz, 2015/01/07 01:24:04]

The HostSignalingManager gets deleted (without a call to
SendHostOfflineReasonAndDelete) during normal (non-error-related) shutdown of
HostProcess.  In this case we simply close the connection.

If HeartbeatSender::SendHostOfflineReason were called, without a callback that
ends up shutting down the process (as in the
HostSignalingManager::SendHostOfflineReasonAndDelete case), then each subsequent
heartbeat will include host-offline-reason.  This seems ok.

+
+  // Get the SignalStrategy to use for talking to the Chromoting bot.
+  // Returned SignalStrategy remains owned by the HostSignalingManager.
+  SignalStrategy* signal_strategy() { return signal_strategy_.get(); }
+
+  // Kicks off sending a heartbeat containing a host-offline-reason attribute.
+  //
+  // Will delete |this| once either the bot acks receiving the
+  // |host_offline_reason|, or the |timeout| is reached.  Deleting
+  // |this| will release |network_task_runner_| and allow the host
+  // process to exit.
+  void SendHostOfflineReasonAndDelete(const std::string& host_offline_reason,
+                                      const base::TimeDelta& timeout);
+
+ private:
+  HostSignalingManager(
+      scoped_refptr<AutoThreadTaskRunner> network_task_runner,
+      scoped_ptr<net::NetworkChangeNotifier> network_change_notifier,
+      scoped_ptr<SignalStrategy> signal_strategy,
+      scoped_ptr<SignalingConnector> signaling_connector,
+      scoped_ptr<HeartbeatSender> heartbeat_sender);
+
+  void OnHostOfflineReasonAck(bool success);
+
+  // Order of fields below is important for destroying them in the right order.
+  // - |heartbeat_sender_| and |signaling_connector_| have to be destroyed
+  //   before |signal_strategy_| because their destructors need to call
+  //   signal_strategy_->RemoveListener(this)
+  // - |signaling_connector_| has to be destroyed before
+  //   |network_change_notifier_| because its destructor needs to deregister
+  //   network change notifications
+  // - |network_task_runner_| keeps the process alive and is therefore
+  //   used by all the other fields and has to be destroyed last.
+  scoped_refptr<AutoThreadTaskRunner> network_task_runner_;
+  scoped_ptr<net::NetworkChangeNotifier> network_change_notifier_;
+  scoped_ptr<SignalStrategy> signal_strategy_;
+  scoped_ptr<SignalingConnector> signaling_connector_;
+  scoped_ptr<HeartbeatSender> heartbeat_sender_;
+
+  DISALLOW_COPY_AND_ASSIGN(HostSignalingManager);
+};
+
+}  // namespace remoting
+
+#endif  // REMOTING_HOST_HOST_SIGNALING_MANAGER_H_