OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 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 WEBKIT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ | 5 #ifndef CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ |
6 #define WEBKIT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ | 6 #define CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ |
7 | 7 |
8 #include "base/memory/ref_counted.h" | 8 #include "base/memory/ref_counted.h" |
9 #include "base/sequenced_task_runner.h" | 9 #include "base/sequenced_task_runner.h" |
10 #include "base/threading/sequenced_worker_pool.h" | 10 #include "base/threading/sequenced_worker_pool.h" |
11 #include "base/time/time.h" | 11 #include "base/time/time.h" |
12 #include "webkit/browser/webkit_storage_browser_export.h" | 12 #include "content/common/content_export.h" |
13 | 13 |
14 namespace base { | 14 namespace base { |
15 class MessageLoopProxy; | 15 class MessageLoopProxy; |
16 } | 16 } |
17 | 17 |
18 namespace dom_storage { | 18 namespace content { |
19 | 19 |
20 // DomStorage uses two task sequences (primary vs commit) to avoid | 20 // DOMStorage uses two task sequences (primary vs commit) to avoid |
21 // primary access from queuing up behind commits to disk. | 21 // primary access from queuing up behind commits to disk. |
22 // * Initialization, shutdown, and administrative tasks are performed as | 22 // * Initialization, shutdown, and administrative tasks are performed as |
23 // shutdown-blocking primary sequence tasks. | 23 // shutdown-blocking primary sequence tasks. |
24 // * Tasks directly related to the javascript'able interface are performed | 24 // * Tasks directly related to the javascript'able interface are performed |
25 // as shutdown-blocking primary sequence tasks. | 25 // as shutdown-blocking primary sequence tasks. |
26 // TODO(michaeln): Skip tasks for reading during shutdown. | 26 // TODO(michaeln): Skip tasks for reading during shutdown. |
27 // * Internal tasks related to committing changes to disk are performed as | 27 // * Internal tasks related to committing changes to disk are performed as |
28 // shutdown-blocking commit sequence tasks. | 28 // shutdown-blocking commit sequence tasks. |
29 class WEBKIT_STORAGE_BROWSER_EXPORT DomStorageTaskRunner | 29 class CONTENT_EXPORT DOMStorageTaskRunner |
30 : public base::TaskRunner { | 30 : public base::TaskRunner { |
31 public: | 31 public: |
32 enum SequenceID { | 32 enum SequenceID { |
33 PRIMARY_SEQUENCE, | 33 PRIMARY_SEQUENCE, |
34 COMMIT_SEQUENCE | 34 COMMIT_SEQUENCE |
35 }; | 35 }; |
36 | 36 |
37 // The PostTask() and PostDelayedTask() methods defined by TaskRunner | 37 // The PostTask() and PostDelayedTask() methods defined by TaskRunner |
38 // post shutdown-blocking tasks on the primary sequence. | 38 // post shutdown-blocking tasks on the primary sequence. |
39 virtual bool PostDelayedTask( | 39 virtual bool PostDelayedTask( |
(...skipping 14 matching lines...) Expand all Loading... |
54 // Returns true if the current thread is running on the given |sequence_id|. | 54 // Returns true if the current thread is running on the given |sequence_id|. |
55 virtual bool IsRunningOnSequence(SequenceID sequence_id) const = 0; | 55 virtual bool IsRunningOnSequence(SequenceID sequence_id) const = 0; |
56 bool IsRunningOnPrimarySequence() const { | 56 bool IsRunningOnPrimarySequence() const { |
57 return IsRunningOnSequence(PRIMARY_SEQUENCE); | 57 return IsRunningOnSequence(PRIMARY_SEQUENCE); |
58 } | 58 } |
59 bool IsRunningOnCommitSequence() const { | 59 bool IsRunningOnCommitSequence() const { |
60 return IsRunningOnSequence(COMMIT_SEQUENCE); | 60 return IsRunningOnSequence(COMMIT_SEQUENCE); |
61 } | 61 } |
62 | 62 |
63 protected: | 63 protected: |
64 virtual ~DomStorageTaskRunner() {} | 64 virtual ~DOMStorageTaskRunner() {} |
65 }; | 65 }; |
66 | 66 |
67 // A derived class used in chromium that utilizes a SequenceWorkerPool | 67 // A derived class used in chromium that utilizes a SequenceWorkerPool |
68 // under dom_storage specific SequenceTokens. The |delayed_task_loop| | 68 // under dom_storage specific SequenceTokens. The |delayed_task_loop| |
69 // is used to delay scheduling on the worker pool. | 69 // is used to delay scheduling on the worker pool. |
70 class WEBKIT_STORAGE_BROWSER_EXPORT DomStorageWorkerPoolTaskRunner : | 70 class CONTENT_EXPORT DOMStorageWorkerPoolTaskRunner : |
71 public DomStorageTaskRunner { | 71 public DOMStorageTaskRunner { |
72 public: | 72 public: |
73 DomStorageWorkerPoolTaskRunner( | 73 DOMStorageWorkerPoolTaskRunner( |
74 base::SequencedWorkerPool* sequenced_worker_pool, | 74 base::SequencedWorkerPool* sequenced_worker_pool, |
75 base::SequencedWorkerPool::SequenceToken primary_sequence_token, | 75 base::SequencedWorkerPool::SequenceToken primary_sequence_token, |
76 base::SequencedWorkerPool::SequenceToken commit_sequence_token, | 76 base::SequencedWorkerPool::SequenceToken commit_sequence_token, |
77 base::MessageLoopProxy* delayed_task_loop); | 77 base::MessageLoopProxy* delayed_task_loop); |
78 | 78 |
79 virtual bool PostDelayedTask( | 79 virtual bool PostDelayedTask( |
80 const tracked_objects::Location& from_here, | 80 const tracked_objects::Location& from_here, |
81 const base::Closure& task, | 81 const base::Closure& task, |
82 base::TimeDelta delay) OVERRIDE; | 82 base::TimeDelta delay) OVERRIDE; |
83 | 83 |
84 virtual bool PostShutdownBlockingTask( | 84 virtual bool PostShutdownBlockingTask( |
85 const tracked_objects::Location& from_here, | 85 const tracked_objects::Location& from_here, |
86 SequenceID sequence_id, | 86 SequenceID sequence_id, |
87 const base::Closure& task) OVERRIDE; | 87 const base::Closure& task) OVERRIDE; |
88 | 88 |
89 virtual bool IsRunningOnSequence(SequenceID sequence_id) const OVERRIDE; | 89 virtual bool IsRunningOnSequence(SequenceID sequence_id) const OVERRIDE; |
90 | 90 |
91 protected: | 91 protected: |
92 virtual ~DomStorageWorkerPoolTaskRunner(); | 92 virtual ~DOMStorageWorkerPoolTaskRunner(); |
93 | 93 |
94 private: | 94 private: |
95 | 95 |
96 base::SequencedWorkerPool::SequenceToken IDtoToken(SequenceID id) const; | 96 base::SequencedWorkerPool::SequenceToken IDtoToken(SequenceID id) const; |
97 | 97 |
98 const scoped_refptr<base::MessageLoopProxy> message_loop_; | 98 const scoped_refptr<base::MessageLoopProxy> message_loop_; |
99 const scoped_refptr<base::SequencedWorkerPool> sequenced_worker_pool_; | 99 const scoped_refptr<base::SequencedWorkerPool> sequenced_worker_pool_; |
100 base::SequencedWorkerPool::SequenceToken primary_sequence_token_; | 100 base::SequencedWorkerPool::SequenceToken primary_sequence_token_; |
101 base::SequencedWorkerPool::SequenceToken commit_sequence_token_; | 101 base::SequencedWorkerPool::SequenceToken commit_sequence_token_; |
102 }; | 102 }; |
103 | 103 |
104 // A derived class used in unit tests that ignores all delays so | 104 // A derived class used in unit tests that ignores all delays so |
105 // we don't block in unit tests waiting for timeouts to expire. | 105 // we don't block in unit tests waiting for timeouts to expire. |
106 // There is no distinction between [non]-shutdown-blocking or | 106 // There is no distinction between [non]-shutdown-blocking or |
107 // the primary sequence vs the commit sequence in the mock, | 107 // the primary sequence vs the commit sequence in the mock, |
108 // all tasks are scheduled on |message_loop| with zero delay. | 108 // all tasks are scheduled on |message_loop| with zero delay. |
109 class WEBKIT_STORAGE_BROWSER_EXPORT MockDomStorageTaskRunner : | 109 class CONTENT_EXPORT MockDOMStorageTaskRunner : |
110 public DomStorageTaskRunner { | 110 public DOMStorageTaskRunner { |
111 public: | 111 public: |
112 explicit MockDomStorageTaskRunner(base::MessageLoopProxy* message_loop); | 112 explicit MockDOMStorageTaskRunner(base::MessageLoopProxy* message_loop); |
113 | 113 |
114 virtual bool PostDelayedTask( | 114 virtual bool PostDelayedTask( |
115 const tracked_objects::Location& from_here, | 115 const tracked_objects::Location& from_here, |
116 const base::Closure& task, | 116 const base::Closure& task, |
117 base::TimeDelta delay) OVERRIDE; | 117 base::TimeDelta delay) OVERRIDE; |
118 | 118 |
119 virtual bool PostShutdownBlockingTask( | 119 virtual bool PostShutdownBlockingTask( |
120 const tracked_objects::Location& from_here, | 120 const tracked_objects::Location& from_here, |
121 SequenceID sequence_id, | 121 SequenceID sequence_id, |
122 const base::Closure& task) OVERRIDE; | 122 const base::Closure& task) OVERRIDE; |
123 | 123 |
124 virtual bool IsRunningOnSequence(SequenceID sequence_id) const OVERRIDE; | 124 virtual bool IsRunningOnSequence(SequenceID sequence_id) const OVERRIDE; |
125 | 125 |
126 protected: | 126 protected: |
127 virtual ~MockDomStorageTaskRunner(); | 127 virtual ~MockDOMStorageTaskRunner(); |
128 | 128 |
129 private: | 129 private: |
130 const scoped_refptr<base::MessageLoopProxy> message_loop_; | 130 const scoped_refptr<base::MessageLoopProxy> message_loop_; |
131 }; | 131 }; |
132 | 132 |
133 } // namespace dom_storage | 133 } // namespace content |
134 | 134 |
135 #endif // WEBKIT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ | 135 #endif // CONTENT_BROWSER_DOM_STORAGE_DOM_STORAGE_TASK_RUNNER_ |
OLD | NEW |