WebSocket Pepper API: allow to close connection without code and reason

ppapi/api/ppb_websocket.idl

 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 /**
  * This file defines the <code>PPB_WebSocket</code> interface providing
  * bi-directional, full-duplex, communications over a single TCP socket.
  */
 label Chrome {
@@ skipping 38 matching lines @@
  * This enumeration contains status codes. These codes are used in Close() and
  * GetCloseCode(). Refer to RFC 6455, The WebSocket Protocol, for further
  * information.
  * <code>PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE</code> and codes in the range
  * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN</code> to
  * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX</code>, and
  * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN</code> to
  * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX</code> are valid for Close().
  */
 [assert_size(4)]
-enum PP_WebSocketCloseCode {
+enum PP_WebSocketStatusCode {

[dmichael (off chromium), 2012/05/17 20:03:16]

Sorry I didn't notice this before...  you're breaking source compatibility here.
I.e., existing websocket code may break and need to be modified when they update
to a new SDK that includes this change.

We can do this, but... I try to avoid it unless there's a pretty good reason. Is
it worth it in this case? Is this to bring it closer to the updated spec? I
still see "close code" phrasing in the latest spec.

[Takashi Toyoshima, 2012/05/30 10:15:46]

The reason why I changed enum name here is that the enum members have different
prefix 'PP_WEBSOCKETSTATUSCODE_' from the enum name. Originally this is my old
mistake and looks inconsistent to other PPAPI enums.

Actually, I'm not sure that we should keep this enum name or not. I'll agree
your opinion.

[dmichael (off chromium), 2012/05/30 15:20:11]

I see.
I can see how the new name would be somewhat better, but I don't think it's
better enough to be worth breaking source compatibility.

+  /**
+   * Indicates to request closing connection without status code and reasom.

[dmichael (off chromium), 2012/05/17 20:03:16]

nit: reasom->reason

[Takashi Toyoshima, 2012/05/30 10:15:46]

Done.

+   * The code 1005 is forbidden to send in actual close frames by the RFC.
+   * PP_WebSocket reuses this code internally and the code will never appear in
+   * the actual close frames.

[dmichael (off chromium), 2012/05/17 20:03:16]

nit: I think this is information most developers won't care about. I would maybe
put it in a separate paragraph and in parentheses to de-emphasize it. It's kind
of an implementation detail. I.e.,
"(Note that the code 1005..."

[Takashi Toyoshima, 2012/05/30 10:15:46]

Agreed.
Done.

+   */
+  PP_WEBSOCKETSTATUSCODE_NOT_SPECIFIED = 1005,
+
   /**
    * Status codes in the range 0-999 are not used.
    */
 
   /**
    * Indicates a normal closure.
    */
   PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE = 1000,
 
   /**
@@ skipping 167 matching lines @@
                   [in] uint32_t protocol_count,
                   [in] PP_CompletionCallback callback);
 
   /**
    * Close() closes the specified WebSocket connection by specifying
    * <code>code</code> and <code>reason</code>.
    *
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @param[in] code The WebSocket close code. This is ignored if it is 0.
+   * @param[in] code The WebSocket close code. This is ignored if it is
+   * <code>PP_WEBSOCKETSTATUSCODE_NOT_SPECIFIED</code>.
    * <code>PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE</code> must be used for the
    * usual case. To indicate some specific error cases, codes in the range
    * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN</code> to
    * <code>PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX</code>, and in the range
    * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN</code> to
    * <code>PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX</code> are available.
    *
    * @param[in] reason A <code>PP_Var</code> representing the WebSocket
    * close reason. This is ignored if it is <code>PP_VARTYPE_UNDEFINED</code>.
    * Otherwise, its <code>PP_VarType</code> must be
@@ skipping 168 matching lines @@
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
    * @return Returns a <code>PP_VARTYPE_STRING</code> var. If called before the
    * connection is established, the var contains the empty string. Returns a
    * <code>PP_VARTYPE_UNDEFINED</code> if this function is called on an
    * invalid resource.
    */
   PP_Var GetURL([in] PP_Resource web_socket);
 };