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