summaryrefslogtreecommitdiffstats
path: root/xpcom/threads/nsIRunnable.idl
blob: bfe9669a9f0e7cb5ac4e99e4bf5495ac0d54b784 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

/**
 * Represents a task which can be dispatched to a thread for execution.
 */

[scriptable, function, uuid(4a2abaf0-6886-11d3-9382-00104ba0fd40)]
interface nsIRunnable : nsISupports
{
    /**
     * The function implementing the task to be run.
     */
    void run();
};

[scriptable, uuid(e75aa42a-80a9-11e6-afb5-e89d87348e2c)]
interface nsIRunnablePriority : nsISupports
{
    const unsigned long PRIORITY_IDLE = 0;
    const unsigned long PRIORITY_DEFERRED_TIMERS = 1;
    const unsigned long PRIORITY_LOW = 2;
    // INPUT_LOW isn't supposed to be used directly.
    // const unsigned long PRIORITY_INPUT_LOW = 3;
    const unsigned long PRIORITY_NORMAL = 4;
    const unsigned long PRIORITY_MEDIUMHIGH = 5;
    const unsigned long PRIORITY_INPUT_HIGH = 6;
    const unsigned long PRIORITY_VSYNC = 7;
    // INPUT_HIGHEST is InputTaskManager's internal priority
    //const unsigned long PRIORITY_INPUT_HIGHEST = 8;
    const unsigned long PRIORITY_RENDER_BLOCKING = 9;
    const unsigned long PRIORITY_CONTROL = 10;

    readonly attribute unsigned long priority;
};

[uuid(3114c36c-a482-4c6e-9523-1dcfc6f605b9)]
interface nsIRunnableIPCMessageType : nsISupports
{
    readonly attribute unsigned long type;
};