OLD | NEW |
1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2006-2008 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 BASE_MESSAGE_PUMP_H_ | 5 #ifndef BASE_MESSAGE_PUMP_H_ |
6 #define BASE_MESSAGE_PUMP_H_ | 6 #define BASE_MESSAGE_PUMP_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include "base/ref_counted.h" | 9 #include "base/ref_counted.h" |
10 | 10 |
11 namespace base { | 11 namespace base { |
12 | 12 |
13 class Time; | 13 class TimeTicks; |
14 | 14 |
15 class MessagePump : public RefCountedThreadSafe<MessagePump> { | 15 class MessagePump : public RefCountedThreadSafe<MessagePump> { |
16 public: | 16 public: |
17 // Please see the comments above the Run method for an illustration of how | 17 // Please see the comments above the Run method for an illustration of how |
18 // these delegate methods are used. | 18 // these delegate methods are used. |
19 class Delegate { | 19 class Delegate { |
20 public: | 20 public: |
21 virtual ~Delegate() {} | 21 virtual ~Delegate() {} |
22 | 22 |
23 // Called from within Run in response to ScheduleWork or when the message | 23 // Called from within Run in response to ScheduleWork or when the message |
24 // pump would otherwise call DoDelayedWork. Returns true to indicate that | 24 // pump would otherwise call DoDelayedWork. Returns true to indicate that |
25 // work was done. DoDelayedWork will not be called if DoWork returns true. | 25 // work was done. DoDelayedWork will not be called if DoWork returns true. |
26 virtual bool DoWork() = 0; | 26 virtual bool DoWork() = 0; |
27 | 27 |
28 // Called from within Run in response to ScheduleDelayedWork or when the | 28 // Called from within Run in response to ScheduleDelayedWork or when the |
29 // message pump would otherwise sleep waiting for more work. Returns true | 29 // message pump would otherwise sleep waiting for more work. Returns true |
30 // to indicate that delayed work was done. DoIdleWork will not be called | 30 // to indicate that delayed work was done. DoIdleWork will not be called |
31 // if DoDelayedWork returns true. Upon return |next_delayed_work_time| | 31 // if DoDelayedWork returns true. Upon return |next_delayed_work_time| |
32 // indicates the time when DoDelayedWork should be called again. If | 32 // indicates the time when DoDelayedWork should be called again. If |
33 // |next_delayed_work_time| is null (per Time::is_null), then the queue of | 33 // |next_delayed_work_time| is null (per Time::is_null), then the queue of |
34 // future delayed work (timer events) is currently empty, and no additional | 34 // future delayed work (timer events) is currently empty, and no additional |
35 // calls to this function need to be scheduled. | 35 // calls to this function need to be scheduled. |
36 virtual bool DoDelayedWork(Time* next_delayed_work_time) = 0; | 36 virtual bool DoDelayedWork(TimeTicks* next_delayed_work_time) = 0; |
37 | 37 |
38 // Called from within Run just before the message pump goes to sleep. | 38 // Called from within Run just before the message pump goes to sleep. |
39 // Returns true to indicate that idle work was done. | 39 // Returns true to indicate that idle work was done. |
40 virtual bool DoIdleWork() = 0; | 40 virtual bool DoIdleWork() = 0; |
41 }; | 41 }; |
42 | 42 |
43 MessagePump(); | 43 MessagePump(); |
44 virtual ~MessagePump(); | 44 virtual ~MessagePump(); |
45 | 45 |
46 // The Run method is called to enter the message pump's run loop. | 46 // The Run method is called to enter the message pump's run loop. |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
109 | 109 |
110 // Schedule a DoWork callback to happen reasonably soon. Does nothing if a | 110 // Schedule a DoWork callback to happen reasonably soon. Does nothing if a |
111 // DoWork callback is already scheduled. This method may be called from any | 111 // DoWork callback is already scheduled. This method may be called from any |
112 // thread. Once this call is made, DoWork should not be "starved" at least | 112 // thread. Once this call is made, DoWork should not be "starved" at least |
113 // until it returns a value of false. | 113 // until it returns a value of false. |
114 virtual void ScheduleWork() = 0; | 114 virtual void ScheduleWork() = 0; |
115 | 115 |
116 // Schedule a DoDelayedWork callback to happen at the specified time, | 116 // Schedule a DoDelayedWork callback to happen at the specified time, |
117 // cancelling any pending DoDelayedWork callback. This method may only be | 117 // cancelling any pending DoDelayedWork callback. This method may only be |
118 // used on the thread that called Run. | 118 // used on the thread that called Run. |
119 virtual void ScheduleDelayedWork(const Time& delayed_work_time) = 0; | 119 virtual void ScheduleDelayedWork(const TimeTicks& delayed_work_time) = 0; |
120 }; | 120 }; |
121 | 121 |
122 } // namespace base | 122 } // namespace base |
123 | 123 |
124 #endif // BASE_MESSAGE_PUMP_H_ | 124 #endif // BASE_MESSAGE_PUMP_H_ |
OLD | NEW |