| OLD | NEW |
|---|
| (Empty) |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
| 2 // Use of this source code is governed by a BSD-style license that can be | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | |
| 6 #define CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | |
| 7 | |
| 8 #include <string> | |
| 9 #include <vector> | |
| 10 #include "base/basictypes.h" | |
| 11 #include "base/compiler_specific.h" | |
| 12 #include "base/memory/scoped_ptr.h" | |
| 13 #include "base/memory/weak_ptr.h" | |
| 14 #include "base/prefs/pref_change_registrar.h" | |
| 15 #include "base/timer/timer.h" | |
| 16 #include "base/values.h" | |
| 17 #include "net/base/host_port_pair.h" | |
| 18 #include "net/http/http_server_properties.h" | |
| 19 #include "net/http/http_server_properties_impl.h" | |
| 20 | |
| 21 class PrefService; | |
| 22 | |
| 23 namespace user_prefs { | |
| 24 class PrefRegistrySyncable; | |
| 25 } | |
| 26 | |
| 27 namespace chrome_browser_net { | |
| 28 | |
| 29 //////////////////////////////////////////////////////////////////////////////// | |
| 30 // HttpServerPropertiesManager | |
| 31 | |
| 32 // The manager for creating and updating an HttpServerProperties (for example it | |
| 33 // tracks if a server supports SPDY or not). | |
| 34 // | |
| 35 // This class interacts with both the UI thread, where notifications of pref | |
| 36 // changes are received from, and the IO thread, which owns it (in the | |
| 37 // ProfileIOData) and it persists the changes from network stack that if a | |
| 38 // server supports SPDY or not. | |
| 39 // | |
| 40 // It must be constructed on the UI thread, to set up |ui_method_factory_| and | |
| 41 // the prefs listeners. | |
| 42 // | |
| 43 // ShutdownOnUIThread must be called from UI before destruction, to release | |
| 44 // the prefs listeners on the UI thread. This is done from ProfileIOData. | |
| 45 // | |
| 46 // Update tasks from the UI thread can post safely to the IO thread, since the | |
| 47 // destruction order of Profile and ProfileIOData guarantees that if this | |
| 48 // exists in UI, then a potential destruction on IO will come after any task | |
| 49 // posted to IO from that method on UI. This is used to go through IO before | |
| 50 // the actual update starts, and grab a WeakPtr. | |
| 51 class HttpServerPropertiesManager | |
| 52 : public net::HttpServerProperties { | |
| 53 public: | |
| 54 // Create an instance of the HttpServerPropertiesManager. The lifetime of the | |
| 55 // PrefService objects must be longer than that of the | |
| 56 // HttpServerPropertiesManager object. Must be constructed on the UI thread. | |
| 57 explicit HttpServerPropertiesManager(PrefService* pref_service); | |
| 58 virtual ~HttpServerPropertiesManager(); | |
| 59 | |
| 60 // Initialize |http_server_properties_impl_| and |io_method_factory_| on IO | |
| 61 // thread. It also posts a task to UI thread to get SPDY Server preferences | |
| 62 // from |pref_service_|. | |
| 63 void InitializeOnIOThread(); | |
| 64 | |
| 65 // Prepare for shutdown. Must be called on the UI thread, before destruction. | |
| 66 void ShutdownOnUIThread(); | |
| 67 | |
| 68 // Register |prefs| for properties managed here. | |
| 69 static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); | |
| 70 | |
| 71 // Helper function for unit tests to set the version in the dictionary. | |
| 72 static void SetVersion(base::DictionaryValue* http_server_properties_dict, | |
| 73 int version_number); | |
| 74 | |
| 75 // Deletes all data. Works asynchronously, but if a |completion| callback is | |
| 76 // provided, it will be fired on the UI thread when everything is done. | |
| 77 void Clear(const base::Closure& completion); | |
| 78 | |
| 79 // ---------------------------------- | |
| 80 // net::HttpServerProperties methods: | |
| 81 // ---------------------------------- | |
| 82 | |
| 83 // Gets a weak pointer for this object. | |
| 84 virtual base::WeakPtr<net::HttpServerProperties> GetWeakPtr() OVERRIDE; | |
| 85 | |
| 86 // Deletes all data. Works asynchronously. | |
| 87 virtual void Clear() OVERRIDE; | |
| 88 | |
| 89 // Returns true if |server| supports SPDY. Should only be called from IO | |
| 90 // thread. | |
| 91 virtual bool SupportsSpdy(const net::HostPortPair& server) OVERRIDE; | |
| 92 | |
| 93 // Add |server| as the SPDY server which supports SPDY protocol into the | |
| 94 // persisitent store. Should only be called from IO thread. | |
| 95 virtual void SetSupportsSpdy(const net::HostPortPair& server, | |
| 96 bool support_spdy) OVERRIDE; | |
| 97 | |
| 98 // Returns true if |server| has an Alternate-Protocol header. | |
| 99 virtual bool HasAlternateProtocol(const net::HostPortPair& server) OVERRIDE; | |
| 100 | |
| 101 // Returns the Alternate-Protocol and port for |server|. | |
| 102 // HasAlternateProtocol(server) must be true. | |
| 103 virtual net::AlternateProtocolInfo GetAlternateProtocol( | |
| 104 const net::HostPortPair& server) OVERRIDE; | |
| 105 | |
| 106 // Sets the Alternate-Protocol for |server|. | |
| 107 virtual void SetAlternateProtocol( | |
| 108 const net::HostPortPair& server, | |
| 109 uint16 alternate_port, | |
| 110 net::AlternateProtocol alternate_protocol, | |
| 111 double alternate_probability) OVERRIDE; | |
| 112 | |
| 113 // Sets the Alternate-Protocol for |server| to be BROKEN. | |
| 114 virtual void SetBrokenAlternateProtocol( | |
| 115 const net::HostPortPair& server) OVERRIDE; | |
| 116 | |
| 117 // Returns true if Alternate-Protocol for |server| was recently BROKEN. | |
| 118 virtual bool WasAlternateProtocolRecentlyBroken( | |
| 119 const net::HostPortPair& server) OVERRIDE; | |
| 120 | |
| 121 // Confirms that Alternate-Protocol for |server| is working. | |
| 122 virtual void ConfirmAlternateProtocol( | |
| 123 const net::HostPortPair& server) OVERRIDE; | |
| 124 | |
| 125 // Clears the Alternate-Protocol for |server|. | |
| 126 virtual void ClearAlternateProtocol(const net::HostPortPair& server) OVERRIDE; | |
| 127 | |
| 128 // Returns all Alternate-Protocol mappings. | |
| 129 virtual const net::AlternateProtocolMap& | |
| 130 alternate_protocol_map() const OVERRIDE; | |
| 131 | |
| 132 virtual void SetAlternateProtocolExperiment( | |
| 133 net::AlternateProtocolExperiment experiment) OVERRIDE; | |
| 134 | |
| 135 virtual void SetAlternateProtocolProbabilityThreshold( | |
| 136 double threshold) OVERRIDE; | |
| 137 | |
| 138 virtual net::AlternateProtocolExperiment GetAlternateProtocolExperiment() | |
| 139 const OVERRIDE; | |
| 140 | |
| 141 // Gets a reference to the SettingsMap stored for a host. | |
| 142 // If no settings are stored, returns an empty SettingsMap. | |
| 143 virtual const net::SettingsMap& GetSpdySettings( | |
| 144 const net::HostPortPair& host_port_pair) OVERRIDE; | |
| 145 | |
| 146 // Saves an individual SPDY setting for a host. Returns true if SPDY setting | |
| 147 // is to be persisted. | |
| 148 virtual bool SetSpdySetting(const net::HostPortPair& host_port_pair, | |
| 149 net::SpdySettingsIds id, | |
| 150 net::SpdySettingsFlags flags, | |
| 151 uint32 value) OVERRIDE; | |
| 152 | |
| 153 // Clears all SPDY settings for a host. | |
| 154 virtual void ClearSpdySettings( | |
| 155 const net::HostPortPair& host_port_pair) OVERRIDE; | |
| 156 | |
| 157 // Clears all SPDY settings for all hosts. | |
| 158 virtual void ClearAllSpdySettings() OVERRIDE; | |
| 159 | |
| 160 // Returns all SPDY persistent settings. | |
| 161 virtual const net::SpdySettingsMap& spdy_settings_map() const OVERRIDE; | |
| 162 | |
| 163 virtual void SetServerNetworkStats(const net::HostPortPair& host_port_pair, | |
| 164 NetworkStats stats) OVERRIDE; | |
| 165 | |
| 166 virtual const NetworkStats* GetServerNetworkStats( | |
| 167 const net::HostPortPair& host_port_pair) const OVERRIDE; | |
| 168 | |
| 169 protected: | |
| 170 // -------------------- | |
| 171 // SPDY related methods | |
| 172 | |
| 173 // These are used to delay updating of the cached data in | |
| 174 // |http_server_properties_impl_| while the preferences are changing, and | |
| 175 // execute only one update per simultaneous prefs changes. | |
| 176 void ScheduleUpdateCacheOnUI(); | |
| 177 | |
| 178 // Starts the timers to update the cached prefs. This are overridden in tests | |
| 179 // to prevent the delay. | |
| 180 virtual void StartCacheUpdateTimerOnUI(base::TimeDelta delay); | |
| 181 | |
| 182 // Update cached prefs in |http_server_properties_impl_| with data from | |
| 183 // preferences. It gets the data on UI thread and calls | |
| 184 // UpdateSpdyServersFromPrefsOnIO() to perform the update on IO thread. | |
| 185 virtual void UpdateCacheFromPrefsOnUI(); | |
| 186 | |
| 187 // Starts the update of cached prefs in |http_server_properties_impl_| on the | |
| 188 // IO thread. Protected for testing. | |
| 189 void UpdateCacheFromPrefsOnIO( | |
| 190 std::vector<std::string>* spdy_servers, | |
| 191 net::SpdySettingsMap* spdy_settings_map, | |
| 192 net::AlternateProtocolMap* alternate_protocol_map, | |
| 193 net::AlternateProtocolExperiment alternate_protocol_experiment, | |
| 194 bool detected_corrupted_prefs); | |
| 195 | |
| 196 // These are used to delay updating the preferences when cached data in | |
| 197 // |http_server_properties_impl_| is changing, and execute only one update per | |
| 198 // simultaneous spdy_servers or spdy_settings or alternate_protocol changes. | |
| 199 void ScheduleUpdatePrefsOnIO(); | |
| 200 | |
| 201 // Starts the timers to update the prefs from cache. This are overridden in | |
| 202 // tests to prevent the delay. | |
| 203 virtual void StartPrefsUpdateTimerOnIO(base::TimeDelta delay); | |
| 204 | |
| 205 // Update prefs::kHttpServerProperties in preferences with the cached data | |
| 206 // from |http_server_properties_impl_|. This gets the data on IO thread and | |
| 207 // posts a task (UpdatePrefsOnUI) to update the preferences UI thread. | |
| 208 void UpdatePrefsFromCacheOnIO(); | |
| 209 | |
| 210 // Same as above, but fires an optional |completion| callback on the UI thread | |
| 211 // when finished. Virtual for testing. | |
| 212 virtual void UpdatePrefsFromCacheOnIO(const base::Closure& completion); | |
| 213 | |
| 214 // Update prefs::kHttpServerProperties preferences on UI thread. Executes an | |
| 215 // optional |completion| callback when finished. Protected for testing. | |
| 216 void UpdatePrefsOnUI( | |
| 217 base::ListValue* spdy_server_list, | |
| 218 net::SpdySettingsMap* spdy_settings_map, | |
| 219 net::AlternateProtocolMap* alternate_protocol_map, | |
| 220 const base::Closure& completion); | |
| 221 | |
| 222 private: | |
| 223 void OnHttpServerPropertiesChanged(); | |
| 224 | |
| 225 // --------- | |
| 226 // UI thread | |
| 227 // --------- | |
| 228 | |
| 229 // Used to get |weak_ptr_| to self on the UI thread. | |
| 230 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > | |
| 231 ui_weak_ptr_factory_; | |
| 232 | |
| 233 base::WeakPtr<HttpServerPropertiesManager> ui_weak_ptr_; | |
| 234 | |
| 235 // Used to post cache update tasks. | |
| 236 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > | |
| 237 ui_cache_update_timer_; | |
| 238 | |
| 239 // Used to track the spdy servers changes. | |
| 240 PrefChangeRegistrar pref_change_registrar_; | |
| 241 PrefService* pref_service_; // Weak. | |
| 242 bool setting_prefs_; | |
| 243 | |
| 244 // --------- | |
| 245 // IO thread | |
| 246 // --------- | |
| 247 | |
| 248 // Used to get |weak_ptr_| to self on the IO thread. | |
| 249 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > | |
| 250 io_weak_ptr_factory_; | |
| 251 | |
| 252 // Used to post |prefs::kHttpServerProperties| pref update tasks. | |
| 253 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > | |
| 254 io_prefs_update_timer_; | |
| 255 | |
| 256 scoped_ptr<net::HttpServerPropertiesImpl> http_server_properties_impl_; | |
| 257 | |
| 258 DISALLOW_COPY_AND_ASSIGN(HttpServerPropertiesManager); | |
| 259 }; | |
| 260 | |
| 261 } // namespace chrome_browser_net | |
| 262 | |
| 263 #endif // CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 378823002:
Move http_server_properties_manager from chrome/browser/net to net/http. (Closed)
Base URL: https://chromium.googlesource.com/chromium/src.git@master