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
66
67
68
69
70
71
72
73
74
75
76
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_BACKGROUND_TASK_SCHEDULER_BACKGROUND_TASK_H_
#define COMPONENTS_BACKGROUND_TASK_SCHEDULER_BACKGROUND_TASK_H_
#include "base/functional/callback.h"
#include "components/background_task_scheduler/task_parameters.h"
#include "components/keyed_service/core/simple_factory_key.h"
namespace content {
class BrowserContext;
} // namespace content
namespace background_task {
// Boolean parameter indicates whether the task needs to be rescheduled.
using TaskFinishedCallback = base::OnceCallback<void(bool)>;
// Entry point for callbacks from BackgroundTaskScheduler. Any classes
// implementing this interface must have a public constructor which takes no
// arguments. The callback will be executed on the main thread.
class BackgroundTask {
public:
// The following two methods represent the callback from
// BackgroundTaskScheduler when your task should start processing. It is
// invoked on the main thread, and after your task finishes, you should
// run the |callback|, with a boolean parameter indicating whether the task
// needs to be rescheduled. While this method is running the system holds a
// wakelock and the wakelock is not released until either the |callback| is
// invoked, or the system calls onStopTask. Depending on whether Chrome is
// running in service manager only mode or full browser mode, one or both of
// the following methods are invoked.
// Callback invoked when chrome is running in service manager only mode. User
// can start executing the task here or save the params and wait till full
// browser is started and OnFullBrowserLoaded is invoked.
virtual void OnStartTaskInReducedMode(const TaskParameters& task_params,
TaskFinishedCallback callback,
SimpleFactoryKey* key) {}
// Callback invoked when Chrome is running in full browser mode. This is
// invoked only if the chrome was started in full browser mode.
virtual void OnStartTaskWithFullBrowser(
const TaskParameters& task_params,
TaskFinishedCallback callback,
content::BrowserContext* browser_context) {}
// Callback invoked whenever the full browser starts after starting first in
// service manager only mode.
virtual void OnFullBrowserLoaded(content::BrowserContext* browser_context) {}
// Callback from BackgroundTaskScheduler when the system has determined that
// the execution of the task must stop immediately, even before the
// TaskFinishedCallback has been invoked. This will typically happen whenever
// the required conditions for the task are no longer met. See TaskInfo for
// more details. A wakelock is held by the system while this callback is
// invoked, and immediately released after this method returns. If true is
// returned from this method, the task will be rescheduled, for false, the
// task will not be rescheduled.
virtual bool OnStopTask(const TaskParameters& task_params) = 0;
BackgroundTask(const BackgroundTask&) = delete;
BackgroundTask& operator=(const BackgroundTask&) = delete;
// Destructor.
virtual ~BackgroundTask() = default;
protected:
BackgroundTask() = default;
};
} // namespace background_task
#endif // COMPONENTS_BACKGROUND_TASK_SCHEDULER_BACKGROUND_TASK_H_
|
