OLD | NEW |
---|---|
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 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_PRERENDER_PRERENDER_TRACKER_H_ | 5 #ifndef CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_ |
6 #define CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_ | 6 #define CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include <map> | 9 #include <map> |
10 #include <set> | 10 #include <set> |
11 | 11 |
12 #include "base/memory/singleton.h" | |
13 #include "base/synchronization/lock.h" | 12 #include "base/synchronization/lock.h" |
14 #include "chrome/browser/prerender/prerender_final_status.h" | 13 #include "chrome/browser/prerender/prerender_final_status.h" |
14 #include "content/browser/renderer_host/resource_dispatcher_host.h" | |
15 | 15 |
16 namespace prerender { | 16 namespace prerender { |
17 | 17 |
18 class PrerenderManager; | 18 class PrerenderManager; |
19 struct RenderViewInfo; | |
20 | 19 |
21 // PrerenderTracker is responsible for keeping track of all prerendering | 20 // PrerenderTracker is responsible for keeping track of all prerendering |
22 // RenderViews and their statuses. Its list is guaranteed to be up to date | 21 // RenderViews and their statuses. Its list is guaranteed to be up to date |
23 // and can be modified on any thread. | 22 // and can be modified on any thread. |
24 class PrerenderTracker { | 23 class PrerenderTracker : public ResourceDispatcherHost::Observer { |
25 public: | 24 public: |
26 // Returns the PrerenderTracker singleton. | 25 PrerenderTracker() {} |
27 static PrerenderTracker* GetInstance(); | 26 virtual ~PrerenderTracker() {} |
28 | 27 |
29 // Attempts to set the status of the specified RenderViewHost to | 28 // Attempts to set the status of the specified RenderViewHost to |
30 // FINAL_STATUS_USED. Returns true on success. Returns false if it has | 29 // FINAL_STATUS_USED. Returns true on success. Returns false if it has |
31 // already been cancelled for any reason, or is no longer prerendering. | 30 // already been cancelled for any reason, or is no longer prerendering. |
32 // Can only be called only on the IO thread. This method will not call | 31 // Can only be called only on the IO thread. This method will not call |
33 // PrerenderContents::set_final_status() on the corresponding | 32 // PrerenderContents::set_final_status() on the corresponding |
34 // PrerenderContents. | 33 // PrerenderContents. |
35 // | 34 // |
36 // If it returns true, all subsequent calls to TryCancel for the RenderView | 35 // If it returns true, all subsequent calls to TryCancel for the RenderView |
37 // will return false. | 36 // will return false. |
(...skipping 12 matching lines...) Expand all Loading... | |
50 | 49 |
51 // Same as above, but can only called on the IO Thread. Does not acquire a | 50 // Same as above, but can only called on the IO Thread. Does not acquire a |
52 // lock when the RenderView is not being prerendered. | 51 // lock when the RenderView is not being prerendered. |
53 bool TryCancelOnIOThread(int child_id, int route_id, | 52 bool TryCancelOnIOThread(int child_id, int route_id, |
54 FinalStatus final_status); | 53 FinalStatus final_status); |
55 | 54 |
56 // Returns whether or not a RenderView is prerendering. Can only be called on | 55 // Returns whether or not a RenderView is prerendering. Can only be called on |
57 // the IO thread. Does not acquire a lock, so may claim a RenderView that has | 56 // the IO thread. Does not acquire a lock, so may claim a RenderView that has |
58 // been displayed or destroyed is still prerendering. | 57 // been displayed or destroyed is still prerendering. |
59 // TODO(mmenke): Remove external use of this method and make it private. | 58 // TODO(mmenke): Remove external use of this method and make it private. |
60 bool IsPrerenderingOnIOThread(int child_id, int route_id) const; | 59 bool IsPrerenderingOnIOThread(int child_id, int route_id) const; |
mmenke
2011/05/23 21:58:41
Please make this private and remove the TODO.
dominich
2011/05/23 22:22:55
Done.
| |
61 | 60 |
62 // Gets the FinalStatus of the specified prerendered RenderView. Returns | 61 // Gets the FinalStatus of the specified prerendered RenderView. Returns |
63 // |true| and sets |final_status| to the status of the RenderView if it | 62 // |true| and sets |final_status| to the status of the RenderView if it |
64 // is found, returns false otherwise. | 63 // is found, returns false otherwise. |
65 bool GetFinalStatus(int child_id, int route_id, | 64 bool GetFinalStatus(int child_id, int route_id, |
66 FinalStatus* final_status) const; | 65 FinalStatus* final_status) const; |
67 | 66 |
67 // ResourceDispatcherHost::Observer implementation. | |
68 virtual bool ShouldBeginRequest( | |
69 int child_id, int route_id, | |
70 const ResourceHostMsg_Request& request_data, | |
71 const content::ResourceContext& resource_context, | |
72 const GURL& referrer) OVERRIDE; | |
73 | |
74 virtual void MutateLoadFlags(int child_id, int route_id, | |
75 int* load_flags) OVERRIDE; | |
76 | |
68 protected: | 77 protected: |
69 friend class PrerenderContents; | 78 friend class PrerenderContents; |
70 | 79 |
71 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerUsed); | 80 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerUsed); |
72 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelled); | 81 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelled); |
73 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledOnIO); | 82 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledOnIO); |
74 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledFast); | 83 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledFast); |
75 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerMultiple); | 84 FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerMultiple); |
76 | 85 |
77 // Must be called when a RenderView starts prerendering, before the first | 86 // Must be called when a RenderView starts prerendering, before the first |
78 // navigation starts to avoid any races. | 87 // navigation starts to avoid any races. |
79 void OnPrerenderingStarted(int child_id, int route_id, | 88 void OnPrerenderingStarted(int child_id, int route_id, |
80 PrerenderManager* prerender_manager); | 89 PrerenderManager* prerender_manager); |
81 | 90 |
82 // Must be called when a RenderView stops prerendering, either because the | 91 // Must be called when a RenderView stops prerendering, either because the |
83 // RenderView was used or prerendering was cancelled and it is being | 92 // RenderView was used or prerendering was cancelled and it is being |
84 // destroyed. | 93 // destroyed. |
85 void OnPrerenderingFinished(int child_id, int route_id); | 94 void OnPrerenderingFinished(int child_id, int route_id); |
86 | 95 |
87 private: | 96 private: |
88 friend struct DefaultSingletonTraits<PrerenderTracker>; | 97 struct RenderViewInfo { |
98 explicit RenderViewInfo(PrerenderManager* prerender_manager); | |
99 | |
100 FinalStatus final_status; | |
101 base::WeakPtr<PrerenderManager> prerender_manager; | |
102 }; | |
89 | 103 |
90 typedef std::pair<int, int> ChildRouteIdPair; | 104 typedef std::pair<int, int> ChildRouteIdPair; |
91 | 105 |
92 // Map of child/route id pairs to final statuses. | 106 // Map of child/route id pairs to final statuses. |
93 typedef std::map<ChildRouteIdPair, RenderViewInfo> FinalStatusMap; | 107 typedef std::map<ChildRouteIdPair, RenderViewInfo> FinalStatusMap; |
94 // Set of child/route id pairs that may be prerendering. | 108 // Set of child/route id pairs that may be prerendering. |
95 typedef std::set<ChildRouteIdPair> PossiblyPrerenderingChildRouteIdPairs; | 109 typedef std::set<ChildRouteIdPair> PossiblyPrerenderingChildRouteIdPairs; |
96 | 110 |
97 PrerenderTracker(); | |
98 ~PrerenderTracker(); | |
99 | |
100 // Attempts to set the FinalStatus of the specified RenderView to | 111 // Attempts to set the FinalStatus of the specified RenderView to |
101 // |final_status|. If the FinalStatus of the RenderView has already been | 112 // |final_status|. If the FinalStatus of the RenderView has already been |
102 // set, does nothing. Returns the resulting FinalStatus of that RenderView, | 113 // set, does nothing. Returns the resulting FinalStatus of that RenderView, |
103 // regardless of success or failure. If the RenderView isn't currently | 114 // regardless of success or failure. If the RenderView isn't currently |
104 // prerendering, returns FINAL_STATUS_MAX. | 115 // prerendering, returns FINAL_STATUS_MAX. |
105 FinalStatus SetFinalStatus(int child_id, int route_id, | 116 FinalStatus SetFinalStatus(int child_id, int route_id, |
106 FinalStatus final_status); | 117 FinalStatus final_status); |
107 | 118 |
108 // Add/remove the specified pair to |possibly_prerendering_io_thread_set_| on | 119 // Add/remove the specified pair to |possibly_prerendering_io_thread_set_| on |
109 // the IO Thread. | 120 // the IO Thread. |
(...skipping 17 matching lines...) Expand all Loading... | |
127 // the IO thread. May contain entries that have since been displayed. Only | 138 // the IO thread. May contain entries that have since been displayed. Only |
128 // used to prevent locking when not needed. | 139 // used to prevent locking when not needed. |
129 PossiblyPrerenderingChildRouteIdPairs possibly_prerendering_io_thread_set_; | 140 PossiblyPrerenderingChildRouteIdPairs possibly_prerendering_io_thread_set_; |
130 | 141 |
131 DISALLOW_COPY_AND_ASSIGN(PrerenderTracker); | 142 DISALLOW_COPY_AND_ASSIGN(PrerenderTracker); |
132 }; | 143 }; |
133 | 144 |
134 } // namespace prerender | 145 } // namespace prerender |
135 | 146 |
136 #endif // CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_ | 147 #endif // CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_ |
OLD | NEW |