The Tor Browser / file comparison
comparison: xpcom/threads/HangMonitor.h
xpcom/threads/HangMonitor.h
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
equal
deleted
inserted
replaced
| -1:000000000000 | 0:01838c74aff0 |
|---|---|
| 1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ | |
| 2 /* This Source Code Form is subject to the terms of the Mozilla Public | |
| 3 * License, v. 2.0. If a copy of the MPL was not distributed with this | |
| 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | |
| 5 | |
| 6 #ifndef mozilla_HangMonitor_h | |
| 7 #define mozilla_HangMonitor_h | |
| 8 | |
| 9 namespace mozilla { namespace HangMonitor { | |
| 10 | |
| 11 /** | |
| 12 * Signifies the type of activity in question | |
| 13 */ | |
| 14 enum ActivityType { | |
| 15 /* There is activity and it is known to be UI related activity. */ | |
| 16 kUIActivity, | |
| 17 | |
| 18 /* There is non UI activity and no UI activity is pending */ | |
| 19 kActivityNoUIAVail, | |
| 20 | |
| 21 /* There is non UI activity and UI activity is known to be pending */ | |
| 22 kActivityUIAVail, | |
| 23 | |
| 24 /* There is non UI activity and UI activity pending is unknown */ | |
| 25 kGeneralActivity | |
| 26 }; | |
| 27 | |
| 28 /** | |
| 29 * Start monitoring hangs. Should be called by the XPCOM startup process only. | |
| 30 */ | |
| 31 void Startup(); | |
| 32 | |
| 33 /** | |
| 34 * Stop monitoring hangs and join the thread. | |
| 35 */ | |
| 36 void Shutdown(); | |
| 37 | |
| 38 /** | |
| 39 * Notify the hang monitor of activity which will reset its internal timer. | |
| 40 * | |
| 41 * @param activityType The type of activity being reported. | |
| 42 * @see ActivityType | |
| 43 */ | |
| 44 void NotifyActivity(ActivityType activityType = kGeneralActivity); | |
| 45 | |
| 46 /* | |
| 47 * Notify the hang monitor that the browser is now idle and no detection should | |
| 48 * be done. | |
| 49 */ | |
| 50 void Suspend(); | |
| 51 | |
| 52 } } // namespace mozilla::HangMonitor | |
| 53 | |
| 54 #endif // mozilla_HangMonitor_h |
