File: notification_background_task_scheduler.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (60 lines) | stat: -rw-r--r-- 2,259 bytes parent folder | download | duplicates (7)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_PUBLIC_NOTIFICATION_BACKGROUND_TASK_SCHEDULER_H_
#define CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_PUBLIC_NOTIFICATION_BACKGROUND_TASK_SCHEDULER_H_

#include "base/functional/callback.h"
#include "base/time/time.h"
#include "chrome/browser/notifications/scheduler/public/notification_scheduler_types.h"

namespace notifications {

// Interface to schedule a background task on platform OS to run the
// notification scheduler job.
class NotificationBackgroundTaskScheduler {
 public:
  // Interface used to handle background task events.
  class Handler {
   public:
    using TaskFinishedCallback = base::OnceCallback<void(bool)>;

    Handler(const Handler&) = delete;
    Handler& operator=(const Handler&) = delete;
    // Called when the background task is started.
    virtual void OnStartTask(TaskFinishedCallback callback) = 0;

    // Called when the background task is stopped by the OS when it wants to
    // reallocate resources, our task is not finished yet in this case. The
    // handler implementation should explicitly decide whether the task should
    // be rescheduled and run later.
    virtual void OnStopTask() = 0;

   protected:
    Handler() = default;
    virtual ~Handler() = default;
  };

  // Schedules a background task in a time window between |window_start| and
  // |window_end|. This will update the current background task. Only one
  // background task exists for notification scheduler.
  virtual void Schedule(base::TimeDelta window_start,
                        base::TimeDelta window_end) = 0;

  // Cancels the background task.
  virtual void Cancel() = 0;

  NotificationBackgroundTaskScheduler(
      const NotificationBackgroundTaskScheduler&) = delete;
  NotificationBackgroundTaskScheduler& operator=(
      const NotificationBackgroundTaskScheduler&) = delete;
  virtual ~NotificationBackgroundTaskScheduler() = default;

 protected:
  NotificationBackgroundTaskScheduler() = default;
};

}  // namespace notifications

#endif  // CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_PUBLIC_NOTIFICATION_BACKGROUND_TASK_SCHEDULER_H_