9.2. ~server-sent~event

【この訳に固有の表記規約】

この訳の,~algoや定義の記述に利用されている各種記号( ~LET, 此れ, ~IF, ~THROW, 等々)の意味や定義の詳細は、~SYMBOL_DEF_REFを~~参照されたし。

9.2.1. 序論

~INFORMATIVE

~serverが~Web頁に向けて,~HTTPを通じて, あるいは 専用の[ “server-push” ~protocol ]を利用して ~dataを~pushできるようにするため、この仕様は `EventSource$I ~interfaceを導入する。 ◎ To enable servers to push data to Web pages over HTTP or using dedicated server-push protocols, this specification introduces the EventSource interface.

この~APIの用法は、 `EventSource$I ~objを作成して,~event~listenerを登録するだけである。 ◎ Using this API consists of creating an EventSource object and registering an event listener.

var %source = new EventSource('updates.cgi');
%source.onmessage = function (%event) {
  alert(%event.data);
};

~server側の~script(この事例では `updates.cgi^l )は、~MIME型に `text/event-stream$c を伴う~messageを,次の形で送信する: ◎ On the server-side, the script ("updates.cgi" in this case) sends messages in the following form, with the text/event-stream MIME type:

data: 第一~message

data: 第二~message
data: この~messageは 2 行0からなる

data: 第三~message

【 各~messageは、空行(言い換えれば,連続する 2 個以上の改行( `end-of-line$P ))で終端する。 】【 このページの各~stream例は、特に断らない限り,暗黙的に空行で終端されている。 】


作者は、異なる~event型を利用することにより,各~eventを~~分類できる。 ここに 2 種の~event型, `add^l, `remove^l が含まれた~streamがあるとする: ◎ Authors can separate events by using different event types. Here is a stream that has two event types, "add" and "remove":

event: add
data: 73857293

event: remove
data: 2153

event: add
data: 113411

そのような~streamを取扱う~scriptは、次の様になるであろう( %addHandler, %removeHandler は、 1 個の~event引数をとる関数とする): ◎ The script to handle such a stream would look like this (where addHandler and removeHandler are functions that take one argument, the event):

var %source = new EventSource('updates.cgi');
source.addEventListener('add', %addHandler, false);
source.addEventListener('remove', %removeHandler, false);

既定の~event型は `message^l である。 【すなわち、最初の例のように "event:" 行0が省略されている場合】 ◎ The default event type is "message".

~event~streamは、常に~UTF-8として復号される。 別の文字~符号化方式を指定する仕方はない。 ◎ Event streams are always decoded as UTF-8. There is no way to specify another character encoding.


~event~stream要請は、通常の~HTTP要請と同様に,~HTTP `301^st/ `307^st 応答~codeにより~redirectされ得る(できる)。 接続が~closeされた場合、~clientは 再接続することになる。 ~serverは、~HTTP `204^st "No Content" 応答~codeを用いて,~clientにこの再接続を停止するよう伝えれる。 ◎ Event stream requests can be redirected using HTTP 301 and 307 redirects as with normal HTTP requests. Clients will reconnect if the connection is closed; a client can be told to stop reconnecting using the HTTP 204 No Content response code.

この~APIを用いれば — `XMLHttpRequest$I や `iframe$e を用いてそれを模倣せずに — ~UAは、~UAの実装者と~network運用者が より高度に協調できる事例においては,~network資源をより良く利用できるようになる。 これには、携帯機の~battery~~寿命を有意に節約できる便益もある — それについては、 無接続~push節 にて更に論じられる。 ◎ Using this API rather than emulating it using XMLHttpRequest or an iframe allows the user agent to make better use of network resources in cases where the user agent implementer and the network operator are able to coordinate in advance. Amongst other benefits, this can result in significant savings in battery life on portable devices. This is discussed further in the section below on connectionless push.

9.2.2. `EventSource^I ~interface

[`Constructor$m(USVString %url, optional `EventSourceInit$I %eventSourceInitDict), Exposed=(Window,Worker)]
interface `EventSource@I : `EventTarget$I {
  readonly attribute USVString `url$m;
  readonly attribute boolean `withCredentials$m;

  // ready state
  const unsigned short `CONNECTING$m = 0;
  const unsigned short `OPEN$m = 1;
  const unsigned short `CLOSED$m = 2;
  readonly attribute unsigned short `readyState$m;

  // networking
  attribute `EventHandler$I `onopen$m;
  attribute `EventHandler$I `onmessage$m;
  attribute `EventHandler$I `onerror$m;
  void `close$m();
};

dictionary `EventSourceInit@I {
  boolean `~withCredentials0@m = false;
};

各 `EventSource$I ~objには、次のものが結付けられる: ◎ Each EventSource object has the following associated with it:

`~url@eS
`~URL~record$。 構築-時に設定される。 ◎ A url (a URL record). Set during construction.
`要請@eS
初期~時には ~NULL にされ~MUST。 ◎ A request. This must initially be null.
【 これもまた、構築-時に`要請$に設定される。 】
`再接続~時間@eS
~milli秒単位。 初期~時には ~UAにより定義される値 — おそらく,数秒を超えない~~範囲 — にされ~MUST。 ◎ A reconnection time, in milliseconds. This must initially be a user-agent-defined value, probably in the region of a few seconds.
`最後の~event~ID文字列@eS
初期~時には空~文字列にされ~MUST。 ◎ A last event ID string. This must initially be the empty string.

`~url$eS を除き,これらは、現時点では `EventSource$I ~objに公開されていない。 ◎ Apart from url these are not currently exposed on the EventSource object.

`EventSource(url, eventSourceInitDict)@m

この構築子の被呼出時には、次を走らせ~MUST: ◎ The EventSource(url, eventSourceInitDict) constructor, when invoked, must run these steps:

  1. %event ~LET 新たな `EventSource$I ~obj ◎ Let ev be a new EventSource object.
  2. %設定群 ~LET %event に`関連する設定群~obj$ ◎ Let settings be ev's relevant settings object.
  3. %~url~record ~LET `~URL構文解析する$( %~url, %設定群 の`~API基底~URL$, %設定群 の`~API~URL文字~符号化方式$ ) ◎ Let urlRecord be the result of parsing url with settings's API base URL and settings's API URL character encoding.
  4. ~IF[ %~url~record ~EQ 失敗 ] ⇒ ~THROW `SyntaxError$E ◎ If urlRecord is failure, then throw a "SyntaxError" DOMException.
  5. %event の`~url$eS ~SET %~url~record ◎ Set ev's url to urlRecord.
  6. %~CORS属性~状態 ~LET `Anonymous$st ◎ Let corsAttributeState be Anonymous.
  7. ~IF[ %evententSourceInitDict の `~withCredentials0$m ~memberの値 ~EQ ~T ] ⇒# %~CORS属性~状態 ~SET `Use Credentials$st; %event の `withCredentials$m 属性 ~SET ~T ◎ If the value of eventSourceInitDict's withCredentials member is true, then set corsAttributeState to Use Credentials and set ev's withCredentials attribute to true.
  8. %要請 ~LET `~CORSになり得る要請を作成する$( %~url~record, 空~文字列, %~CORS属性~状態, `同一生成元~fallback~flag^i ~ON ) ◎ Let request be the result of creating a potential-CORS request given urlRecord, the empty string, and corsAttributeState, and with the same-origin fallback flag set.
  9. %要請 の`~client$rq ~SET %設定群 ◎ Set request's client to settings.
  10. ~UAの任意選択で ⇒ %要請 の`~header~list$rq内で`~headerを設定する$( `Accept$h / `text/event-stream$bl ) ◎ User agents may set `Accept`/`text/event-stream` in request's header list.
  11. %要請 の`~cache~mode$rq ~SET `no-store^l ◎ Set request's cache mode to "no-store".
  12. %event の`要請$eS ~SET %要請 ◎ Set ev's request to request.
  13. ~RET %event — ただし、以降の手続きは`並列的$に継続する ◎ Return ev, but continue these steps in parallel.
  14. %要請 を`~fetch$する ◎ Fetch request.
`url@m
取得子は、 `~URLを直列化する$( 此れの`~url$eS ) を返さ~MUST。 ◎ The url attribute's getter must return the serialization of this EventSource object's url.
`withCredentials@m
取得子は、最後に初期化された値を返さ~MUST。 此れの作成-時には、 ~F に初期化され~MUST。 ◎ The withCredentials attribute must return the value to which it was last initialized. When the object is created, it must be initialized to false.
`readyState@m

この属性は、当の接続の状態を表現する。 次のいずれかの値をとり得る: ◎ The readyState attribute represents the state of the connection. It can have the following values:

`CONNECTING@m (数値 0 )
接続は、まだ確立されていないか,または ~closeされていて~UAは再接続している。 ◎ The connection has not yet been established, or it was closed and the user agent is reconnecting.
`OPEN@m (数値 1 )
~UAは,~open接続を有していて、~eventが受信され次第 それを配送している。 ◎ The user agent has an open connection and is dispatching events as it receives them.
`CLOSED@m (数値 2 )
接続は~openしておらず,~UAは再接続しようと試行していない。 何らかの致命的~errorがあったか, `close()$m ~methodが呼出された。 ◎ The connection is not open, and the user agent is not trying to reconnect. Either there was a fatal error or the close() method was invoked.
此れの作成-時には、その `readyState$m は `CONNECTING$m ( 0 )に設定され~MUST。 値がいつ変化するかは、下に与える,接続を取扱うための規則にて定義される。 ◎ When the object is created its readyState must be set to CONNECTING (0). The rules given below for handling the connection define when the value changes.
`close()@m
被呼出時には、此れのために開始された`~fetch$ ~algoがあれば すべて中止した上で、 此れの `readyState$m 属性を `CLOSED$m に設定し~MUST。 ◎ The close() method must abort any instances of the fetch algorithm started for this EventSource object, and must set the readyState attribute to CLOSED.

`EventSource$I ~interfaceを実装している~すべての~objは、以下に挙げる各種`~event~handler$, および対応する各種`~event~handler~event型$を,`~event~handler~IDL属性$として~supportし~MUST: ◎ The following are the event handlers (and their corresponding event handler event types) that must be supported, as event handler IDL attributes, by all objects implementing the EventSource interface:

`~event~handler$ `~event~handler~event型$
`onopen@m `open$et
`onmessage@m `message$et
`onerror@m `error$et

9.2.3. 処理~model

`EventSource()$m 構築子の引数にて指示される資源は、その構築子が走るときに~fetchされる。 ◎ The resource indicated in the argument to the EventSource constructor is fetched when the constructor is run.

~dataが受信されるに伴い,それを取扱うために `~network用~task源$から~queueされる`~task$は、以下に従って動作し~MUST: ◎ As data is received, the tasks queued by the networking task source to handle the data must act as follows.

~HTTP `200^st "OK" 応答に対しては、 `Content-Type$h ~header値は 型 `text/event-stream$bl を指定している — `~MIME型$ ~parameterは無視して — ならば, ~event~streamの解釈-法 に従って 行0ごとに処理され~MUST。 ◎ HTTP 200 OK responses with a `Content-Type` header specifying the type `text/event-stream`, ignoring any MIME type parameters, must be processed line by line as described below.

~UAは、自身が~supportする`~MIME型$を伴う応答が成功裡に受信されたときは、~streamの内容を構文解析し始めるときに,`接続を公告-$し~MUST。 ◎ When a successful response with a supported MIME type is received, such that the user agent begins parsing the contents of the stream, the user agent must announce the connection.

`~network用~task源$から`~task~queue$に設置した`~task$が,そのような(正しい`~MIME型$を伴う)資源に対する~fetchingを完了したなら、~UAは,`並列的$に`接続を再確立-$し~MUST。 これは、接続が上品に~closeされようが 予期せず~closeされようが,適用される(が、~UAが ~fetchingを取消したとき(例えば `window.stop()$m に呼応して)には適用されない — そのような事例では `~task$は最終的に実際に破棄されるので)。 ただし、下に挙げる~error条態に対しては、明示的に指定されない限り,適用されない。 ◎ The task that the networking task source places on the task queue once fetching for such a resource (with the correct MIME type) has completed must cause the user agent to reestablish the connection in parallel. This applies whether the connection is closed gracefully or unexpectedly (but does not apply when fetching is canceled by the user agent, e.g., in response to window.stop(), since in those cases the final task is actually discarded). It doesn't apply for the error conditions listed below except where explicitly specified.

~HTTP `200^st "OK" 応答に対しては、応答の `Content-Type$h が[ 伴われていない / 未~supportの型を指定している ]場合、~UAは`接続を失敗させ$~MUST。 ◎ HTTP 200 OK responses that have a Content-Type specifying an unsupported type, or that have no Content-Type at all, must cause the user agent to fail the connection.

最初の~~段階で接続を確立できなくするような,~network~error(例: ~DNS~error)に対しては、~UAは`並列的$に`接続を再確立-$するべきである — ただし,~UAは、そうしても無益なことを知っている場合は,`接続を失敗させ$てよい。 ◎ Network errors that prevents the connection from being established in the first place (e.g. DNS errors), should cause the user agent to reestablish the connection in parallel, unless the user agent knows that to be futile, in which case the user agent may fail the connection.

ここに挙げなかった他の~HTTP応答~codeに対しては, および ~UAが~fetch~algoを取消した場合は(例えば `window.stop()$m に呼応して, あるいは 利用者が~network接続を手動で取消した)、~UAは`接続を失敗させ$~MUST。 ◎ Any other HTTP response code not listed here, as well as the cancelation of the fetch algorithm by the user agent (e.g. in response to window.stop() or the user canceling the network connection manually) must cause the user agent to fail the connection.


~UAは, `接続を公告-@ するときは、次を走らす`~taskを~queueし$~MUST:

  1. %O ~LET 当の `EventSource$I ~obj
  2. ~IF[ %O の `readyState$m 属性~値 ~EQ `CLOSED$m ] ⇒ ~RET
  3. %O の `readyState$m 属性 ~SET `OPEN$m
  4. %O に向けて,名前 `open$et の`~eventを発火-$する
◎ When a user agent is to announce the connection, the user agent must queue a task which, if the readyState attribute is set to a value other than CLOSED, sets the readyState attribute to OPEN and fires an event named open at the EventSource object.

~UAは、 `接続を再確立-@ するときは、次の手続きを走らせ~MUST: ◎ When a user agent is to reestablish the connection, the user agent must run the following steps. These steps are run in parallel, not as part of a task. (The tasks that it queues, of course, are run like normal tasks and not themselves in parallel.)

  1. ~RET — ただし、以降の手続きは`並列的$に継続する ◎ ↑
  2. %O ~LET 当の `EventSource$I ~obj ◎ ↓
  3. 次の手続きを走らす`~taskを~queueする$: ◎ Queue a task to run the following steps:

    1. ~IF[ %O の `readyState$m 属性 ~NEQ `CLOSED$m ] ⇒ ~RET ◎ If the readyState attribute is set to CLOSED, abort the task.
    2. %O の `readyState$m 属性 ~SET `CONNECTING$m ◎ Set the readyState attribute to CONNECTING.
    3. %O に向けて,名前 `error$et の`~eventを発火-$する ◎ Fire an event named error at the EventSource object.
  4. %O の`再接続~時間$eSだけ待機する ◎ Wait a delay equal to the reconnection time of the event source.
  5. ~UAの任意選択で ⇒ 更にいくばくか待機する。 特に、前回の試みが失敗した場合,~serverはすでに過負荷にあるかもしれないので、~UAは ベキ乗打ち切り待機法( exponential backoff )による遅延を導入することもできる。 あるいは,~OSから~network接続できないと報告された場合には、~OSから その~~回復が公告されるまで待機する。 ◎ Optionally, wait some more. In particular, if the previous attempt failed, then user agents might introduce an exponential backoff delay to avoid overloading a potentially already overloaded server. Alternatively, if the operating system has reported that there is no network connectivity, user agents might wait for the operating system to announce that the network connection has returned before retrying.
  6. 上で~queueした~taskがまだ走っていないならば,走るまで待機する ◎ Wait until the aforementioned task has run, if it has not yet run.
  7. 次の手続きを走らす`~taskを~queueする$: ◎ Queue a task to run the following steps:

    1. ~IF[ %O の `readyState$m 属性 ~NEQ `CONNECTING$m ] ⇒ ~RET ◎ If the EventSource object's readyState attribute is not set to CONNECTING, return.
    2. %要請 ~LET %O の`要請$eS ◎ Let request be the EventSource object's request.
    3. ~IF[ %O の`最後の~event~ID文字列$eS ~NEQ 空~文字列 ] ⇒ %要請 の`~header~list$rq内で`~headerを設定する$( `Last-Event-ID$h / `~UTF-8符号化する$( `最後の~event~ID文字列$eS ) ) ◎ If the EventSource object's last event ID string is not the empty string, set `Last-Event-ID`/last event ID string, encoded as UTF-8, in request's header list.
    4. %要請 を`~fetch$する ⇒ この~fetchに対する応答は、この節の最初あたりで述べたように処理する ◎ Fetch request and process the response obtained in this fashion, if any, as described earlier in this section.

~UAは, `接続を失敗させ@ るときは、次を走らす`~taskを~queueし$~MUST: ◎ When a user agent is to fail the connection, the user agent must queue a task which,\

  1. %O ~LET 当の `EventSource$I ~obj ◎ \
  2. ~IF[ %O の `readyState$m 属性 ~NEQ `CLOSED$m ]: ◎ if the readyState attribute is set to a value other than CLOSED,\

    1. %O の `readyState$m 属性 ~SET `CLOSED$m ◎ sets the readyState attribute to CLOSED and\
    2. %O に向けて,名前 `error$et の`~eventを発火-$する ◎ fires an event named error at the EventSource object.\

~UAは、`接続を失敗させ$たときは,再接続しようと 試みないこと ◎ Once the user agent has failed the connection, it does not attempt to reconnect!


`EventSource$I ~objにより`~queueされ$るどの`~task$に対しても,その`~task源$は `~remote~event~task源@ とする。 ◎ The task source for any tasks that are queued by EventSource objects is the remote event task source.

9.2.4. ~event~streamの構文解析

この~event~stream形式の`~MIME型$は、 `text/event-stream$c である。 ◎ This event stream format's MIME type is text/event-stream.

~event~stream形式は、次の `ABNF$r における `stream$P 生成規則で与えられる — この~ABNFの文字~集合は~Unicodeとする: ◎ The event stream format is as described by the stream production of the following ABNF, the character set for which is Unicode. [ABNF]

`stream@P        = [ `bom$P ] *`event$P
`event@P         = *( `comment$P / `field$P ) `end-of-line$P
`comment@P       = `colon$P *`any-char$P `end-of-line$P
`field@P         = 1*`name-char$P [ `colon$P [ `space$P ] *`any-char$P ] `end-of-line$P
`end-of-line@P   = ( `cr$P `lf$P / `cr$P / `lf$P )

; 各種~文字
`lf@P            = `000A^0x ; U+000A LINE FEED (LF)
`cr@P            = `000D^0x ; U+000D CARRIAGE RETURN (CR)
`space@P         = `0020^0x ; U+0020 SPACE
`colon@P         = `003A^0x ; U+003A COLON (:)
`bom@P           = `FEFF^0x ; U+FEFF BYTE ORDER MARK
`name-char@P     = `0000-0009^0x / `000B-000C^0x / `000E-0039^0x / `003B-10FFFF^0x
                ; 
`lf$P, `cr$P, `colon$P 以外の`~scalar値$
◎
; a scalar value other than U+000A LINE FEED (LF), U+000D CARRIAGE RETURN (CR), or U+003A COLON (:)

`any-char@P      = `0000-0009^0x / `000B-000C^0x / `000E-10FFFF^0x
                ; 
`lf$P, `cr$P 以外の`~scalar値$
◎
; a scalar value other than U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR)

この形式による~event~streamは、常に ~UTF-8に符号化され~MUST。 `ENCODING$r ◎ Event streams in this format must always be encoded as UTF-8. [ENCODING]

各 行0どうしは、 `end-of-line$P( `cr$P +`lf$P, `lf$P, `cr$P のいずれか)で分離され~MUST。 ◎ Lines must be separated by either a U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair, a single U+000A LINE FEED (LF) character, or a single U+000D CARRIAGE RETURN (CR) character.

そのような資源のために確立された~remote~serverへの接続は,長く生き残るものと予期されるので、~UAは 適切な~bufferingが利用されることを確保するべきである。 特に,各 行0が 1 個の `lf$P で終端するように定義される~bufferingは安全である一方で、~block~bufferingや, 異なる行0終端-法を期待する行0~bufferingは,~event配送-を遅延させ得る。 ◎ Since connections established to remote servers for such resources are expected to be long-lived, UAs should ensure that appropriate buffering is used. In particular, while line buffering with lines are defined to end with a single U+000A LINE FEED (LF) character is safe, block buffering or line buffering with different expected line endings can cause delays in event dispatch.

9.2.5. ~event~streamの解釈-法

~streamは、`~UTF-8復号する$~algoで復号され~MUST。 ◎ Streams must be decoded using the UTF-8 decode algorithm.

注記: `~UTF-8復号する$~algoは、先頭に~UTF-8 Byte Order Mark ( `bom$P )があれば それを剥ぎ取る。 ◎ The UTF-8 decode algorithm strips one leading UTF-8 Byte Order Mark (BOM), if any.

~streamは、行0ごとに そこに現れるすべてを読取ることにより,構文解析され~MUST。 行0が終端するのは、次のいずれか( “改行” )が現れる所に限られるとする:

  • `cr$P + `lf$P 文字~pair
  • `cr$P が先行しない 1 個の `lf$P
  • `lf$P が後続しない 1 個の `cr$P
【改行~自身は行0には含まれない。】 ◎ The stream must then be parsed by reading everything line by line, with a U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair, a single U+000A LINE FEED (LF) character not preceded by a U+000D CARRIAGE RETURN (CR) character, and a single U+000D CARRIAGE RETURN (CR) character not followed by a U+000A LINE FEED (LF) character being the ways in which a line can end.

~streamを構文解析する~algoの各~instanceには,変数[ %~data~buffer, %~event型~buffer, %最後の~event~ID~buffer ]が結付けられ、いずれも空~文字列に初期化され~MUST。 ◎ When a stream is parsed, a data buffer, an event type buffer, and a last event ID buffer must be associated with it. They must be initialized to the empty string

それは、~EACH ( 行0 %行0 ) に対し,受信された順序で、次を走らす: ◎ Lines must be processed, in the order they are received, as follows:

  1. ~IF[ %行0 は空である(空行) ] ⇒ 下に定義されるように`~eventを配送-$する ◎ If the line is empty (a blank line) ◎ • Dispatch the event, as defined below.
  2. ~ELIF[ %行0 の先頭の文字 ~EQ `colon$P ] ⇒ ~CONTINUE ◎ If the line starts with a U+003A COLON character (:) ◎ • Ignore the line.
  3. ~IF[ %行0 は `colon$P を包含する ]: ◎ If the line contains a U+003A COLON character (:)

    1. ( %名, %値 ) ~LET %行0 内の最初の `colon$P より ( 前の部分の文字列, 後の部分の文字列 ) ◎ Collect the characters on the line before the first U+003A COLON character (:), and let field be that string. ◎ Collect the characters on the line after the first U+003A COLON character (:), and let value be that string. If value starts with a U+0020 SPACE character, remove it from value.
    2. ~IF[ %値 の先頭の文字 ~EQ `space$P ] ⇒ %値 から先頭の文字を除去する ◎ ↑
    3. `~fieldを処理する$( %名, %値 ) ◎ Process the field using the steps described below, using field as the field name and value as the field value.
  4. ~ELSE(文字列は空でないが `colon$P を包含しない) ⇒ `~fieldを処理する$( %行0, 空~文字列 ) ◎ Otherwise, the string is not empty but does not contain a U+003A COLON character (:) ◎ Process the field using the steps described below, using the whole line as the field name, and the empty string as the field value.

~streamの終端-に達したときの最後の~blockが,空行で終端されていない場合、その~blockの~dataは破棄され~MUST。 (そのような~blockに対しては、~eventは配送されない。) (~blockとは、空行で互いに分離されていない,一連の行0を意味する。) ◎ Once the end of the file is reached, any pending data must be discarded. (If the file ends in the middle of an event, before the final empty line, the incomplete event is not dispatched.)


`~fieldを処理する@ ときは、所与の ( %名, %値 ) に対し, %名 に応じて: ◎ The steps to process the field given a field name and a field value depend on the field name, as given in the following list. Field names must be compared literally, with no case folding performed.

`event^l ◎ If the field name is "event"
%~event型~buffer ~SET %値 ◎ Set the event type buffer to field value.
`data^l ◎ If the field name is "data"
%~data~buffer に[ %値, 1 個の `lf$P ]を順に付加する ◎ Append the field value to the data buffer, then append a single U+000A LINE FEED (LF) character to the data buffer.
`id^l ◎ If the field name is "id"

~IF[ %値 は U+0000 NULL を包含しない ] ⇒ %最後の~event~ID~buffer ~SET %値

(他の場合、この~fieldは無視する。)

◎ If the field value does not contain U+0000 NULL, then set the last event ID buffer to the field value. Otherwise, ignore the field.
`retry^l ◎ If the field name is "retry"

~IF[ %値 は`~ASCII数字$のみからなる ] ⇒ ~event~streamの`再接続~時間$eS ~SET %値 を基数 10 の整数に解釈した結果

(他の場合、この~fieldは無視する。)

◎ If the field value consists of only ASCII digits, then interpret the field value as an integer in base ten, and set the event stream's reconnection time to that integer. Otherwise, ignore the field.
他の場合 ◎ Otherwise
何もしない(この~fieldは無視する。) ◎ The field is ignored.
【この例は、訳者による補足。】

したがって、次の例の様に,同じ~block内に複数の `event^l 行0が含まれている場合、最後に現れたものが、他を上書きすることになる( `id^l についても同様になる):

event: add
event: remove
data: 1234

対照的に, `data^l 行0は、行0ごとに~data + `lf$P を付加する。 ただし,~block内の最後の `lf$P は除かれる(下に述べる~eventを配送する手続きの中で除去される)。

~UAは、 `~eventを配送-@ するよう要求されたときは、 ( %~data~buffer, %~event型~buffer, %最後の~event~ID~buffer ) を~UAに適切な手続きを用いて処理し~MUST。 ◎ When the user agent is required to dispatch the event, the user agent must process the data buffer, the event type buffer, and the last event ID buffer using steps appropriate for the user agent.

~Web~browserに対しては、`~eventを配送-$する適切な手続きは,次に従うとする: ◎ For Web browsers, the appropriate steps to dispatch the event are as follows:

  1. %O ~LET 当の `EventSource$I ~obj ◎ ↓
  2. %O の`最後の~event~ID文字列$eS ~SET %最後の~event~ID~buffer ◎ Set the last event ID string of the event source to the value of the last event ID buffer.\

    この~bufferは, 【他の~bufferと違って ~eventが生じるごとに】 再設定されないので、 %O の`最後の~event~ID文字列$eSは,この~bufferが次回に~serverにより設定されるまで残り続ける。 ◎ The buffer does not get reset, so the last event ID string of the event source remains set to this value until the next time it is set by the server.

  3. ~IF[ %~data~buffer ~EQ 空~文字列 ] ⇒# ( %~data~buffer, %~event型~buffer ) ~SET ( 空~文字列, 空~文字列 ); ~RET ◎ If the data buffer is an empty string, set the data buffer and the event type buffer to the empty string and return.
  4. ~IF[ %~data~buffer の最後の文字 ~EQ `lf$P ] ⇒ %~data~buffer から最後の文字を除去する ◎ If the data buffer's last character is a U+000A LINE FEED (LF) character, then remove the last character from the data buffer.
  5. %~event ~LET 次を与える下で,`~eventを作成-$した結果 ⇒ ( %O に`関連する~Realm$, `MessageEvent$I ~interface ) ◎ Let event be the result of creating an event using MessageEvent, in the relevant Realm of the EventSource object.
  6. %~event の各種~属性を次のように初期化する ⇒# `type$m ~SET `message$et, `data$m ~SET %~data, `origin$m ~SET `生成元を直列化する$( 当の~event~streamの最終的な~URL(すなわち,~redirect後の~URL)の`生成元$url ), `lastEventId$m ~SET %O の`最後の~event~ID文字列$eS ◎ Initialize event's type attribute to message, its data attribute to data, its origin attribute to the serialization of the origin of the event stream's final URL (i.e., the URL after redirects), and its lastEventId attribute to the last event ID string of the event source.
  7. ~IF[ %~event型~buffer ~NEQ 空~文字列 ] ⇒ %~event の `type$m ~SET %~event型~buffer ◎ If the event type buffer has a value other than the empty string, change the type of the newly created event to equal the value of the event type buffer.
  8. ( %~data~buffer, %~event型~buffer ) ~SET ( 空~文字列, 空~文字列 ) ◎ Set the data buffer and the event type buffer to the empty string.
  9. 次を走らす`~taskを~queueする$:

    1. ~IF[ %O の `readyState$m 属性~値 ~NEQ `CLOSED$m ] ⇒ %O に向けて %~event を`配送-$する
    ◎ Queue a task which, if the readyState attribute is set to a value other than CLOSED, dispatches the newly created event at the EventSource object.

注記: ~event( `event$P )に `id^l ~fieldが伴われていない場合、その~eventから生じる `MessageEvent$I ~event の `lastEventId$m ~fieldは、最後に~~見出された `id^l ~fieldの値 — すなわち,その前の~eventにより設定された`最後の~event~ID文字列$eS 【 `id^l がまだ見出されていなければ,空~文字列( %最後の~event~ID~buffer の初期~値)】 — に設定されることになる。 ◎ If an event doesn't have an "id" field, but an earlier event did set the event source's last event ID string, then the event's lastEventId field will be set to the value of whatever the last seen "id" field was.

他の~UAに対しては、`~eventを配送-$する適切な手続きは 実装に依存するが、最小限,手続きを終える前に[ %~data~buffer, %~event型~buffer ]を空~文字列に設定し~MUST。 ◎ For other user agents, the appropriate steps to dispatch the event are implementation dependent, but at a minimum they must set the data and event type buffers to the empty string before returning.

次の~event~stream(空行で終端されている)に対しては: ◎ The following event stream, once followed by a blank line:

data: YHOO
data: +2
data: 10

`EventSource$I ~objに向けて, `MessageEvent$I ~interfaceを利用する `message$et ~eventを配送させることになる。 ~eventの `data$m 属性は、文字列 `YHOO\n+2\n10^l を包含することになる( `\n^l は改行文字( `lf$P )を表現する)。 ◎ ...would cause an event message with the interface MessageEvent to be dispatched on the EventSource object. The event's data attribute would contain the string "YHOO\n+2\n10" (where "\n" represents a newline).

これは、次のように利用できる: ◎ This could be used as follows:

var %stocks = new EventSource("https://stocks.example.com/ticker.php");
stocks.onmessage = function (%event) {
  var %data = %event.data.split('\n');
  updateStocks(%data[0], %data[1], %data[2]);
};

( `updateStocks()^c は、~data処理用の何らかの関数。) ◎ ...where updateStocks() is a function defined as: ◎ function updateStocks(symbol, delta, value) { ... } ◎ ...or some such.

次の~streamは、 4 個の~blockを包含する。 1 個目の~blockは、~commentなので,~eventは発火されない。 2 個目の~blockに対しては、~eventが発火されることになる — そこには、名前 `data^l の~field(値に `first event^l を伴う)に加え,名前 `id^l の~fieldもあり、`最後の~event~ID文字列$eS を `1^l に設定することになる。 この~blockと次の~blockの合間で接続が切れた場合、再接続-時に,~serverに向けて値 `1^l を伴う `Last-Event-ID$h ~headerが送信されることになる。 3 個目の~blockも~eventを発火し, `data^l の値に `second event^l を伴うが、 `id^l ~fieldには値は伴われていない — それは、`最後の~event~ID文字列$eS を空~文字列に再設定する(今度は、再接続が試みられる場合には, `Last-Event-ID$h ~headerは送信されないことを意味する)。 最後の 4 個目の~blockは、単に~dataに ` third event^l (先頭の文字は `space$P )を伴わせた~eventを発火する。 最後の~blockであっても,空行で終端させる必要があることに注意 — ~streamが終端するだけでは,最後の~blockに対する~event配送を誘発するには十分でない。 ◎ The following stream contains four blocks. The first block has just a comment, and will fire nothing. The second block has two fields with names "data" and "id" respectively; an event will be fired for this block, with the data "first event", and will then set the last event ID to "1" so that if the connection died between this block and the next, the server would be sent a `Last-Event-ID` header with the value "1". The third block fires an event with data "second event", and also has an "id" field, this time with no value, which resets the last event ID to the empty string (meaning no `Last-Event-ID` header will now be sent in the event of a reconnection being attempted). Finally, the last block just fires an event with the data " third event" (with a single leading space character). Note that the last still has to end with a blank line, the end of the stream is not enough to trigger the dispatch of the last event.

: test stream

data: first event
id: 1

data:second event
id

data:  third event

次の~streamは、最後の~blockは空行で終端されていないならば, 2 個の~eventを発火する: ◎ The following stream fires two events:

data

data
data

data:

1 個目の~blockは、~data が空~文字列にされた~eventを発火する。 2 個目の~blockは、~dataを 1 個の改行文字に設定した上で,~eventを発火する。 3 個目の~blockは、空行が後続していないので,破棄される。 ◎ The first block fires events with the data set to the empty string, as would the last block if it was followed by a blank line. The middle block fires an event with the data set to a single newline character. The last block is discarded because it is not followed by a blank line.

次の~streamは、 2 個の~~等価な~eventを発火する: ◎ The following stream fires two identical events:

data:test

data: test

`colon$P の直後にある 1 個の `space$P は、無視されるので。 ◎ This is because the space after the colon is ignored if present.

9.2.6. 著作~上の注記

旧来の~proxy~serverは、ある種の事例では、短い~timeout後に~HTTP接続を落とすことが知られている。 作者は、およそ毎 15 秒ごとに,~comment行0(`colon$P から開始される行0)を含ませることにより,そのような~proxy~serverに抗して保護できる。 ◎ Legacy proxy servers are known to, in certain cases, drop HTTP connections after a short timeout. To protect against such proxy servers, authors can include a comment line (one starting with a ':' character) every 15 seconds or so.

~event~source接続を[ 互いに, あるいは以前に~serveされた特定の文書 ]に関係させたいと望む作者は、~IP~addressに依拠するのでは,うまく働かないことを見出すであろう — (複数の~proxy~serverを通すことに因り)同じ~clientが 複数の~IP~addressから接続することもあれば、(~proxy~serverを共有していることに因り)複数の~clientが 同じ~IP~addressから接続することもあるので。 文書を~serveするときに,その文書~内に一意な識別子を含ませておいて、接続の確立-時に その識別子を~URLの一部として渡す方が良い。 ◎ Authors wishing to relate event source connections to each other or to specific documents previously served might find that relying on IP addresses doesn't work, as individual clients can have multiple IP addresses (due to having multiple proxy servers) and individual IP addresses can have multiple clients (due to sharing a proxy server). It is better to include a unique identifier in the document when it is served and then pass that identifier as part of the URL when the connection is established.

作者は,また、~HTTPが規定する~chunking 【 おそらく,chunked transfer coding を指す】 は,この~protocolの信頼性に 予期されない負の効果をもたらし得ることにも警戒すること — 特に、~chunkingが~timing要件に関知しない層で行われている場合には。 これが問題になる場合、~event~streamの~serveに対しては,~chunkingを不能化できる。 ◎ Authors are also cautioned that HTTP chunking can have unexpected negative effects on the reliability of this protocol, in particular if the chunking is done by a different layer unaware of the timing requirements. If this is a problem, chunking can be disabled for serving event streams.

~HTTPによる~server単位の接続~数~制限 【 おそらく, RFC7230, 6.4 節 を指す】 を~supportする~clientは、ある~siteから複数の頁を~openしたとき,その各~頁に同じ~domainへの `EventSource$I がある場合に 困らされることもある。 作者がこれを避ける方法には、次が挙げられる:

  • より複雑な仕組みを用いる
  • 接続ごとに一意な~domain名を用いる
  • 利用者が頁ごとに `EventSource$I の機能性を可能化したり不能化できるようにする
  • 単独の `EventSource$I ~objを`共用~worker内$で共有する
◎ Clients that support HTTP's per-server connection limitation might run into trouble when opening multiple pages from a site if each page has an EventSource to the same domain. Authors can avoid this using the relatively complex mechanism of using unique domain names per connection, or by allowing the user to enable or disable the EventSource functionality on a per-page basis, or by sharing a single EventSource object using a shared worker.

9.2.7. 無接続~pushと他の特色機能

制御~下にある環境で走っている~UA — 例えば,特定の~carrierに束ねられている携帯機の~browser — は、接続の管理を~network上の~proxyに負荷移譲してよい。 適合性の目的においては、そのような状況における~UAは,その携帯機~softwareと~network~proxyの両者を含むものと見なされる。 ◎ User agents running in controlled environments, e.g. browsers on mobile handsets tied to specific carriers, may offload the management of the connection to a proxy on the network. In such a situation, the user agent for the purposes of conformance is considered to include both the handset software and the network proxy.

例えば,携帯機の~browserは、接続を確立した後に、その接続は 【~proxyが】 ~supportしている~networkであることを検出して,その~network上の~proxy~serverに接続の管理を司るよう要請するかもしれない。 そのような状況においては、次のような経過を辿ることになる: ◎ For example, a browser on a mobile device, after having established a connection, might detect that it is on a supporting network and request that a proxy server on the network take over the management of the connection. The timeline for such a situation might be as follows:

  1. ~browserは、作者が `EventSource()$m 構築子にて指定した資源を,~remote~HTTP~serverへ接続して要請する。 ◎ Browser connects to a remote HTTP server and requests the resource specified by the author in the EventSource constructor.
  2. ~serverは、各~messageを不定期に送信する。 ◎ The server sends occasional messages.
  3. ~browserは、ある 2 つの~messageの合間に,[ ~TCP接続を~~維持し続けるための~network活動を除き,自身は遊休~中にある ]ことを検出したので、電力を節約するため,~sleep~modeへ切替えることにした。 ◎ In between two messages, the browser detects that it is idle except for the network activity involved in keeping the TCP connection alive, and decides to switch to sleep mode to save power.
  4. ~browserは、~serverから切断される。 ◎ The browser disconnects from the server.
  5. ~browserは、当の接続を保守する代わりに,上述した~network上の~serviceに接触して “~push~proxy” ~serviceを要請する。 ◎ The browser contacts a service on the network, and requests that the service, a "push proxy", maintain the connection instead.
  6. “~push~proxy” ~serviceは、~remote~HTTP~serverに接触して,作者が `EventSource()$m 構築子にて指定した資源を要請する(場合によっては, `Last-Event-ID$h ~HTTP~header, 等々が含まれる)。 ◎ The "push proxy" service contacts the remote HTTP server and requests the resource specified by the author in the EventSource constructor (possibly including a `Last-Event-ID` HTTP header, etc).
  7. ~browserは、携帯機に~sleepすることを許容する。 ◎ The browser allows the mobile device to go to sleep.
  8. ~serverは、別の~messageを送信する。 ◎ The server sends another message.
  9. “~push~proxy” ~serviceは、~eventを携帯機に運ぶため,~OMA~pushなどの技術を利用する — それは、~eventを処理するに足るだけ携帯機を目覚めさせてから,~sleepに戻す。 【OMA = おそらく、 Open Mobile Alliance(携帯電話の規格を策定する組織)を指す。】 ◎ The "push proxy" service uses a technology such as OMA push to convey the event to the mobile device, which wakes only enough to process the event and then returns to sleep.

これは,総~data使用量を抑制する結果、~~相当に電力を節約する。 ◎ This can reduce the total data usage, and can therefore result in considerable power savings.

[ 既存の~API, および `text/event-stream$c 伝送路~形式 ]を[ この仕様により定義されるように, および 上に述べたような より分散的な仕方 ]で実装することに加え、`適用し得る仕様$により定義される~event~framingの形式も~supportされてよい。 この仕様は、それがどう構文解析され, 処理されるかは,定義しない。 ◎ As well as implementing the existing API and text/event-stream wire format as defined by this specification and in more distributed ways as described above, formats of event framing defined by other applicable specifications may be supported. This specification does not define how they are to be parsed or processed.

9.2.8. ~garbage収集

[ `Window$I / `WorkerGlobalScope$I ]~obj %G 内の構築子を呼出して作成された `EventSource$I ~obj %O に対しては、次のいずれかが満たされている間は, %G から %O への強い参照-が~MUST: ◎ ↓

  • [ %O の `readyState$m ~EQ `CONNECTING$m ]~AND[ %O には[ `open$et / `message$et /`error$et ]~eventに対する~event~listenerが 1 個~以上~登録されている ] ◎ While an EventSource object's readyState is CONNECTING, and the object has one or more event listeners registered for open, message or error events, there must be a strong reference from the Window or WorkerGlobalScope object that the EventSource object's constructor was invoked from to the EventSource object itself.
  • [ %O の `readyState$m ~EQ `OPEN$m ]~AND[ %O には[ `message$et / `error$et ]~eventに対する~event~listenerが 1 個~以上~登録されている ] ◎ While an EventSource object's readyState is OPEN, and the object has one or more event listeners registered for message or error events, there must be a strong reference from the Window or WorkerGlobalScope object that the EventSource object's constructor was invoked from to the EventSource object itself.
  • %O により`~remote~event~task源$から~queueされた~taskがある ◎ While there is a task queued by an EventSource object on the remote event task source, there must be a strong reference from the Window or WorkerGlobalScope object that the EventSource object's constructor was invoked from to that EventSource object.

~UAは、 `EventSource$I ~obj %O を `強制的に~closeする@ ときは(これは `Document$I ~objが永続的に消去ったときに起こる),次を走らせ~MUST:

  1. %O のために開始された すべての`~fetch$~algoを中止する
  2. %O の `readyState$m 属性 ~SET `CLOSED$m
◎ If a user agent is to forcibly close an EventSource object (this happens when a Document object goes away permanently), the user agent must abort any instances of the fetch algorithm started for this EventSource object, and must set the readyState attribute to CLOSED.

`EventSource$I ~obj %O が,接続が依然として~openしている間に~garbage収集された場合、 ~UAは, %O のために開始された すべての`~fetch$~algoを中止し~MUST。 ◎ If an EventSource object is garbage collected while its connection is still open, the user agent must abort any instance of the fetch algorithm opened by this EventSource.

9.2.9. 実装への~advice

~INFORMATIVE

この~APIを利用している作者による~codeの~debugを支援するため、~UAには,[ `EventSource$I ~obj, および それに関係する~network接続 ]についての詳細な診断~情報を,開発~console内に提供することが強く督促される。 ◎ User agents are strongly urged to provide detailed diagnostic information about EventSource objects and their related network connections in their development consoles, to aid authors in debugging code using this API.

例えば~UAは、頁が作成した すべての `EventSource$I ~objのそれぞれについて 次を表示するような~panelを備えることもできる: ◎ For example, a user agent could have a panel displaying all the EventSource objects a page has created, each listing\

  • 構築子の引数
  • ~network~errorが生じたかどうか
  • 接続の~CORS~statusは何であるか
  • その~statusに導いた(~clientが送信した/ ~serverから受信された)~headerたち
  • 受信された~message
  • その~messageはどう構文解析されたか
◎ the constructor's arguments, whether there was a network error, what the CORS status of the connection is and what headers were sent by the client and received from the server to lead to that status, the messages that were received and how they were parsed, and so forth.

等々。 とりわけ, `error$et ~eventが発火されたときには、実装には,詳細な情報を自身の開発~consoleに報告することが奨励される — ~event自体から可用になる情報は少ししかないので。 ◎ Implementations are especially encouraged to report detailed information to their development consoles whenever an error event is fired, since little to no information can be made available in the events themselves.