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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
// Copyright 2017 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_PUBLIC_BACKGROUND_SERVICE_LOGGER_H_
#define COMPONENTS_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE_LOGGER_H_
#include "base/component_export.h"
#include "base/values.h"
namespace download {
// A helper class to expose internals of the downloads system to a logging
// component and/or debug UI.
class COMPONENT_EXPORT(COMPONENTS_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE) Logger {
public:
// An Observer to be notified of any DownloadService changes.
class Observer {
public:
virtual ~Observer() = default;
// Called whenever the status of the Download Service changes. This will
// have the same data as |GetServiceStatus()|.
virtual void OnServiceStatusChanged(
const base::Value::Dict& service_status) = 0;
// Called when the Download Service is able to notify observers of the list
// of currently tracked downloads. This will have the same data as
// |GetServiceDownloads()|.
virtual void OnServiceDownloadsAvailable(
const base::Value::List& service_downloads) = 0;
// Called when the state of a download has changed. Format of
// |service_download| is the same as |GetServiceDownloads()|, except not a
// list.
virtual void OnServiceDownloadChanged(
const base::Value::Dict& service_download) = 0;
// Called when a download has failed. Format of |service_download| is the
// same as |GetServiceDownloads()|, except not a list.
virtual void OnServiceDownloadFailed(
const base::Value::Dict& service_download) = 0;
// Called when a request is made of the download service. Format of
// |service_request| is:
// {
// client: string,
// guid: string,
// result: [ACCEPTED,BACKOFF,UNEXPECTED_CLIENT,UNEXPECTED_GUID,
// CLIENT_CANCELLED,INTERNAL_ERROR]
// }
virtual void OnServiceRequestMade(
const base::Value::Dict& service_request) = 0;
};
Logger(const Logger&) = delete;
Logger& operator=(const Logger&) = delete;
virtual ~Logger() = default;
virtual void AddObserver(Observer* observer) = 0;
virtual void RemoveObserver(Observer* observer) = 0;
// Returns the current status of the Download Service. The serialized format
// will be:
// {
// serviceState: string [CREATED,INITIALIZING,READY,RECOVERING,UNAVAILABLE],
// modelStatus: string [OK,BAD,UNKNOWN],
// driverStatus: string [OK,BAD,UNKNOWN],
// fileMonitorStatus: string [OK,BAD,UNKNOWN]
// }
virtual base::Value::Dict GetServiceStatus() = 0;
// Returns the current list of downloads the Download Service is aware of.
// The serialized format will be a list of:
// {
// client: string,
// guid: string,
// state: string [NEW,AVAILABLE,ACTIVE,PAUSED,COMPLETE],
// url: string,
// file_path: optional string,
// bytes_downloaded: number,
// result: optional [SUCCEED,FAIL,ABORT,TIMEOUT,UNKNOWNL,CANCEL,
// OUT_OF_RETRIES,OUT_OF_RESUMPTIONS],
// driver: {
// state: string [IN_PROGRESS,COMPLETE,CANCELLED,INTERRUPTED],
// paused: boolean,
// done: boolean,
// }
// }
virtual base::Value::List GetServiceDownloads() = 0;
protected:
Logger() = default;
};
} // namespace download
#endif // COMPONENTS_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE_LOGGER_H_
|
