OLD | NEW |
---|---|
1 // Copyright 2017 The Chromium Authors. All rights reserved. | 1 // Copyright 2017 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ | 5 #ifndef CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ |
6 #define CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ | 6 #define CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ |
7 | 7 |
8 #include <memory> | 8 #include <memory> |
9 #include <set> | 9 #include <set> |
10 | 10 |
11 #include "base/memory/ref_counted.h" | |
11 #include "chrome/browser/media/router/discovery/dial/device_description_service. h" | 12 #include "chrome/browser/media/router/discovery/dial/device_description_service. h" |
12 #include "chrome/browser/media/router/discovery/dial/dial_registry.h" | 13 #include "chrome/browser/media/router/discovery/dial/dial_registry.h" |
13 #include "chrome/common/media_router/discovery/media_sink_internal.h" | 14 #include "chrome/common/media_router/discovery/media_sink_internal.h" |
14 #include "chrome/common/media_router/discovery/media_sink_service.h" | 15 #include "chrome/common/media_router/discovery/media_sink_service.h" |
16 #include "content/public/browser/browser_thread.h" | |
15 | 17 |
16 namespace media_router { | 18 namespace media_router { |
17 | 19 |
18 class DeviceDescriptionService; | 20 class DeviceDescriptionService; |
19 class DialRegistry; | 21 class DialRegistry; |
20 | 22 |
21 // A service which can be used to start background discovery and resolution of | 23 // A service which can be used to start background discovery and resolution of |
22 // DIAL devices (Smart TVs, Game Consoles, etc.). | 24 // DIAL devices (Smart TVs, Game Consoles, etc.). |
23 // This class is not thread safe. All methods must be called from the IO thread. | 25 // This class is thread safe. |
24 class DialMediaSinkService : public MediaSinkService, | 26 class DialMediaSinkService : public MediaSinkService, |
25 public DialRegistry::Observer { | 27 public DialRegistry::Observer, |
28 public base::RefCountedThreadSafe< | |
29 DialMediaSinkService, | |
30 content::BrowserThread::DeleteOnIOThread> { | |
26 public: | 31 public: |
27 DialMediaSinkService(const OnSinksDiscoveredCallback& callback, | 32 DialMediaSinkService(const OnSinksDiscoveredCallback& callback, |
28 net::URLRequestContextGetter* request_context); | 33 net::URLRequestContextGetter* request_context); |
29 ~DialMediaSinkService() override; | 34 void Stop(); |
Kevin M
2017/05/08 18:22:19
Add a comment for this method.
zhaobin
2017/05/08 20:13:47
Done.
| |
30 | |
31 // MediaSinkService implementation | 35 // MediaSinkService implementation |
32 void Start() override; | 36 void Start() override; |
33 | 37 |
34 void Stop(); | |
35 | |
36 protected: | 38 protected: |
37 virtual DialRegistry* dial_registry(); | 39 ~DialMediaSinkService() override; |
38 | 40 |
39 // Returns instance of device description service. Create a new one if none | 41 // Returns instance of device description service. Create a new one if none |
40 // exists. | 42 // exists. |
41 virtual DeviceDescriptionService* GetDescriptionService(); | 43 DeviceDescriptionService* GetDescriptionService(); |
44 | |
45 // Does not take ownership of |dial_registry|. | |
46 void SetDialRegistryForTest(DialRegistry* dial_registry); | |
47 void SetDescriptionServiceForTest( | |
48 std::unique_ptr<DeviceDescriptionService> description_service); | |
49 void SetTimerForTest(std::unique_ptr<base::Timer> timer); | |
42 | 50 |
43 private: | 51 private: |
52 friend struct content::BrowserThread::DeleteOnThread< | |
53 content::BrowserThread::IO>; | |
54 friend class base::DeleteHelper<DialMediaSinkService>; | |
44 friend class DialMediaSinkServiceTest; | 55 friend class DialMediaSinkServiceTest; |
45 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestStart); | 56 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestStart); |
46 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestFetchCompleted); | 57 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestTimer); |
58 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, | |
59 TestFetchCompleted_SameSink); | |
47 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestIsDifferent); | 60 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, TestIsDifferent); |
48 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, | 61 FRIEND_TEST_ALL_PREFIXES(DialMediaSinkServiceTest, |
49 TestOnDeviceDescriptionAvailable); | 62 TestOnDeviceDescriptionAvailable); |
50 | 63 |
64 // Start discovery on IO thread. | |
65 void StartOnIOThread(); | |
66 | |
67 // Stop discovery on IO thread. | |
68 void StopOnIOThread(); | |
69 | |
70 // Called when |finish_timer_| expires. | |
71 void OnFetchCompletedOnUIThread(); | |
72 | |
51 // api::dial::DialRegistry::Observer implementation | 73 // api::dial::DialRegistry::Observer implementation |
52 void OnDialDeviceEvent(const DialRegistry::DeviceList& devices) override; | 74 void OnDialDeviceEvent(const DialRegistry::DeviceList& devices) override; |
53 void OnDialError(DialRegistry::DialErrorCode type) override; | 75 void OnDialError(DialRegistry::DialErrorCode type) override; |
54 | 76 |
55 // Called when description service successfully fetches and parses device | 77 // Called when description service successfully fetches and parses device |
56 // description XML. Restart |finish_timer_| if it is not running. | 78 // description XML. Restart |finish_timer_| if it is not running. |
57 void OnDeviceDescriptionAvailable( | 79 void OnDeviceDescriptionAvailable( |
58 const DialDeviceData& device_data, | 80 const DialDeviceData& device_data, |
59 const ParsedDialDeviceDescription& description_data); | 81 const ParsedDialDeviceDescription& description_data); |
60 | 82 |
61 // Called when fails to fetch or parse device description XML. | 83 // Called when fails to fetch or parse device description XML. |
62 void OnDeviceDescriptionError(const DialDeviceData& device, | 84 void OnDeviceDescriptionError(const DialDeviceData& device, |
63 const std::string& error_message); | 85 const std::string& error_message); |
64 | 86 |
65 // Called when |finish_timer_| expires. | 87 // Called when |finish_timer_| expires and post task on UI thread. |
66 void OnFetchCompleted(); | 88 void OnFetchCompleted(); |
67 | 89 |
68 // Timer for finishing fetching. Starts in |OnDialDeviceEvent()|, and expires | 90 // Timer for finishing fetching. Starts in |OnDialDeviceEvent()|, and expires |
69 // 3 seconds later. If |OnDeviceDescriptionAvailable()| is called after | 91 // 3 seconds later. If |OnDeviceDescriptionAvailable()| is called after |
70 // |finish_timer_| expires, |finish_timer_| is restarted. | 92 // |finish_timer_| expires, |finish_timer_| is restarted. |
71 std::unique_ptr<base::OneShotTimer> finish_timer_; | 93 std::unique_ptr<base::Timer> finish_timer_; |
72 | 94 |
73 std::unique_ptr<DeviceDescriptionService> description_service_; | 95 std::unique_ptr<DeviceDescriptionService> description_service_; |
74 | 96 |
97 // Raw pointer to DialRegistry singleton. | |
98 DialRegistry* dial_registry_; | |
99 | |
75 // Sorted sinks from current round of discovery. | 100 // Sorted sinks from current round of discovery. |
76 std::set<MediaSinkInternal> current_sinks_; | 101 std::set<MediaSinkInternal> current_sinks_; |
77 | 102 |
78 // Sorted sinks sent to Media Router Provider in last FetchCompleted(). | 103 // Sorted sinks sent to Media Router Provider in last FetchCompleted(). |
79 std::set<MediaSinkInternal> mrp_sinks_; | 104 std::set<MediaSinkInternal> mrp_sinks_; |
80 | 105 |
81 // Device data list from current round of discovery. | 106 // Device data list from current round of discovery. |
82 DialRegistry::DeviceList current_devices_; | 107 DialRegistry::DeviceList current_devices_; |
83 | 108 |
84 scoped_refptr<net::URLRequestContextGetter> request_context_; | 109 scoped_refptr<net::URLRequestContextGetter> request_context_; |
85 }; | 110 }; |
86 | 111 |
87 } // namespace media_router | 112 } // namespace media_router |
88 | 113 |
89 #endif // CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ | 114 #endif // CHROME_BROWSER_MEDIA_ROUTER_DISCOVERY_DIAL_DIAL_MEDIA_SINK_SERVICE_H_ |
OLD | NEW |