[html5] r8298 - [e] (0) Reword the concept of closing a WebSocket with prejudice so that it's mo [...]
whatwg at whatwg.org
whatwg at whatwg.org
Tue Nov 19 13:15:38 PST 2013
Author: ianh
Date: 2013-11-19 13:15:37 -0800 (Tue, 19 Nov 2013)
New Revision: 8298
Modified:
complete.html
index
source
Log:
[e] (0) Reword the concept of closing a WebSocket with prejudice so that it's more obviously a flag
Fixing https://www.w3.org/Bugs/Public/show_bug.cgi?id=23601
Affected topics: HTML
Modified: complete.html
===================================================================
--- complete.html 2013-11-19 20:20:46 UTC (rev 8297)
+++ complete.html 2013-11-19 21:15:37 UTC (rev 8298)
@@ -79231,6 +79231,7 @@
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>
+<!--CLEANUP-->
<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><a href=#blob>Blob</a></code> form; by setting it to "<code title="">arraybuffer</code>", it is returned in
@@ -79252,13 +79253,15 @@
<dd>
+<!--CLEANUP-->
<p>Let <var title="">data</var> be the result of <a href=#convert-a-domstring-to-a-sequence-of-unicode-characters title="convert a DOMString to a sequence
of Unicode characters">converting the <var title="">data</var> argument to a sequence of Unicode
characters</a>. If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i> and <i title="the WebSocket
closing handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></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>
@@ -79269,11 +79272,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the raw data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the raw data
represented by the <code><a href=#blob>Blob</a></code> object. <!-- that sentence is meant to invoke "This
interface represents immutable raw data." --> Any invocation of this method with a
<code><a href=#blob>Blob</a></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
@@ -79287,11 +79292,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the data
stored in the buffer described by the <code><a href=#arraybuffer>ArrayBuffer</a></code> object. <!-- that sentence is
meant to invoke "The ArrayBuffer type describes a buffer used to store data for the array buffer
views." at the top of the Typed Array spec, and "Optional byteOffset and length can be used to
@@ -79308,11 +79315,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the data
stored in the section of the buffer described by the <code><a href=#arraybuffer>ArrayBuffer</a></code> object that the
<code><a href=#arraybufferview>ArrayBufferView</a></code> object references. <!-- that sentence is meant to invoke "The
ArrayBuffer type describes a buffer used to store data for the array buffer views." at the top
@@ -79438,8 +79447,9 @@
<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><a href=#fail-the-websocket-connection>fail the WebSocket connection</a></i> or <i><a href=#the-websocket-connection-is-closed>the WebSocket
- connection is closed</a></i> <dfn id=concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</dfn>,
+<!--CLEANUP-->
+ <li><p>If the user agent was required to <i><a href=#fail-the-websocket-connection>fail the WebSocket connection</a></i>, or if the <i title="the WebSocket connection is closed"><a href=#the-websocket-connection-is-closed>the WebSocket connection was closed</a></i> after being
+ <dfn id=concept-websocket-close-fail title=concept-websocket-close-fail>flagged as full</dfn>,
<a href=#fire-a-simple-event>fire a simple event</a> named <code title="">error</code> at the <code><a href=#websocket>WebSocket</a></code>
object. <a href=#refsWSP>[WSP]</a></li>
Modified: index
===================================================================
--- index 2013-11-19 20:20:46 UTC (rev 8297)
+++ index 2013-11-19 21:15:37 UTC (rev 8298)
@@ -79231,6 +79231,7 @@
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>
+<!--CLEANUP-->
<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><a href=#blob>Blob</a></code> form; by setting it to "<code title="">arraybuffer</code>", it is returned in
@@ -79252,13 +79253,15 @@
<dd>
+<!--CLEANUP-->
<p>Let <var title="">data</var> be the result of <a href=#convert-a-domstring-to-a-sequence-of-unicode-characters title="convert a DOMString to a sequence
of Unicode characters">converting the <var title="">data</var> argument to a sequence of Unicode
characters</a>. If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i> and <i title="the WebSocket
closing handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></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>
@@ -79269,11 +79272,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the raw data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the raw data
represented by the <code><a href=#blob>Blob</a></code> object. <!-- that sentence is meant to invoke "This
interface represents immutable raw data." --> Any invocation of this method with a
<code><a href=#blob>Blob</a></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
@@ -79287,11 +79292,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the data
stored in the buffer described by the <code><a href=#arraybuffer>ArrayBuffer</a></code> object. <!-- that sentence is
meant to invoke "The ArrayBuffer type describes a buffer used to store data for the array buffer
views." at the top of the Typed Array spec, and "Optional byteOffset and length can be used to
@@ -79308,11 +79315,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i><a href=#the-websocket-connection-is-established>the WebSocket connection is established</a></i>, and <i title="the WebSocket closing
handshake is started"><a href=#the-websocket-closing-handshake-is-started>the WebSocket closing handshake has not yet started</a></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 <i><a href=#close-the-websocket-connection>close the WebSocket connection</a></i> <a href=#concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</a>. The data to be sent is the data
+ 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><a href=#close-the-websocket-connection>close the WebSocket connection</a></i>. The data to be sent is the data
stored in the section of the buffer described by the <code><a href=#arraybuffer>ArrayBuffer</a></code> object that the
<code><a href=#arraybufferview>ArrayBufferView</a></code> object references. <!-- that sentence is meant to invoke "The
ArrayBuffer type describes a buffer used to store data for the array buffer views." at the top
@@ -79438,8 +79447,9 @@
<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><a href=#fail-the-websocket-connection>fail the WebSocket connection</a></i> or <i><a href=#the-websocket-connection-is-closed>the WebSocket
- connection is closed</a></i> <dfn id=concept-websocket-close-fail title=concept-websocket-close-fail>with prejudice</dfn>,
+<!--CLEANUP-->
+ <li><p>If the user agent was required to <i><a href=#fail-the-websocket-connection>fail the WebSocket connection</a></i>, or if the <i title="the WebSocket connection is closed"><a href=#the-websocket-connection-is-closed>the WebSocket connection was closed</a></i> after being
+ <dfn id=concept-websocket-close-fail title=concept-websocket-close-fail>flagged as full</dfn>,
<a href=#fire-a-simple-event>fire a simple event</a> named <code title="">error</code> at the <code><a href=#websocket>WebSocket</a></code>
object. <a href=#refsWSP>[WSP]</a></li>
Modified: source
===================================================================
--- source 2013-11-19 20:20:46 UTC (rev 8297)
+++ source 2013-11-19 21:15:37 UTC (rev 8298)
@@ -88740,6 +88740,7 @@
string "<code data-x="">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>
+<!--CLEANUP-->
<p class="note">This attribute allows authors to control how binary data is exposed to scripts. By
setting the attribute to "<code data-x="">blob</code>", binary data is returned in
<code>Blob</code> form; by setting it to "<code data-x="">arraybuffer</code>", it is returned in
@@ -88765,14 +88766,15 @@
<dd>
+<!--CLEANUP-->
<p>Let <var data-x="">data</var> be the result of <span data-x="convert a DOMString to a sequence
of Unicode characters">converting the <var data-x="">data</var> argument to a sequence of Unicode
characters</span>. If <i>the WebSocket connection is established</i> and <i data-x="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 data-x="">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 <i>close the WebSocket connection</i> <span
- data-x="concept-websocket-close-fail">with prejudice</span>. Any invocation of this method with a
+ buffer is full, the user agent must <span data-x="concept-websocket-close-fail">flag the WebSocket
+ as full</span> 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
data-x="dom-WebSocket-bufferedAmount">bufferedAmount</code> attribute by the number of bytes
needed to express the argument as UTF-8. <a href="#refsUNICODE">[UNICODE]</a> <a
@@ -88785,12 +88787,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i>the WebSocket connection is established</i>, and <i data-x="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 data-x="">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 <i>close the WebSocket connection</i> <span
- data-x="concept-websocket-close-fail">with prejudice</span>. The data to be sent is the raw data
+ buffer is full, the user agent must <span data-x="concept-websocket-close-fail">flag the WebSocket
+ as full</span> and then <i>close the WebSocket connection</i>. The data to be sent is the raw data
represented by the <code>Blob</code> object. <!-- that sentence is meant to invoke "This
interface represents immutable raw data." --> Any invocation of this method with a
<code>Blob</code> argument that does not throw an exception must increase the <code
@@ -88805,12 +88808,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i>the WebSocket connection is established</i>, and <i data-x="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 data-x="">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 <i>close the WebSocket connection</i> <span
- data-x="concept-websocket-close-fail">with prejudice</span>. The data to be sent is the data
+ buffer is full, the user agent must <span data-x="concept-websocket-close-fail">flag the WebSocket
+ as full</span> 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. <!-- that sentence is
meant to invoke "The ArrayBuffer type describes a buffer used to store data for the array buffer
views." at the top of the Typed Array spec, and "Optional byteOffset and length can be used to
@@ -88828,12 +88832,13 @@
<dd>
+<!--CLEANUP-->
<p>If <i>the WebSocket connection is established</i>, and <i data-x="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 data-x="">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 <i>close the WebSocket connection</i> <span
- data-x="concept-websocket-close-fail">with prejudice</span>. The data to be sent is the data
+ buffer is full, the user agent must <span data-x="concept-websocket-close-fail">flag the WebSocket
+ as full</span> 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. <!-- that sentence is meant to invoke "The
ArrayBuffer type describes a buffer used to store data for the array buffer views." at the top
@@ -89012,8 +89017,10 @@
<li><p>Change the <code data-x="dom-WebSocket-readyState">readyState</code> attribute's value to
<code data-x="dom-WebSocket-CLOSED">CLOSED</code> (3).</p></li>
- <li><p>If the user agent was required to <i>fail the WebSocket connection</i> or <i>the WebSocket
- connection is closed</i> <dfn data-x="concept-websocket-close-fail">with prejudice</dfn>,
+<!--CLEANUP-->
+ <li><p>If the user agent was required to <i>fail the WebSocket connection</i>, or if the <i
+ data-x="the WebSocket connection is closed">the WebSocket connection was closed</i> after being
+ <dfn data-x="concept-websocket-close-fail">flagged as full</dfn>,
<span>fire a simple event</span> named <code data-x="">error</code> at the <code>WebSocket</code>
object. <a href="#refsWSP">[WSP]</a></p></li>
More information about the Commit-Watchers
mailing list