Changeset 104791 in webkit

Timestamp:

Jan 11, 2012 10:47:47 PM (12 years ago)

Author:

commit-queue@webkit.org

Message:

Add WebArrayBuffer support in WebSocket to WebKit API.
​https://bugs.webkit.org/show_bug.cgi?id=75080

Patch by Takashi Toyoshima <​toyoshim@chromium.org> on 2012-01-11
Reviewed by Darin Fisher.

• public/WebSocket.h: Add interface to send WebArrayBuffer, and set and get receiving binary object type.
• public/WebSocketClient.h: Add interface to receive WebArrayBuffer.

(WebKit::WebSocketClient::didReceiveArrayBuffer):

• src/WebSocketImpl.cpp: Add various binary types handling.

(WebKit::WebSocketImpl::WebSocketImpl):
(WebKit::WebSocketImpl::binaryType):
(WebKit::WebSocketImpl::setBinaryType):
(WebKit::WebSocketImpl::sendArrayBuffer):
(WebKit::WebSocketImpl::didReceiveBinaryData):

• src/WebSocketImpl.h: Add methods to handle various binary types.

Location:

trunk/Source/WebKit/chromium

Files:

• ChangeLog (modified) (1 diff)
• public/WebSocket.h (modified) (3 diffs)
• public/WebSocketClient.h (modified) (3 diffs)
• src/WebSocketImpl.cpp (modified) (7 diffs)
• src/WebSocketImpl.h (modified) (3 diffs)

trunk/Source/WebKit/chromium/ChangeLog

@@ +1 @@
+2012-01-11  Takashi Toyoshima  <toyoshim@chromium.org>
+
+        Add WebArrayBuffer support in WebSocket to WebKit API.
+        https://bugs.webkit.org/show_bug.cgi?id=75080
+
+        Reviewed by Darin Fisher.
+
+        * public/WebSocket.h: Add interface to send WebArrayBuffer, and set and get receiving binary object type.
+        * public/WebSocketClient.h: Add interface to receive WebArrayBuffer.
+        (WebKit::WebSocketClient::didReceiveArrayBuffer):
+        * src/WebSocketImpl.cpp: Add various binary types handling.
+        (WebKit::WebSocketImpl::WebSocketImpl):
+        (WebKit::WebSocketImpl::binaryType):
+        (WebKit::WebSocketImpl::setBinaryType):
+        (WebKit::WebSocketImpl::sendArrayBuffer):
+        (WebKit::WebSocketImpl::didReceiveBinaryData):
+        * src/WebSocketImpl.h: Add methods to handle various binary types.
+
 2012-01-11  Scott Violet  <sky@google.com>
 

trunk/Source/WebKit/chromium/public/WebSocket.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2011 Google Inc.  All rights reserved.
+ * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -39 +39 @@
 namespace WebKit {
 
+class WebArrayBuffer;
 class WebData;
 class WebDocument;
@@ -61 +62 @@
     };
 
+    // FIXME: Remove BinaryTypeData after a switchover to other types.
+    enum BinaryType {
+        BinaryTypeBlob = 0,
+        BinaryTypeArrayBuffer = 1,
+        BinaryTypeData = 2 // Don't use it
+    };
+
     WEBKIT_EXPORT static WebSocket* create(const WebDocument&, WebSocketClient*);
     virtual ~WebSocket() { }
 
+    // These functions come from binaryType attribute of the WebSocket API
+    // specification. It specifies binary object type for receiving binary
+    // frames representation. Receiving text frames are always mapped to
+    // WebString type regardless of this attribute.
+    // Default type must be BinaryTypeBlob, but currently is BinaryTypeData
+    // for a switchover from WebData to WebArrayBuffer.
+    // See also, The WebSocket API - http://www.w3.org/TR/websockets/ .
+    virtual BinaryType binaryType() const = 0;
+    virtual bool setBinaryType(BinaryType) = 0;
+
     virtual void connect(const WebURL&, const WebString& protocol) = 0;
     virtual WebString subprotocol() = 0;
-    virtual bool sendText(const WebString& message) = 0;
-    virtual bool sendBinary(const WebData& binaryData) = 0;
+    virtual bool sendText(const WebString&) = 0;
+    virtual bool sendBinary(const WebData&) = 0;
+    virtual bool sendArrayBuffer(const WebArrayBuffer&) = 0;
     virtual unsigned long bufferedAmount() const = 0;
     virtual void close(int code, const WebString& reason) = 0;

trunk/Source/WebKit/chromium/public/WebSocketClient.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2011 Google Inc.  All rights reserved.
+ * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -37 +37 @@
 namespace WebKit {
 
+class WebArrayBuffer;
 class WebString;
 
@@ -50 +51 @@
     virtual void didReceiveMessage(const WebString& message) { }
     virtual void didReceiveBinaryData(const WebData& binaryData) { }
+    virtual void didReceiveArrayBuffer(const WebArrayBuffer& arrayBuffer) { }
     virtual void didReceiveMessageError() { }
     virtual void didUpdateBufferedAmount(unsigned long bufferedAmount) { }

trunk/Source/WebKit/chromium/src/WebSocketImpl.cpp

@@ -1 +1 @@
 /*
- * Copyright (C) 2011 Google Inc. All rights reserved.
+ * Copyright (C) 2011, 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -32 +32 @@
 #include "WebSocketImpl.h"
 
+#include "ArrayBuffer.h"
 #include "Document.h"
 #include "KURL.h"
@@ -44 +45 @@
 #endif
 
-#include "platform/WebData.h"
+#include "WebArrayBuffer.h"
 #include "WebDocument.h"
 #include "WebSocketClient.h"
+#include "platform/WebData.h"
 #include "platform/WebString.h"
 #include "platform/WebURL.h"
@@ -54 +56 @@
 namespace WebKit {
 
+// FIXME: Default m_binaryType must be Blob after supporting WebBlob.
 WebSocketImpl::WebSocketImpl(const WebDocument& document, WebSocketClient* client)
     : m_client(client)
+    , m_binaryType(BinaryTypeData)
 {
 #if ENABLE(WEB_SOCKETS)
@@ -73 +77 @@
 }
 
+WebSocket::BinaryType WebSocketImpl::binaryType() const
+{
+    return m_binaryType;
+}
+
+bool WebSocketImpl::setBinaryType(BinaryType binaryType)
+{
+    if (binaryType > BinaryTypeArrayBuffer)
+        return false;
+    m_binaryType = binaryType;
+    return true;
+}
+
 void WebSocketImpl::connect(const WebURL& url, const WebString& protocol)
 {
@@ -104 +121 @@
 #if ENABLE(WEB_SOCKETS)
     return m_private->send(binaryData.data(), binaryData.size());
+#else
+    ASSERT_NOT_REACHED();
+#endif
+}
+
+bool WebSocketImpl::sendArrayBuffer(const WebArrayBuffer& webArrayBuffer)
+{
+#if ENABLE(WEB_SOCKETS)
+    return m_private->send(*PassRefPtr<ArrayBuffer>(webArrayBuffer));
 #else
     ASSERT_NOT_REACHED();
@@ -167 +193 @@
 {
 #if ENABLE(WEB_SOCKETS)
-    m_client->didReceiveBinaryData(WebData(binaryData->data(), binaryData->size()));
+    switch (m_binaryType) {
+    case BinaryTypeData:
+    case BinaryTypeBlob: // FIXME: Handle Blob after supporting WebBlob.
+        m_client->didReceiveBinaryData(WebData(binaryData->data(), binaryData->size()));
+        break;
+    case BinaryTypeArrayBuffer:
+        m_client->didReceiveArrayBuffer(WebArrayBuffer(ArrayBuffer::create(binaryData->data(), binaryData->size())));
+        break;
+    }
 #else
     ASSERT_NOT_REACHED();

trunk/Source/WebKit/chromium/src/WebSocketImpl.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2011 Google Inc.  All rights reserved.
+ * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -55 +55 @@
     bool isNull() const { return !m_private; }
 
+    BinaryType binaryType() const;
+    virtual bool setBinaryType(BinaryType);
     virtual void connect(const WebURL&, const WebString& protocol);
     virtual WebString subprotocol();
-    virtual bool sendText(const WebString& message);
-    virtual bool sendBinary(const WebData& binaryData);
+    virtual bool sendText(const WebString&);
+    // FIXME: Remove sendBinary() after a switchover to other types.
+    virtual bool sendBinary(const WebData&);
+    virtual bool sendArrayBuffer(const WebArrayBuffer&);
     virtual unsigned long bufferedAmount() const;
     virtual void close(int code, const WebString& reason);
@@ -76 +80 @@
     RefPtr<WebCore::WebSocketChannel> m_private;
     WebSocketClient* m_client;
+    BinaryType m_binaryType;
 };