- From: CVS User ihickson <cvsmail@w3.org>
- Date: Wed, 14 May 2014 23:22:07 +0000
- To: public-html-commits@w3.org
Update of /sources/public/html5/websockets In directory roscoe:/tmp/cvs-serv1854 Modified Files: Overview.html Log Message: Big editorial cleanup. No normative changes. (whatwg r8634) --- /sources/public/html5/websockets/Overview.html 2014/04/23 17:05:26 1.313 +++ /sources/public/html5/websockets/Overview.html 2014/05/14 23:22:07 1.314 @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html lang="en-US-x-Hixie"><title>The WebSocket API</title><style type="text/css"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html lang="en-GB-x-Hixie"><title>The WebSocket API</title><style type="text/css"> pre { margin-left: 2em; white-space: pre-wrap; } h2 { margin: 3em 0 1em 0; } h3 { margin: 2.5em 0 1em 0; } @@ -216,7 +216,7 @@ <h1>The WebSocket API</h1> - <h2 class="no-num no-toc" id="editor-s-draft-23-april-2014">Editor's Draft 23 April 2014</h2> + <h2 class="no-num no-toc" id="editor-s-draft-14-may-2014">Editor's Draft 14 May 2014</h2> <dl><dt>Latest Published Version:</dt> <dd><a href="http://www.w3.org/TR/websockets/">http://www.w3.org/TR/websockets/</a></dd> <dt>Latest Editor's Draft:</dt> @@ -350,7 +350,7 @@ </dl><p>The W3C <a href="http://www.w3.org/2008/webapps/">Web Applications Working Group</a> is the W3C working group responsible for this specification's progress along the W3C Recommendation track. - This specification is the 23 April 2014 Editor's Draft. + This specification is the 14 May 2014 Editor's Draft. </p> @@ -754,14 +754,14 @@ <hr><p>The <dfn id="dom-websocket-bufferedamount" title="dom-WebSocket-bufferedAmount"><code>bufferedAmount</code></dfn> attribute must return the number of bytes of application data (UTF-8 text and binary data) that have been queued - using <code title="dom-WebSocket-send"><a href="#dom-websocket-send">send()</a></code> but that, as of the last time the <span>event - loop</span> reached step 1, had not yet been - transmitted to the network. (This thus includes any text sent during the execution of the current - task, regardless of whether the user agent is able to transmit text asynchronously with script - execution.) This does not include framing overhead incurred by the protocol, or buffering done by - the operating system or network hardware. If the connection is closed, this attribute's value will - only increase with each call to the <code title="dom-WebSocket-send"><a href="#dom-websocket-send">send()</a></code> method (the - number does not reset to zero once the connection closes).</p> + using <code title="dom-WebSocket-send"><a href="#dom-websocket-send">send()</a></code> but that, as of the last time the + <span>event loop</span> reached step 1, had not yet been transmitted to the network. (This thus + includes any text sent during the execution of the current task, regardless of whether the user + agent is able to transmit text asynchronously with script execution.) This does not include + framing overhead incurred by the protocol, or buffering done by the operating system or network + hardware. If the connection is closed, this attribute's value will only increase with each call to + the <code title="dom-WebSocket-send"><a href="#dom-websocket-send">send()</a></code> method (the number does not reset to zero once + the connection closes).</p> <div class="example"> @@ -842,16 +842,16 @@ <dd> - <p>If <i>the WebSocket connection is established</i>, and <i title="the WebSocket closing handshake is started">the WebSocket closing handshake has not yet started</i>, then the user agent must <i>send a WebSocket Message</i> comprised of <var title="">data</var> using a binary frame opcode; if the data cannot be sent, e.g. because it would need to be buffered but the buffer is full, the user agent must <a href="#concept-websocket-close-fail" title="concept-websocket-close-fail">flag the WebSocket as full</a> and then <i>close the WebSocket connection</i>. The data to be sent is - the data stored in the buffer described by the <code>ArrayBuffer</code> object. Any invocation of this method with an <code>ArrayBuffer</code> argument that - does not throw an exception must increase the <code title="dom-WebSocket-bufferedAmount"><a href="#dom-websocket-bufferedamount">bufferedAmount</a></code> attribute by the length of the - <code>ArrayBuffer</code> in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsECMA262">[ECMA262]</a></p> + the data stored in the buffer described by the <code>ArrayBuffer</code> object. Any invocation + of this method with an <code>ArrayBuffer</code> argument that does not throw an exception must + increase the <code title="dom-WebSocket-bufferedAmount"><a href="#dom-websocket-bufferedamount">bufferedAmount</a></code> attribute by the + length of the <code>ArrayBuffer</code> in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsECMA262">[ECMA262]</a></p> </dd> @@ -860,7 +860,6 @@ <dd> - <p>If <i>the WebSocket connection is established</i>, and <i title="the WebSocket closing handshake is started">the WebSocket closing handshake has not yet started</i>, then the user agent must <i>send a WebSocket Message</i> comprised of <var title="">data</var> using a binary @@ -868,10 +867,8 @@ buffer is full, the user agent must <a href="#concept-websocket-close-fail" title="concept-websocket-close-fail">flag the WebSocket as full</a> and then <i>close the WebSocket connection</i>. The data to be sent is the data stored in the section of the buffer described by the <code>ArrayBuffer</code> object - that <var title="">data</var> references. Any - invocation of this method with this kind of argument that does not throw an - exception must increase the <code title="dom-WebSocket-bufferedAmount"><a href="#dom-websocket-bufferedamount">bufferedAmount</a></code> - attribute by the length of <var title="">data</var>'s buffer in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsECMA262">[ECMA262]</a></p> + that <var title="">data</var> references. Any invocation of this method with this kind of + argument that does not throw an exception must increase the <code title="dom-WebSocket-bufferedAmount"><a href="#dom-websocket-bufferedamount">bufferedAmount</a></code> attribute by the length of <var title="">data</var>'s buffer in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsECMA262">[ECMA262]</a></p> </dd> @@ -933,20 +930,20 @@ </li> - <li><p>Initialize <var title="">event</var>'s <code title="dom-MessageEvent-origin">origin</code> + <li><p>Initialise <var title="">event</var>'s <code title="dom-MessageEvent-origin">origin</code> attribute to the <span title="Unicode serialization of an origin">Unicode serialization</span> of the <span>origin</span> of the <span>URL</span> that was passed to the <code><a href="#websocket">WebSocket</a></code> object's constructor.</li> <li> - <p>If <var title="">type</var> indicates that the data is Text, then initialize <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute to <var title="">data</var>. + <p>If <var title="">type</var> indicates that the data is Text, then initialise <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute to <var title="">data</var>. <p>If <var title="">type</var> indicates that the data is Binary, and <code title="dom-WebSocket-binaryType"><a href="#dom-websocket-binarytype">binaryType</a></code> is set to "<code title="">blob</code>", then - initialize <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute + initialise <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute to a new <code>Blob</code> object that represents <var title="">data</var> as its raw data. <a href="#refsFILEAPI">[FILEAPI]</a></p> - <p>If <var title="">type</var> indicates that the data is Binary, and <code title="dom-WebSocket-binaryType"><a href="#dom-websocket-binarytype">binaryType</a></code> is set to "<code title="">arraybuffer</code>", then initialize <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute to a new <code>ArrayBuffer</code> + <p>If <var title="">type</var> indicates that the data is Binary, and <code title="dom-WebSocket-binaryType"><a href="#dom-websocket-binarytype">binaryType</a></code> is set to "<code title="">arraybuffer</code>", then initialise <var title="">event</var>'s <code title="dom-MessageEvent-data">data</code> attribute to a new <code>ArrayBuffer</code> object whose contents are <var title="">data</var>. <a href="#refsECMA262">[ECMA262]</a></p> </li> @@ -998,10 +995,10 @@ <li><p>Create a <span title="concept-events-trusted">trusted</span> event that uses the <code><a href="#closeevent">CloseEvent</a></code> interface, with the event type <code title="event-close">close</code>, - which does not bubble, is not cancelable, has no default action, whose <code title="dom-CloseEvent-wasClean"><a href="#dom-closeevent-wasclean">wasClean</a></code> attribute is initialized to true if the - connection closed <i title="">cleanly</i> and false otherwise, whose <code title="dom-CloseEvent-code"><a href="#dom-closeevent-code">code</a></code> attribute is initialized to <i>the WebSocket connection + which does not bubble, is not cancelable, has no default action, whose <code title="dom-CloseEvent-wasClean"><a href="#dom-closeevent-wasclean">wasClean</a></code> attribute is initialised to true if the + connection closed <i title="">cleanly</i> and false otherwise, whose <code title="dom-CloseEvent-code"><a href="#dom-closeevent-code">code</a></code> attribute is initialised to <i>the WebSocket connection close code</i>, and whose <code title="dom-CloseEvent-reason"><a href="#dom-closeevent-reason">reason</a></code> attribute is - initialized to the result of applying the <span>UTF-8 decoder</span> to <i>the WebSocket + initialised to the result of applying the <span>UTF-8 decoder</span> to <i>the WebSocket connection close reason</i>, and <span title="concept-event-dispatch">dispatch</span> the event at the <code><a href="#websocket">WebSocket</a></code> object. <a href="#refsWSP">[WSP]</a></li> @@ -1123,39 +1120,36 @@ };</pre> <p>The <dfn id="dom-closeevent-wasclean" title="dom-CloseEvent-wasClean"><code>wasClean</code></dfn> attribute must return the - value it was initialized to. When the object is created, this attribute must be initialized to + value it was initialised to. When the object is created, this attribute must be initialised to false. It represents whether the connection closed cleanly or not.</p> <p>The <dfn id="dom-closeevent-code" title="dom-CloseEvent-code"><code>code</code></dfn> attribute must return the value it - was initialized to. When the object is created, this attribute must be initialized to zero. It + was initialised to. When the object is created, this attribute must be initialised to zero. It represents the WebSocket connection close code provided by the server.</p> <p>The <dfn id="dom-closeevent-reason" title="dom-CloseEvent-reason"><code>reason</code></dfn> attribute must return the - value it was initialized to. When the object is created, this attribute must be initialized to + value it was initialised to. When the object is created, this attribute must be initialised to empty string. It represents the WebSocket connection close reason provided by the server.</p> <h2 id="garbage-collection"><span class="secno">9 </span>Garbage collection</h2> - <p>A <code><a href="#websocket">WebSocket</a></code> object whose <code title="dom-WebSocket-readyState"><a href="#dom-websocket-readystate">readyState</a></code> attribute's value was set to <code title="dom-WebSocket-CONNECTING"><a href="#dom-websocket-connecting">CONNECTING</a></code> (0) as of - the last time the <span>event loop</span> started reached step 1 must not be garbage collected if there are any event listeners - registered for <code title="event-open">open</code> events, <code title="event-message">message</code> events, <code title="event-error">error</code> events, or + the last time the <span>event loop</span> started reached step 1 must not be garbage collected if + there are any event listeners registered for <code title="event-open">open</code> events, <code title="event-message">message</code> events, <code title="event-error">error</code> events, or <code title="event-close">close</code> events.</p> - <p>A <code><a href="#websocket">WebSocket</a></code> object whose <code title="dom-WebSocket-readyState"><a href="#dom-websocket-readystate">readyState</a></code> attribute's value was set to <code title="dom-WebSocket-OPEN"><a href="#dom-websocket-open">OPEN</a></code> (1) as of the last time - the <span>event loop</span> reached step 1 must not be - garbage collected if there are any event listeners registered for <code title="event-message">message</code> events, <code title="event-error">error</code>, or <code title="event-close">close</code> events.</p> - + the <span>event loop</span> reached step 1 must not be garbage collected if there are any event + listeners registered for <code title="event-message">message</code> events, <code title="event-error">error</code>, or <code title="event-close">close</code> events.</p> <p>A <code><a href="#websocket">WebSocket</a></code> object whose <code title="dom-WebSocket-readyState"><a href="#dom-websocket-readystate">readyState</a></code> - attribute's value was set to <code title="dom-WebSocket-CLOSING"><a href="#dom-websocket-closing">CLOSING</a></code> (2) as of the last - time the <span>event loop</span> reached step 1 must - not be garbage collected if there are any event listeners registered for <code title="event-error">error</code> or <code title="event-close">close</code> events.</p> + attribute's value was set to <code title="dom-WebSocket-CLOSING"><a href="#dom-websocket-closing">CLOSING</a></code> (2) as of the + last time the <span>event loop</span> reached step 1 must not be garbage collected if there are + any event listeners registered for <code title="event-error">error</code> or <code title="event-close">close</code> events.</p> <p>A <code><a href="#websocket">WebSocket</a></code> object with <i title="the WebSocket connection is established">an established connection</i> that has data queued to be transmitted to the network must not be
Received on Wednesday, 14 May 2014 23:22:08 UTC