- From: CVS User ihickson <cvsmail@w3.org>
- Date: Fri, 17 Jan 2014 08:12:35 +0000
- To: public-html-commits@w3.org
Update of /sources/public/html5/websockets
In directory roscoe:/tmp/cvs-serv25631
Modified Files:
Overview.html
Log Message:
Various editorial tweaks. (whatwg r8405)
--- /sources/public/html5/websockets/Overview.html 2014/01/08 23:55:15 1.306
+++ /sources/public/html5/websockets/Overview.html 2014/01/17 08:12:35 1.307
@@ -216,7 +216,7 @@
<h1>The WebSocket API</h1>
- <h2 class="no-num no-toc" id="editor-s-draft-8-january-2014">Editor's Draft 8 January 2014</h2>
+ <h2 class="no-num no-toc" id="editor-s-draft-17-january-2014">Editor's Draft 17 January 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 8 January 2014 Editor's Draft.
+ This specification is the 17 January 2014 Editor's Draft.
</p>
@@ -547,10 +547,9 @@
<var title="">secure</var>. If this fails, throw a <code>SyntaxError</code> exception and abort
these steps. <a href="#refsWSP">[WSP]</a></li>
-
- <li><p>If <var title="">secure</var> is false but the <span>origin</span> specified by the <span>entry
- settings object</span> has a scheme component that is itself a secure protocol, e.g. HTTPS, then throw a
- <code>SecurityError</code> exception and abort these steps.</li>
+ <li><p>If <var title="">secure</var> is false but the <span>origin</span> specified by the
+ <span>entry settings object</span> has a scheme component that is itself a secure protocol, e.g.
+ HTTPS, then throw a <code>SecurityError</code> exception and abort these steps.</li>
<li>
@@ -559,8 +558,7 @@
block access to well-known ports like SMTP.)</p>
- <p>Access to ports 80 and 443 should not be blocked, including the unlikely cases when <var title="">secure</var> is false but <var title="">port</var> is 443 or <var title="">secure</var>
- is true but <var title="">port</var> is 80.</p>
+ <p>Access to ports 80 and 443 should not be blocked, including the unlikely cases when <var title="">secure</var> is false but <var title="">port</var> is 443 or <var title="">secure</var> is true but <var title="">port</var> is 80.</p>
</li>
@@ -579,10 +577,9 @@
WebSocket protocol specification, then throw a <code>SyntaxError</code> exception and abort these
steps. <a href="#refsWSP">[WSP]</a></li>
-
- <li><p>Let <var title="">origin</var> be the <span title="ASCII serialization of an origin">ASCII
- serialization</span> of the <span>origin</span> specified by the <span>entry settings object</span>, <span>converted
- to ASCII lowercase</span>.</li>
+ <li><p>Let <var title="">origin</var> be the <span title="ASCII serialization of an
+ origin">ASCII serialization</span> of the <span>origin</span> specified by the <span>entry
+ settings object</span>, <span>converted to ASCII lowercase</span>.</li>
<li><p>Return a new <code><a href="#websocket">WebSocket</a></code> object, but continue these steps
asynchronously.</li>
@@ -681,7 +678,7 @@
reason</var> as UTF-8.</li>
<li><p>If <var title="">reason</var> is longer than 123 bytes, then throw a
- <code>SyntaxError</code> exception and abort these steps. <a href="#refsRFC3629">[RFC3629]</a></li>
+ <code>SyntaxError</code> exception and abort these steps. <a href="#refsENCODING">[ENCODING]</a></li>
</ol></li>
@@ -724,7 +721,7 @@
WebSocket Close message must be the integer given by the first argument. <a href="#refsWSP">[WSP]</a></p>
<p>If the second argument is also present, then <var title="">reason</var> must be provided in
- the Close message after the status code<!--CLOSE CODE-->. <a href="#refsRFC3629">[RFC3629]</a>
+ the Close message after the status code<!--CLOSE CODE-->. <a href="#refsENCODING">[ENCODING]</a>
<a href="#refsWSP">[WSP]</a></p>
<p class="note">The <i>start the WebSocket closing handshake</i> algorithm eventually invokes
@@ -786,18 +783,17 @@
string "<code title="">blob</code>". On getting, it must return the last value it was set to. On
setting, the user agent must set the IDL attribute to the new value.</p>
-
<p class="note">This attribute allows authors to control how binary data is exposed to scripts. By
setting the attribute to "<code title="">blob</code>", binary data is returned in
<code>Blob</code> form; by setting it to "<code title="">arraybuffer</code>", it is returned in
<code>ArrayBuffer</code> form. User agents can use this as a hint for how to handle incoming
binary data: if the attribute is set to "<code title="">blob</code>", it is safe to spool it to
- disk, and if it is set to "<code title="">arraybuffer</code>", it is likely more efficient to keep
- the data in memory. Naturally, user agents are encouraged to use more subtle heuristics to decide
- whether to keep incoming data in memory or not, e.g. based on how big the data is or how common it
- is for a script to change the attribute at the last minute. This latter aspect is important in
- particular because it is quite possible for the attribute to be changed after the user agent has
- received the data but before the user agent has fired the event for it.</p>
+ disk, and if it is set to "<code title="">arraybuffer</code>", it is likely more efficient to
+ keep the data in memory. Naturally, user agents are encouraged to use more subtle heuristics to
+ decide whether to keep incoming data in memory or not, e.g. based on how big the data is or how
+ common it is for a script to change the attribute at the last minute. This latter aspect is
+ important in particular because it is quite possible for the attribute to be changed after the
+ user agent has received the data but before the user agent has fired the event for it.</p>
<p>The <dfn id="dom-websocket-send" title="dom-WebSocket-send"><code>send(<var title="">data</var>)</code></dfn> method
transmits data using the connection. If the <code title="dom-WebSocket-readyState"><a href="#dom-websocket-readystate">readyState</a></code> attribute is <code title="dom-WebSocket-CONNECTING"><a href="#dom-websocket-connecting">CONNECTING</a></code>, it must throw an
@@ -808,17 +804,14 @@
<dd>
-
- <p>Let <var title="">data</var> be the result of <span title="convert a DOMString to a sequence
- of Unicode characters">converting the <var title="">data</var> argument to a sequence of Unicode
- characters</span>. 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
- text 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>. Any invocation of this method with a
- string 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 number of bytes
- needed to express the argument as UTF-8. <a href="#refsUNICODE">[UNICODE]</a> <a href="#refsRFC3629">[RFC3629]</a> <a href="#refsWSP">[WSP]</a></p>
+ <p>Let <var title="">data</var> be the result of <span title="convert a DOMString to a
+ sequence of Unicode characters">converting the <var title="">data</var> argument to a sequence
+ of Unicode characters</span>. 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 text 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>. Any invocation of this method with a string 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 number of bytes
+ needed to express the argument as UTF-8. <a href="#refsUNICODE">[UNICODE]</a> <a href="#refsENCODING">[ENCODING]</a> <a href="#refsWSP">[WSP]</a></p>
</dd>
@@ -827,14 +820,13 @@
<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 raw data
- represented by the <code>Blob</code> object. Any invocation of this method with a
+ 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 raw data represented by the <code>Blob</code> object. Any invocation of this method with a
<code>Blob</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 size of the
<code>Blob</code> object's raw data, in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsFILEAPI">[FILEAPI]</a></p>
@@ -845,17 +837,15 @@
<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="#refsTYPEDARRAY">[TYPEDARRAY]</a></p>
+ 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="#refsTYPEDARRAY">[TYPEDARRAY]</a></p>
</dd>
@@ -864,24 +854,24 @@
<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 section of the buffer described by the <code>ArrayBuffer</code> object that the
- <code>ArrayBufferView</code> object references. Any invocation of
- this method with an <code>ArrayBufferView</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>ArrayBufferView</code> in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsTYPEDARRAY">[TYPEDARRAY]</a></p>
+ 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 the <code>ArrayBufferView</code> object references. Any
+ invocation of this method with an <code>ArrayBufferView</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>ArrayBufferView</code> in bytes. <a href="#refsWSP">[WSP]</a> <a href="#refsTYPEDARRAY">[TYPEDARRAY]</a></p>
</dd>
</dl><hr><p>The following are the <span>event handlers</span> (and their corresponding <span title="event
- handler event type">event handler event types</span>) that must be supported, as <span>event handler IDL attributes</span>,
- by all objects implementing the <code><a href="#websocket">WebSocket</a></code> interface:</p>
+ handler event type">event handler event types</span>) that must be supported, as <span>event
+ handler IDL attributes</span>, by all objects implementing the <code><a href="#websocket">WebSocket</a></code>
+ interface:</p>
<table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
<tbody><tr><td><dfn id="handler-websocket-onopen" title="handler-WebSocket-onopen"><code>onopen</code></dfn> <td> <code title="event-open">open</code>
@@ -909,7 +899,7 @@
<li><p>Act as if the user agent had <span title="receives a set-cookie-string">received a
set-cookie-string</span> consisting of the <i>cookies set during the server's opening
- handshake</i>, for the URL <var title="">url</var> given to the <code title="dom-WebSocket"><a href="#dom-websocket">WebSocket()</a></code> constructor. <a href="#refsCOOKIES">[COOKIES]</a> <a href="#refsRFC3629">[RFC3629]</a> <a href="#refsWSP">[WSP]</a></li>
+ handshake</i>, for the URL <var title="">url</var> given to the <code title="dom-WebSocket"><a href="#dom-websocket">WebSocket()</a></code> constructor. <a href="#refsCOOKIES">[COOKIES]</a> <a href="#refsENCODING">[ENCODING]</a> <a href="#refsWSP">[WSP]</a></li>
<li><p><span>Fire a simple event</span> named <code title="event-open">open</code> at the
<code><a href="#websocket">WebSocket</a></code> object.</p>
@@ -995,16 +985,14 @@
<ol><li><p>Change the <code title="dom-WebSocket-readyState"><a href="#dom-websocket-readystate">readyState</a></code> attribute's value to
<code title="dom-WebSocket-CLOSED"><a href="#dom-websocket-closed">CLOSED</a></code> (3).</li>
-
<li><p>If the user agent was required to <i>fail the WebSocket connection</i>, or if the <i title="the WebSocket connection is closed">the WebSocket connection was closed</i> after being
- <dfn id="concept-websocket-close-fail" title="concept-websocket-close-fail">flagged as full</dfn>,
- <span>fire a simple event</span> named <code title="">error</code> at the <code><a href="#websocket">WebSocket</a></code>
- object. <a href="#refsWSP">[WSP]</a></li>
+ <dfn id="concept-websocket-close-fail" title="concept-websocket-close-fail">flagged as full</dfn>, <span>fire a simple
+ event</span> named <code title="">error</code> at the <code><a href="#websocket">WebSocket</a></code> object. <a href="#refsWSP">[WSP]</a></li>
<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
+ <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
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
connection close reason</i>, and <span title="concept-event-dispatch">dispatch</span> the event
@@ -1074,7 +1062,7 @@
<li>
<p><span title="resolve a url">Resolve</span> the <var title="">url</var> string, with the URL
- character encoding set to UTF-8. <a href="#refsRFC3629">[RFC3629]</a></p>
+ character encoding set to UTF-8. <a href="#refsENCODING">[ENCODING]</a></p>
<p class="note">It doesn't matter what it is resolved relative to, since we already know it is
an <span>absolute URL</span> at this point.</p>
@@ -1212,6 +1200,9 @@
<dt id="refsDOM">[DOM]</dt>
<dd><cite><a href="http://dom.spec.whatwg.org/">DOM</a></cite>, A. van Kesteren, A. Gregor, Ms2ger. WHATWG.</dd>
+ <dt id="refsENCODING">[ENCODING]</dt>
+ <dd><cite><a href="http://encoding.spec.whatwg.org/">Encoding</a></cite>, A. van Kesteren, J. Bell. WHATWG.</dd>
+
<dt id="refsFILEAPI">[FILEAPI]</dt>
<dd><cite><a href="http://dev.w3.org/2006/webapi/FileUpload/publish/FileAPI.html">File API</a></cite>, A. Ranganathan. W3C.</dd>
@@ -1221,9 +1212,6 @@
<dt id="refsRFC2119">[RFC2119]</dt>
<dd><cite><a href="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. IETF.</dd>
- <dt id="refsRFC3629">[RFC3629]</dt>
- <dd><cite><a href="http://tools.ietf.org/html/rfc3629">UTF-8, a transformation format of ISO 10646</a></cite>, F. Yergeau. IETF.</dd>
-
<dt id="refsTYPEDARRAY">[TYPEDARRAY]</dt>
<dd><cite><a href="http://www.khronos.org/registry/typedarray/specs/latest/">Typed Array Specification</a></cite>, D. Herman, K. Russell. Khronos.</dd>
@@ -1238,7 +1226,6 @@
</dl><h2 class="no-num" id="acknowledgements">Acknowledgements</h2>
- <p>For a full list of acknowledgements, please see the HTML
- specification. <a href="#refsHTML">[HTML]</a></p>
+ <p>For a full list of acknowledgements, please see the <a href="http://whatwg.org/html">WHATWG HTML standard</a>.</p>
Received on Friday, 17 January 2014 08:12:38 UTC