xpcom/threads/nsIIdlePeriod.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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 #include "nsISupports.idl"
   7
   8 %{C++
   9 namespace mozilla {
  10 class TimeStamp;
  11 }
  12 %}
  13
  14 native TimeStamp(mozilla::TimeStamp);
  15
  16 /**
  17  * An instance implementing nsIIdlePeriod is used by an associated
  18  * nsIThread to estimate when it is likely that it will receive an
  19  * event.
  20  */
  21 [uuid(21dd35a2-eae9-4bd8-b470-0dfa35a0e3b9)]
  22 interface nsIIdlePeriod : nsISupports
  23 {
  24     /**
  25      * Return an estimate of a point in time in the future when we
  26      * think that the associated thread will become busy. Should
  27      * return TimeStamp() (i.e. the null time) or a time less than
  28      * TimeStamp::Now() if the thread is currently busy or will become
  29      * busy very soon.
  30      */
  31     TimeStamp getIdlePeriodHint();
  32 };