xpcom/threads/HangMonitor.h

Thu, 15 Jan 2015 21:03:48 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 15 Jan 2015 21:03:48 +0100
branch
TOR_BUG_9701
changeset 11
deefc01c0e14
permissions
-rw-r--r--

Integrate friendly tips from Tor colleagues to make (or not) 4.5 alpha 3;
This includes removal of overloaded (but unused) methods, and addition of
a overlooked call to DataStruct::SetData(nsISupports, uint32_t, bool.)

     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/. */
     6 #ifndef mozilla_HangMonitor_h
     7 #define mozilla_HangMonitor_h
     9 namespace mozilla { namespace HangMonitor {
    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,
    18   /* There is non UI activity and no UI activity is pending */
    19   kActivityNoUIAVail,
    21   /* There is non UI activity and UI activity is known to be pending */
    22   kActivityUIAVail,
    24   /* There is non UI activity and UI activity pending is unknown */
    25   kGeneralActivity
    26 };
    28 /**
    29  * Start monitoring hangs. Should be called by the XPCOM startup process only.
    30  */
    31 void Startup();
    33 /**
    34  * Stop monitoring hangs and join the thread.
    35  */
    36 void Shutdown();
    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);
    46 /*
    47  * Notify the hang monitor that the browser is now idle and no detection should
    48  * be done.
    49  */
    50 void Suspend();
    52 } } // namespace mozilla::HangMonitor
    54 #endif // mozilla_HangMonitor_h

mercurial