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
|
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_PROXY_RESOLUTION_PROXY_CONFIG_SERVICE_H_
#define NET_PROXY_RESOLUTION_PROXY_CONFIG_SERVICE_H_
#include <memory>
#include "base/memory/scoped_refptr.h"
#include "net/base/net_export.h"
namespace base {
class SequencedTaskRunner;
} // namespace base
namespace net {
class ProxyConfigWithAnnotation;
// Service for watching when the proxy settings have changed.
class NET_EXPORT ProxyConfigService {
public:
// Indicates whether proxy configuration is valid, and if not, why.
enum ConfigAvailability {
// Configuration is pending, observers will be notified later.
CONFIG_PENDING,
// Configuration is present and valid.
CONFIG_VALID,
// No configuration is set.
CONFIG_UNSET
};
// Observer for being notified when the proxy settings have changed.
class NET_EXPORT Observer {
public:
virtual ~Observer() = default;
// Notification callback that should be invoked by ProxyConfigService
// implementors whenever the configuration changes. |availability| indicates
// the new availability status and can be CONFIG_UNSET or CONFIG_VALID (in
// which case |config| contains the configuration). Implementors must not
// pass CONFIG_PENDING.
virtual void OnProxyConfigChanged(const ProxyConfigWithAnnotation& config,
ConfigAvailability availability) = 0;
};
virtual ~ProxyConfigService() = default;
// Adds/Removes an observer that will be called whenever the proxy
// configuration has changed.
virtual void AddObserver(Observer* observer) = 0;
virtual void RemoveObserver(Observer* observer) = 0;
// Gets the most recent availability status. If a configuration is present,
// the proxy configuration is written to |config| and CONFIG_VALID is
// returned. Returns CONFIG_PENDING if it is not available yet. In this case,
// it is guaranteed that subscribed observers will be notified of a change at
// some point in the future once the configuration is available.
// Note that to avoid re-entrancy problems, implementations should not
// dispatch any change notifications from within this function.
virtual ConfigAvailability GetLatestProxyConfig(
ProxyConfigWithAnnotation* config) = 0;
// ConfiguredProxyResolutionService will call this periodically during periods
// of activity. It can be used as a signal for polling-based implementations.
//
// Note that this is purely used as an optimization -- polling
// implementations could simply set a global timer that goes off every
// X seconds at which point they check for changes. However that has
// the disadvantage of doing continuous work even during idle periods.
virtual void OnLazyPoll() {}
// True if this implementation uses polling, i.e. needs `OnLazyPoll` to be
// called.
virtual bool UsesPolling();
// Creates a config service appropriate for this platform that fetches the
// system proxy settings. |main_task_runner| is the sequence where the
// consumer of the ProxyConfigService will live.
static std::unique_ptr<ProxyConfigService> CreateSystemProxyConfigService(
scoped_refptr<base::SequencedTaskRunner> main_task_runner);
};
} // namespace net
#endif // NET_PROXY_RESOLUTION_PROXY_CONFIG_SERVICE_H_
|
