blob: 1f5fa51f64acf095ea3abee3f4e2380269556ab3 [file] [log] [blame]
// Copyright (c) 2012 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 CHROME_SERVICE_SERVICE_PROCESS_H_
#define CHROME_SERVICE_SERVICE_PROCESS_H_
#include <string>
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/threading/thread.h"
#include "chrome/service/cloud_print/cloud_print_proxy.h"
#include "chrome/service/service_ipc_server.h"
class ServiceProcessPrefs;
class ServiceURLRequestContextGetter;
class ServiceProcessState;
namespace base {
class CommandLine;
class SequencedWorkerPool;
class WaitableEvent;
}
namespace net {
class NetworkChangeNotifier;
}
// The ServiceProcess does not inherit from ChildProcess because this
// process can live independently of the browser process.
// ServiceProcess Design Notes
// https://sites.google.com/a/chromium.org/dev/developers/design-documents/service-processes
class ServiceProcess : public ServiceIPCServer::Client,
public cloud_print::CloudPrintProxy::Client,
public cloud_print::CloudPrintProxy::Provider {
public:
ServiceProcess();
~ServiceProcess() override;
// Initialize the ServiceProcess with the message loop that it should run on.
// ServiceProcess takes ownership of |state|.
bool Initialize(base::MessageLoopForUI* message_loop,
const base::CommandLine& command_line,
ServiceProcessState* state);
bool Teardown();
// Returns the SingleThreadTaskRunner for the service process io thread (used
// for e.g. network requests and IPC). Returns null before Initialize is
// called and after Teardown is called.
scoped_refptr<base::SingleThreadTaskRunner> io_task_runner() {
return io_thread_ ? io_thread_->task_runner() : nullptr;
}
// Returns the SingleThreadTaskRunner for the service process file thread.
// Used to do I/O operations (not network requests or even file: URL requests)
// to avoid blocking the main thread. Returns null before Initialize is
// called and after Teardown is called.
scoped_refptr<base::SingleThreadTaskRunner> file_task_runner() {
return file_thread_ ? file_thread_->task_runner() : nullptr;
}
// A global event object that is signalled when the main thread's message
// loop exits. This gives background threads a way to observe the main
// thread shutting down.
base::WaitableEvent* GetShutdownEventForTesting() {
return &shutdown_event_;
}
// Shuts down the service process.
void Shutdown();
// ServiceIPCServer::Client implementation.
void OnShutdown() override;
void OnUpdateAvailable() override;
bool OnIPCClientDisconnect() override;
// CloudPrintProxy::Provider implementation.
cloud_print::CloudPrintProxy* GetCloudPrintProxy() override;
// CloudPrintProxy::Client implementation.
void OnCloudPrintProxyEnabled(bool persist_state) override;
void OnCloudPrintProxyDisabled(bool persist_state) override;
ServiceURLRequestContextGetter* GetServiceURLRequestContextGetter();
private:
friend class TestServiceProcess;
// Schedule a call to ShutdownIfNeeded.
void ScheduleShutdownCheck();
// Shuts down the process if no services are enabled and no IPC client is
// connected.
void ShutdownIfNeeded();
// Called exactly ONCE per process instance for each service that gets
// enabled in this process.
void OnServiceEnabled();
// Called exactly ONCE per process instance for each service that gets
// disabled in this process (note that shutdown != disabled).
void OnServiceDisabled();
// Terminate forces the service process to quit.
void Terminate();
scoped_ptr<net::NetworkChangeNotifier> network_change_notifier_;
scoped_ptr<base::Thread> io_thread_;
scoped_ptr<base::Thread> file_thread_;
scoped_refptr<base::SequencedWorkerPool> blocking_pool_;
scoped_ptr<cloud_print::CloudPrintProxy> cloud_print_proxy_;
scoped_ptr<ServiceProcessPrefs> service_prefs_;
scoped_ptr<ServiceIPCServer> ipc_server_;
scoped_ptr<ServiceProcessState> service_process_state_;
// An event that will be signalled when we shutdown.
base::WaitableEvent shutdown_event_;
// Pointer to the main message loop that host this object.
base::MessageLoop* main_message_loop_;
// Count of currently enabled services in this process.
int enabled_services_;
// Speficies whether a product update is available.
bool update_available_;
scoped_refptr<ServiceURLRequestContextGetter> request_context_getter_;
DISALLOW_COPY_AND_ASSIGN(ServiceProcess);
};
extern ServiceProcess* g_service_process;
#endif // CHROME_SERVICE_SERVICE_PROCESS_H_