File: background_download_task_helper.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 (64 lines) | stat: -rw-r--r-- 2,570 bytes parent folder | download | duplicates (11)
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
// Copyright 2021 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_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_IOS_BACKGROUND_DOWNLOAD_TASK_HELPER_H_
#define COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_IOS_BACKGROUND_DOWNLOAD_TASK_HELPER_H_

#include <memory>
#include <string>

#include "base/functional/callback.h"

namespace base {
class FilePath;
}  // namespace base

namespace download {
struct RequestParams;
struct SchedulingParams;

// Helper class to perform background download with iOS platform API.
// Notes:
// 1. Needs to debug on real device, with Xcode debugger detached to make the
// device enter background session.
// 2. If the user kills the app in multitask window, the session is deleted, the
// app will not be waked up to resume the download.
class BackgroundDownloadTaskHelper {
 public:
  // Callback with whether download is succeeded and the file path and the file
  // size of the succeeded download.
  using CompletionCallback =
      base::OnceCallback<void(bool, const base::FilePath&, int64_t)>;
  // Callback with number of bytes downloaded.
  using UpdateCallback = base::RepeatingCallback<void(int64_t)>;
  static std::unique_ptr<BackgroundDownloadTaskHelper> Create();

  // For test only:
  // Ignore the SSL errors for request https://127.0.0.1/...
  // that are used to access EmbeddedTestServer.
  // This will allow features that use BackgroundDownloadService
  // to be tested using EmbeddedTestServer.
  static void SetIgnoreLocalSSLErrorForTesting(bool ignore);

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

  // Starts a download.
  virtual void StartDownload(const std::string& guid,
                             const base::FilePath& target_path,
                             const RequestParams& request_params,
                             const SchedulingParams& scheduling_params,
                             CompletionCallback completion_callback,
                             UpdateCallback update_callback) = 0;

  // Called to handle events for background download.
  virtual void HandleEventsForBackgroundURLSession(
      base::OnceClosure completion_handler) {}
};

}  // namespace download

#endif  // COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_IOS_BACKGROUND_DOWNLOAD_TASK_HELPER_H_