WebSocket Pepper API: make the API out of dev

ppapi/cpp/websocket.h

 // 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.
 
-#ifndef PPAPI_CPP_DEV_WEBSOCKET_DEV_H_
-#define PPAPI_CPP_DEV_WEBSOCKET_DEV_H_
+#ifndef PPAPI_CPP_WEBSOCKET_H_
+#define PPAPI_CPP_WEBSOCKET_H_
 
-#include "ppapi/c/dev/ppb_websocket_dev.h"
+#include "ppapi/c/ppb_websocket.h"
 #include "ppapi/cpp/resource.h"
 
 /// @file
-/// This file defines the WebSocket_Dev interface.
+/// This file defines the WebSocket interface.
 
 namespace pp {
 
 class CompletionCallback;
 class Instance;
 class Var;
 
-/// The <code>WebSocket_Dev</code> class
-class WebSocket_Dev : public Resource {
+/// The <code>WebSocket</code> class
+class WebSocket : public Resource {
  public:
-  /// Constructs a WebSocket_Dev object.
-  WebSocket_Dev(Instance* instance);
+  /// Constructs a WebSocket object.
+  WebSocket(Instance* instance);
 
-  /// Destructs a WebSocket_Dev object.
-  virtual ~WebSocket_Dev();
+  /// Destructs a WebSocket object.
+  virtual ~WebSocket();
 
   /// Connect() connects to the specified WebSocket server. Caller can call
   /// this method at most once.
   ///
   /// @param[in] url A <code>Var</code> of string type representing a WebSocket
   /// server URL.
   /// @param[in] protocols A pointer to an array of string type
   /// <code>Var</code> specifying sub-protocols. Each <code>Var</code>
   /// represents one sub-protocol. This argument can be null only if
   /// <code>protocol_count</code> is 0.
@@ skipping 42 matching lines @@
   int32_t Close(uint16_t code, const Var& reason,
                 const CompletionCallback& callback);
 
   /// ReceiveMessage() receives a message from the WebSocket server.
   /// This interface only returns a single message. That is, this interface
   /// must be called at least N times to receive N messages, no matter how
   /// small each message is.
   ///
   /// @param[out] message The received message is copied to provided
   /// <code>message</code>. The <code>message</code> must remain valid until
-  /// the ReceiveMessage operation completes.
+  /// the ReceiveMessage operation completes. It will be a <code>Var</code> of
+  /// string or ArrayBuffer types on receiving.
   /// @param[in] callback A <code>CompletionCallback</code> which is called
   /// when the receiving message is completed. It is ignored if ReceiveMessage
   /// completes synchronously and returns <code>PP_OK</code>.
   ///
   /// @return An int32_t containing an error code from
   /// <code>pp_errors.h</code>.
   /// If an error is detected or connection is closed, returns
   /// <code>PP_ERROR_FAILED</code> after all buffered messages are received.
   /// Until buffered message become empty, continues to returns
   /// <code>PP_OK</code> as if connection is still established without errors.
   int32_t ReceiveMessage(Var* message,
                          const CompletionCallback& callback);
 
   /// Send() sends a message to the WebSocket server.
   ///
   /// @param[in] data A message to send. The message is copied to internal
   /// buffer. So caller can free <code>data</code> safely after returning
-  /// from the function.
+  /// from the function. It must be a <code>Var</code> of string or ArrayBuffer
+  /// types.
   ///
   /// @return An int32_t containing an error code from
   /// <code>pp_errors.h</code>.
   /// Returns <code>PP_ERROR_FAILED</code> if the ReadyState is
-  /// <code>PP_WEBSOCKETREADYSTATE_CONNECTING_DEV</code>. It corresponds
-  /// JavaScript InvalidStateError of the specification.
+  /// <code>PP_WEBSOCKETREADYSTATE_CONNECTING</code>. It corresponds JavaScript
+  /// InvalidStateError of the specification.
   /// Returns <code>PP_ERROR_BADARGUMENT</code> if provided
   /// <code>message</code> of string type contains an invalid character as a
   /// UTF-8 string. It corresponds to JavaScript SyntaxError of the
   /// specification.
   /// Otherwise, returns <code>PP_OK</code>, but it doesn't necessarily mean
   /// that the server received the message.
   int32_t SendMessage(const Var& message);
 
   /// GetBufferedAmount() returns the number of bytes of text and binary
   /// messages that have been queued for the WebSocket connection to send but
@@ skipping 35 matching lines @@
   /// GetProtocol() returns the sub-protocol chosen by the server for the
   /// specified WebSocket connection.
   ///
   /// @return Returns a <code>Var</code> of string type. If called before the
   /// connection is established, it contains the empty string.
   Var GetProtocol();
 
   /// GetReadyState() returns the ready state of the specified WebSocket
   /// connection.
   ///
-  /// @return Returns <code>PP_WEBSOCKETREADYSTATE_INVALID_DEV</code> if called
+  /// @return Returns <code>PP_WEBSOCKETREADYSTATE_INVALID</code> if called
   /// before connect() is called.
-  PP_WebSocketReadyState_Dev GetReadyState();
+  PP_WebSocketReadyState GetReadyState();
 
   /// GetURL() returns the URL associated with specified WebSocket connection.
   ///
   /// @return Returns a <code>Var</code> of string type. If called before the
   /// connection is established, it contains the empty string.
   Var GetURL();
-
-  /// SetBinaryType() specifies the binary object type for receiving binary
-  /// frames representation. Receiving text frames are always mapped to
-  /// <PP_VARTYPE_STRING</code> var regardless of this attribute.
-  /// This function should be called before Connect() to ensure receiving all
-  /// incoming binary frames as the specified binary object type.
-  /// Default type is <code>PP_WEBSOCKETBINARYTYPE_BLOB_DEV</code>.
-  ///
-  /// Currently, Blob bindings is not supported in Pepper, so receiving binary
-  /// type is always ArrayBuffer. To ensure backward compatibility, you must
-  /// call this function with
-  /// <code>PP_WEBSOCKETBINARYTYPE_ARRAYBUFFER_DEV</code> to use binary frames.
-  ///
-  /// @param[in] binary_type Binary object type for receiving binary frames
-  /// representation.
-  ///
-  /// @return Returns <code>false</code> if the specified type is not
-  /// supported. Otherwise, returns <code>true</code>.
-  ///
-  bool SetBinaryType(PP_WebSocketBinaryType_Dev binary_type);
-
-  /// GetBinaryType() returns the currently specified binary object type for
-  /// receiving binary frames.
-  ///
-  /// @return Returns <code>PP_WebSocketBinaryType_Dev</code> represents the
-  /// current binary object type.
-  PP_WebSocketBinaryType_Dev GetBinaryType();
 };
 
 }  // namespace pp
 
-#endif  // PPAPI_CPP_DEV_WEBSOCKET_DEV_H_
+#endif  // PPAPI_CPP_WEBSOCKET_H_