Window オブジェクト setTimeout、setInterval メソッド (DOM)

[45] setTimeout() と setInterval() は、一定時間後、あるいは一定時間ごとに指定した処理を実行するものです。

仕様書

定義

[46] WindowOrWorkerGlobalScope インターフェイスは、メソッド setTimeout, setInterval, clearTimeout, clearInterval を持ちます >>33。 WindowOrWorkerGlobalScope は Window >>33 と WorkerGlobalScope >>47 が実装しています。

タイマー設定メソッド

[48] setTimeout と setInterval は、いずれもタイマー初期化手順を実行するものです >>33。

[49] 第1引数: 一定時間後に実行されるべきコードを指定します。データ型は TimerHandler、すなわち Function または DOMString です >>33。この引数は必要です >>33。
[50] 第2引数: コードが実行されるまでの時間です。データ型は long で、省略した場合の既定値は 0 です >>33。
[51] 第3引数以降: 任意の値を指定でき >>33、コードへの引数として使われます。

[52] メソッドの返り値は、 long です >>33。

待ち時間

[87] 与えられたコードは、 >>66、>>72、>>32 を待った後、実行されます。

[66] 基本となる待ち時間は、第2引数で指定された値です。ただしその値が4より小さく、タイマー入れ子水準 (なければ0) が5より大きいなら、4とします。 >>33

[75] タイマー入れ子水準 (timer nesting level) >>33 は、入れ子回数の管理のための値です。タイマー初期化手順により追加されたタスクに存在します。追加されたタスクのタイマー入れ子水準は、元のタスクのタイマー入れ子水準よりも1大きな値です >>33。

[31] 元々は最小でも 10ms とされていましたが、後に実装によっては最小 4ms となり、 >>27 で仕様もそれに揃いました。更に入れ子回数 (タイマーによる処理によって更にタイマー処理を予定した回数) が4回までは 4ms の制限すらも撤廃されるようになり、仕様も >>24 で追随しています。

[70] Window では、関連付けられている文書が完全に活性な状態のミリ秒数として解釈されます >>33。

[71] WorkerGlobalScope では、ワーカーが suspend されていない状態のミリ秒数として解釈されます >>33。

[86] いずれも、連続的な秒数ではなく、合計の秒数です。

[72] 同じ文脈オブジェクトについてタイマー初期化手順が何度も呼ばれている場合、呼び出しのタイミングがより早く、待ち時間 (>>66) が等しいか小さいものが実行完了 (タスクが追加完了) されるまで、待つことになっています >>33。

[32] 利用者エージェントは更に加えて任意の時間待っても構いません >>33。電力等利用できる資源の制約や性能上の限界その他の要因により処理を遅らせることができます。

[130] Internet Explorer のタイマーの動作の設定が Windows コントロールパネルの省電力設定内にあります、バッテリー駆動中か電源接続中かでも動作を変更できます。

活性タイマーのリスト

[55] WindowOrWorkerGlobalScope オブジェクト (Window や WorkerGlobalScope) は活性タイマー群のリスト (list of active timers) を持ちます >>33。活性タイマーのリストには、 setTimeout や setInterval で指定されたタイマーが含まれます。

[60] 活性タイマーのリスト内の各項目は、非負整数により識別されます >>33。この非負整数はハンドルと呼ばれています。

[88] ハンドルは、 WindowOrWorkerGlobalScope オブジェクトの生存期間内において固有でなければなりません >>33。

[56] ということは long で表せる数の回数以上はタイマーを使えないことになります。

[89] ハンドルはタイマー初期化手順の実行時 (setInterval の場合は、初回のみ) に利用者エージェント定義の方法で決定されます >>33。タイマー初期化手順はこのハンドルを使って活性タイマーのリストに新しい項目を追加し、そのハンドルを返します >>33。

[4] このリストは、unloading document cleanup steps によって空にされることがあります。

[123] 活性タイマーのリスト内のタイマーが次にいつ実行されるかは、アイドル期間の締切の決定に影響する可能性があります。

タイマーの実行

[74] WindowOrWorkerGlobalScope インターフェイスの setTimeout メソッドと setInterval メソッドは、次のようにしなければなりません >>33。

[76] 取り扱い器を、第1引数を必須の TimerHandler として解釈した結果に設定します。
[79] タイムアウトを、第2引数を long として解釈した結果に設定します。既定値は 0 とします。
[81] 引数群を、第3引数以後すべての引数に設定します。
[95] 繰り返しを、setInterval メソッドなら真、 setTimeout メソッドなら偽に設定します。
[94] 文脈オブジェクト、取り扱い器、タイムアウト、引数群、 繰り返しについて、タイマー初期化手順を実行した結果を返します。 以前のハンドルは、null とします。

[59] タイマー初期化手順 (timer initialization steps) は、 文脈、取り扱い器、タイムアウト、引数群、 繰り返し、以前のハンドルについて、次のようにします >>33。

[73] 文脈が Window なら、
1. [98] 文脈を、文脈のWindowProxy に設定します。
[69] 以前のハンドルが null なら、
1. [82] ハンドルを、文脈の活性タイマーのリストのどの項目のハンドルとも異なる利用者エージェント定義の正整数に設定します。
2. [90] 文脈の活性タイマーのリストに、ハンドルがハンドルの項目を追加します。
[83] それ以外なら、
1. [84] ハンドルを、以前のハンドルに設定します。
[96] 呼び出し元realmを、現在Realm記録に設定します。
[97] 呼び出し先realmを、文脈のRealmに設定します。
[134] 元スクリプトを、活性スクリプトに設定します。
[128] タイムアウトが負の場合、
1. [129] タイムアウトを、0 に設定します。
[104] 現在走っているタスクがタイマータスクなら、
1. [105] 入れ子水準を、現在走っているタスクのタイマー入れ子水準に設定します。
[106] それ以外なら、
1. [107] 入れ子水準を、 0 に設定します。
[108] 入れ子水準が 5 より大きく、タイムアウトが 4 より小さいなら、
1. [109] タイムアウトを、 4 に設定します。
[110] 入れ子水準を、入れ子水準 + 1 に設定します。
[99] タスクを、ハンドル、文脈、取り扱い器、タイムアウト、 引数群、繰り返しフラグ、呼び出し元realm、呼び出し先realm、 入れ子水準に関するタイマータスク (>>77) に設定します。
[112] 文脈においてタイムアウト後のタスクの実行を予約します (>>113)。
[111] ハンドルを返します。

[77] ハンドル、文脈、取り扱い器、 引数群、繰り返しフラグ、 呼び出し元realm、呼び出し先realm、 入れ子水準に関するタイマータスクは、次のようなものです >>33。

処理

[63] 文脈の活性タイマーのリストの、ハンドルがハンドルの項目の消去済みフラグが設定されていれば、
1. [100] ここで停止します。
[62] 取り扱い器により、
[78] Function
コールバック関数の呼び出しを実行します。
コールバック関数
取り扱い器
コールバックthis値
文脈
[80] DOMString
[101] HostEnsureCanCompileStrings(呼び出し元realm、呼び出し先realm) を実行します。例外が投げられたら、例外を報告し、ここで停止します。
[135] 基底URLを、 元スクリプトの基底URLに設定します。
[136] オプション群を、新しいスクリプトfetchオプション群に設定します。
[137] スクリプトfetchオプション群
暗号学的nonce
元スクリプトのfetchオプション群の暗号学的nonce
一貫性メタデータ
空文字列
構文解析器メタデータ
not-parser-inserted
credentialsモード
元スクリプトのfetchオプション群のcredentialsモード
参照元ポリシー
元スクリプトのfetchオプション群の参照元ポリシー
[102] スクリプトを、古典スクリプトの作成を実行した結果に設定します。
ソーステキスト
取り扱い器
設定群オブジェクト
文脈の環境設定群オブジェクト
基底URL
文脈の環境設定群オブジェクトのAPI基底URL
オプション群
オプション群
[103] スクリプトについて古典スクリプトの実行をします。
[65] 繰り返しフラグが真なら、タイマー初期化手順を実行します。 文脈、取り扱い器、タイムアウト、引数群を引き渡します。 繰り返しフラグは真、以前のハンドルはハンドルとします。

タスク源

タイマータスク源 (timer task source)

タイマー入れ子水準

入れ子水準

[85] setInterval に文字列を取り扱い器として指定した場合、毎回スクリプトのコンパイルから行われることになります。

[113] 文脈においてタイムアウト後にタスクを実行するとは、 文脈の実行待ちタイマー群の末尾に新しい組 (タスク, タイムアウト) を追加して、起点を現在時刻として、並列に、次のすべての条件が満たされるまで待ちます >>33。

[114] 文脈が Window なら、
- [115] 起点以後の文脈の文書が完全に活性である時間の合計がタイムアウトミリ秒となる
[116] 文脈が WorkerGlobalScope なら、
- [117] 起点以後の文脈が suspend されていない時間の合計がタイムアウトミリ秒となる
[118] 文脈の実行待ちタイマー群で本組よりも前にあってタイムアウトがタイムアウト以下のものがなくなる
[119] 利用者エージェント定義の条件が満たされる

[120] 条件が満たされたら、組 (タスク, タイムアウト) を文脈の実行待ちタイマー群から削除し、 タスクをタスクキューに追加します >>33。

タイマー消去メソッド

[53] clearTimeout と clearInterval は、いずれも、活性タイマーのリストから引数で指定された数により識別される項目があれば、これを消去します。該当するものがなければ、何もしません。 >>33

[57] 第1引数: long の引数を1つ指定できます >>33。省略した場合の既定値は 0 です >>33。

[54] メソッドの返り値はありません >>33。

[91] WindowOrWorkerGlobal インターフェイスの clearTimeout メソッドと clearInterval メソッドは、次のようにしなければりません >>33。

[92] ハンドルを、第1引数を long として解釈した結果に設定します。既定値は 0 とします。
[93] 文脈オブジェクトの活性タイマーのリストに、ハンドルがハンドルの項目があれば、その消去済みフラグを設定します。

[58] どちらのメソッドも、同じように動作します。 repeat フラグは無視されます。

歴史

[2] IRC logs: freenode / #whatwg / 20070409 (2007-04-12 00:04:42 +09:00 版) http://krijnhoetmer.nl/irc-logs/whatwg/20070409#l-233 (名無しさん 2007-04-11 15:37:28 +00:00)

[6] Re: Proposal: High resolution (and otherwise improved) timer API (Maciej Stachowiak 著, 2008-10-04 06:21:35 +09:00 版) http://lists.w3.org/Archives/Public/public-webapps/2008OctDec/0031.html

I cannot state with certainty that nothing lower than 10ms is safe. Chrome shipped with a 1ms delay and that was found to create problems on a number of sites, including nytimes. They are planning to try 4ms next. We would consider using a lower limit in the official webkit.org version of WebKit, not not as low as 1ms.

[9] IRC logs: freenode / #whatwg / 20090504 (2009-08-05 07:43:45 +09:00 版) http://krijnhoetmer.nl/irc-logs/whatwg/20090504#l-24

[10] [webkit-dev] setTimeout as browser speed throttle (2008-10-01 15:56:01 +09:00 版) http://lists.macosforge.org/pipermail/webkit-dev/2008-September/005093.html

[12] Web Applications 1.0 r5535 Allow timers to be delayed when power usage is an issue.Fixing http://www.w3.org/Bugs/Public/show_bug.cgi?id=10633 ( (2010-09-29 07:08:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=5534&to=5535

[13] Bug 10633 – Minimums for timer granularity should be left to the user agent - different form factors have different power requirements ( (2010-09-29 07:19:30 +09:00 版)) http://www.w3.org/Bugs/Public/show_bug.cgi?id=10633

[14] [whatwg] Timeouts and monotonic vs clock time ( (2011-01-09 13:44:38 +09:00 版)) http://lists.whatwg.org/htdig.cgi/whatwg-whatwg.org/2011-January/029734.html

[15] [whatwg] setTimeout clamps (2011-01-16 12:00:52 +09:00 版) http://lists.whatwg.org/pipermail/whatwg-whatwg.org/2011-January/029886.html

[16] Web Applications 1.0 r5879 Define 'this' for setTimeout functions ( (2011-02-12 08:50:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=5878&to=5879

[17] Web Applications 1.0 r6492 Explain ordering of setTimeout() calls better ( (2011-08-18 06:36:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=6491&to=6492

[18] Web Applications 1.0 r6899 Make setTimeout() not be well-ordered across multiple browsing contexts, so as to allow user agents to e.g. throttle setTimeout()s in background tabs. ( (2012-01-18 07:13:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=6898&to=6899

[19] Web Applications 1.0 r6949 Turns out clearTimeout() and clearInterval() are synonyms! Who knew? Oh what a tangled Web we weave.Fixing https://www.w3.org/Bugs/Public/show_bug.cgi?id=14907 ( (2012-02-01 05:20:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=6948&to=6949

[20] IRC logs: freenode / #whatwg / 20120626 ( (2012-07-12 23:44:39 +09:00 版)) http://krijnhoetmer.nl/irc-logs/whatwg/20120626#l-1008

[21] Window Object 1.0 ( (2006-04-08 02:19:28 +09:00 版)) http://www.w3.org/TR/Window/#timers