blob: 391a2c335830edd3e3c774be04e145ea87ceec92 [file] [log] [blame]
// Copyright 2016 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.
#include <memory>
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "net/url_request/url_request_context_getter.h"
#include "remoting/base/auto_thread.h"
#include "remoting/base/telemetry_log_writer.h"
namespace base {
class MessageLoopForUI;
template <typename T>
struct DefaultSingletonTraits;
} // namespace base
// Houses the global resources on which the Chromoting components run
// (e.g. message loops and task runners).
namespace remoting {
class ChromotingClientRuntime {
class Delegate {
virtual ~Delegate() {}
// RuntimeWillShutdown will be called on the delegate when the runtime
// enters into the destructor. This is a good time for the delegate to
// start shutting down on threads while they exist.
virtual void RuntimeWillShutdown() = 0;
// RuntimeDidShutdown will be called after task managers and threads
// have been stopped.
virtual void RuntimeDidShutdown() = 0;
// RequestAuthTokenForLogger is called when the logger is requesting
// and auth token and the delegate is set. It is expected that the
// delegate will give the logger and auth token on the network thread like:
// (network thread): runtime->log_writer()->SetAuthToken(token)
virtual void RequestAuthTokenForLogger() = 0;
static ChromotingClientRuntime* GetInstance();
void SetDelegate(ChromotingClientRuntime::Delegate* delegate);
scoped_refptr<AutoThreadTaskRunner> network_task_runner() {
return network_task_runner_;
scoped_refptr<AutoThreadTaskRunner> ui_task_runner() {
return ui_task_runner_;
scoped_refptr<AutoThreadTaskRunner> display_task_runner() {
return display_task_runner_;
scoped_refptr<AutoThreadTaskRunner> file_task_runner() {
return file_task_runner_;
scoped_refptr<net::URLRequestContextGetter> url_requester() {
return url_requester_;
// Must call and use log_writer on the network thread.
ChromotingEventLogWriter* log_writer();
virtual ~ChromotingClientRuntime();
void CreateLogWriter();
void RequestAuthTokenForLogger();
// Chromium code's connection to the app message loop. Once created the
// MessageLoop will live for the life of the program.
std::unique_ptr<base::MessageLoopForUI> ui_loop_;
// References to native threads.
scoped_refptr<AutoThreadTaskRunner> ui_task_runner_;
// TODO(nicholss): AutoThreads will be leaked because they depend on the main
// thread. We should update this class to use regular threads like the client
// plugin does.
// Longer term we should migrate most of these to background tasks except the
// network thread to TaskScheduler, removing the need for threads.
scoped_refptr<AutoThreadTaskRunner> display_task_runner_;
scoped_refptr<AutoThreadTaskRunner> network_task_runner_;
scoped_refptr<AutoThreadTaskRunner> file_task_runner_;
scoped_refptr<net::URLRequestContextGetter> url_requester_;
// For logging session stage changes and stats.
std::unique_ptr<TelemetryLogWriter> log_writer_;
ChromotingClientRuntime::Delegate* delegate_;
friend struct base::DefaultSingletonTraits<ChromotingClientRuntime>;
} // namespace remoting