WebSocket Pepper API documents minor revision
BUG=87310
TEST=none
Review URL: http://codereview.chromium.org/8572009
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@110260 0039d316-1c4b-4281-b951-d872f2087c98
diff --git a/ppapi/api/dev/ppb_websocket_dev.idl b/ppapi/api/dev/ppb_websocket_dev.idl
index c481910..6dd0bd86c 100644
--- a/ppapi/api/dev/ppb_websocket_dev.idl
+++ b/ppapi/api/dev/ppb_websocket_dev.idl
@@ -19,6 +19,10 @@
[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,
@@ -232,9 +236,9 @@
* @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);
@@ -246,9 +250,9 @@
* 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);
@@ -260,9 +264,9 @@
* 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);
@@ -274,8 +278,8 @@
* 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);
@@ -286,8 +290,8 @@
* @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);
@@ -298,8 +302,8 @@
* 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);
};
