WebSocket Pepper API documents minor revision

ppapi/api/dev/ppb_websocket_dev.idl

 /* Copyright (c) 2011 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_Dev</code> interface.
  */
 label Chrome {
   M17 = 0.1
 };
 
 
 /**
  * This enumeration contains the types representing the WebSocket ready state
  * and these states are based on the JavaScript WebSocket API specification.
  * GetReadyState() returns one of these states.
  */
 [assert_size(4)]
 enum PP_WebSocketReadyState_Dev {
   /**
+   * Ready state is queried on an invalid resource.
+   */
+  PP_WEBSOCKETREADYSTATE_INVALID_DEV = -1,
+  /**
    * Ready state that the connection has not yet been established.
    */
   PP_WEBSOCKETREADYSTATE_CONNECTING_DEV = 0,
 
   /**
    * Ready state that the WebSocket connection is established and communication
    * is possible.
    */
   PP_WEBSOCKETREADYSTATE_OPEN_DEV = 1,
 
@@ skipping 193 matching lines @@
    */
   uint16_t GetCloseCode([in] PP_Resource web_socket);
 
   /**
    * GetCloseReason() returns the connection close reason for the WebSocket
    * connection.
    *
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @return Returns a <code>PP_VARTYPE_NULL</code> var if called before the
-   * close reason is set, or <code>PP_VARTYPE_UNDEFINED</code> if called on an
-   * invalid resource.
+   * @return Returns a <code>PP_VARTYPE_STRING</code> var. if called before the
+   * close reason is set, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetCloseReason([in] PP_Resource web_socket);
 
   /**
    * GetCloseWasClean() returns if the connection was closed cleanly for the
    * specified WebSocket connection.
    *
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
    * @return Returns <code>PP_FALSE</code> if called before the connection is
-   * closed. Otherwise, returns <code>PP_TRUE</code> if the connection was
-   * closed cleanly and returns <code>PP_FALSE</code> if the connection was
-   * closed by abnormal reasons.
+   * closed, or called on an invalid resource. Otherwise, returns
+   * <code>PP_TRUE</code> if the connection was closed cleanly, or returns
+   * <code>PP_FALSE</code> if the connection was closed by abnormal reasons.
    */
   PP_Bool GetCloseWasClean([in] PP_Resource web_socket);
 
   /**
    * GetExtensions() returns the extensions selected by the server for the
    * specified WebSocket connection.
    *
    * @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 or called on an invalid resource, its data is
-   * empty string.
-   * Currently its data is always empty string.
+   * connection is established, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
+   * Currently its data for valid resources are always empty string.
    */
   PP_Var GetExtensions([in] PP_Resource web_socket);
 
   /**
    * GetProtocol() returns the sub-protocol chosen by the server for the
    * specified WebSocket connection.
    *
    * @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, or called on an invalid resource, its data is
-   * empty string.
+   * connection is established, its data is empty string. Returns a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetProtocol([in] PP_Resource web_socket);
 
   /**
    * GetReadyState() returns the ready state of the specified WebSocket
    * connection.
    *
    * @param[in] web_socket A <code>PP_Resource</code> corresponding to a
    * WebSocket.
    *
-   * @return Returns <code>PP_WEBSOCKETREADYSTATE_CONNECTING</code> if called
-   * before the connection is established.
+   * @return Returns <code>PP_WEBSOCKETREADYSTATE_INVALID_DEV</code> if called
+   * before connect() is called, or called on an invalid resource.
    */
   PP_WebSocketReadyState_Dev GetReadyState([in] PP_Resource web_socket);
 
   /**
    * GetURL() returns the URL associated with specified WebSocket connection.
    *
    * @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, or called on an invalid resource, its data is
-   * empty string.
+   * connection is established, its data is empty string. Return a
+   * <code>PP_VARTYPE_UNDEFINED</code> if called on an invalid resource.
    */
   PP_Var GetURL([in] PP_Resource web_socket);
 };