1a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved.
2a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
3a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// found in the LICENSE file.
4a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
5a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#ifndef CONTENT_BROWSER_STARTUP_TASK_RUNNER_H_
6a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#define CONTENT_BROWSER_STARTUP_TASK_RUNNER_H_
7a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
8a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#include <list>
9a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
10a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#include "base/callback.h"
11a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#include "base/single_thread_task_runner.h"
12a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
13a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#include "build/build_config.h"
14a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
15a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#include "content/public/browser/browser_main_runner.h"
16a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
17a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)namespace content {
18a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
19a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// A startup task is a void function returning the status on completion.
20a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// a status of > 0 indicates a failure, and that no further startup tasks should
21a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// be run.
22a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)typedef base::Callback<int(void)> StartupTask;
23a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
24a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// This class runs startup tasks. The tasks are either run immediately inline,
25a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// or are queued one at a time on the UI thread's message loop. If the events
26a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// are queued, UI events that are received during startup will be acted upon
27a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// between startup tasks. The motivation for this is that, on targets where the
28a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// UI is already started, it allows us to keep the UI responsive during startup.
29a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)//
30a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// Note that this differs from a SingleThreadedTaskRunner in that there may be
31a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// no opportunity to handle UI events between the tasks of a
32a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// SingleThreadedTaskRunner.
33a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
34424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)class CONTENT_EXPORT StartupTaskRunner {
35a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
36a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) public:
37a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  // Constructor: Note that |startup_complete_callback| is optional. If it is
38a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  // not null it will be called once all the startup tasks have run.
39424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  StartupTaskRunner(base::Callback<void(int)> startup_complete_callback,
40a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)                    scoped_refptr<base::SingleThreadTaskRunner> proxy);
41a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
42424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  ~StartupTaskRunner();
43424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)
44a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  // Add a task to the queue of startup tasks to be run.
45424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  void AddTask(StartupTask& callback);
46424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)
47424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  // Start running the tasks asynchronously.
48424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  void StartRunningTasksAsync();
49a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
50424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  // Run all tasks, or all remaining tasks, synchronously
51424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  void RunAllTasksNow();
52a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
53a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) private:
54a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  friend class base::RefCounted<StartupTaskRunner>;
55a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
56a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  std::list<StartupTask> task_list_;
57a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  void WrappedTask();
58a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
59a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  base::Callback<void(int)> startup_complete_callback_;
60a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  scoped_refptr<base::SingleThreadTaskRunner> proxy_;
61a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
62a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  DISALLOW_COPY_AND_ASSIGN(StartupTaskRunner);
63a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)};
64a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
65a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)}  // namespace content
66a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#endif  // CONTENT_BROWSER_STARTUP_TASK_RUNNER_H_
67