blob: e929f3dd134ef2325419abd3e076c8ba8a7aa2bc (
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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/. */
#ifndef mozilla_dom_timeout_h
#define mozilla_dom_timeout_h
#include "mozilla/LinkedList.h"
#include "mozilla/TimeStamp.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsPIDOMWindow.h"
class nsGlobalWindow;
class nsIPrincipal;
class nsITimeoutHandler;
class nsITimer;
class nsIEventTarget;
namespace mozilla {
namespace dom {
/*
* Timeout struct that holds information about each script
* timeout. Holds a strong reference to an nsITimeoutHandler, which
* abstracts the language specific cruft.
*/
class Timeout final
: public LinkedListElement<Timeout>
{
public:
Timeout();
NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(Timeout)
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(Timeout)
// The target may be specified to use a particular event queue for the
// resulting timer runnable. A nullptr target will result in the
// default main thread being used.
nsresult InitTimer(nsIEventTarget* aTarget, uint32_t aDelay);
enum class Reason { eTimeoutOrInterval, eIdleCallbackTimeout };
#ifdef DEBUG
bool HasRefCntOne() const;
#endif // DEBUG
// Window for which this timeout fires
RefPtr<nsGlobalWindow> mWindow;
// The actual timer object
nsCOMPtr<nsITimer> mTimer;
// True if the timeout was cleared
bool mCleared;
// True if this is one of the timeouts that are currently running
bool mRunning;
// True if this is a repeating/interval timer
bool mIsInterval;
Reason mReason;
// Returned as value of setTimeout()
uint32_t mTimeoutId;
// Interval in milliseconds
uint32_t mInterval;
// mWhen and mTimeRemaining can't be in a union, sadly, because they
// have constructors.
// Nominal time to run this timeout. Use only when timeouts are not
// suspended.
TimeStamp mWhen;
// Remaining time to wait. Used only when timeouts are suspended.
TimeDuration mTimeRemaining;
// Principal with which to execute
nsCOMPtr<nsIPrincipal> mPrincipal;
// stack depth at which timeout is firing
uint32_t mFiringDepth;
uint32_t mNestingLevel;
// The popup state at timeout creation time if not created from
// another timeout
PopupControlState mPopupState;
// The language-specific information about the callback.
nsCOMPtr<nsITimeoutHandler> mScriptHandler;
private:
~Timeout();
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_timeout_h
|
