1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/xpcom/threads/HangMonitor.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,54 @@
1.4 +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#ifndef mozilla_HangMonitor_h
1.10 +#define mozilla_HangMonitor_h
1.11 +
1.12 +namespace mozilla { namespace HangMonitor {
1.13 +
1.14 +/**
1.15 + * Signifies the type of activity in question
1.16 +*/
1.17 +enum ActivityType {
1.18 + /* There is activity and it is known to be UI related activity. */
1.19 + kUIActivity,
1.20 +
1.21 + /* There is non UI activity and no UI activity is pending */
1.22 + kActivityNoUIAVail,
1.23 +
1.24 + /* There is non UI activity and UI activity is known to be pending */
1.25 + kActivityUIAVail,
1.26 +
1.27 + /* There is non UI activity and UI activity pending is unknown */
1.28 + kGeneralActivity
1.29 +};
1.30 +
1.31 +/**
1.32 + * Start monitoring hangs. Should be called by the XPCOM startup process only.
1.33 + */
1.34 +void Startup();
1.35 +
1.36 +/**
1.37 + * Stop monitoring hangs and join the thread.
1.38 + */
1.39 +void Shutdown();
1.40 +
1.41 +/**
1.42 + * Notify the hang monitor of activity which will reset its internal timer.
1.43 + *
1.44 + * @param activityType The type of activity being reported.
1.45 + * @see ActivityType
1.46 + */
1.47 +void NotifyActivity(ActivityType activityType = kGeneralActivity);
1.48 +
1.49 +/*
1.50 + * Notify the hang monitor that the browser is now idle and no detection should
1.51 + * be done.
1.52 + */
1.53 +void Suspend();
1.54 +
1.55 +} } // namespace mozilla::HangMonitor
1.56 +
1.57 +#endif // mozilla_HangMonitor_h
