Changeset 214106 in webkit

Timestamp:

Mar 17, 2017, 8:57:23 AM (8 years ago)

Author:

achristensen@apple.com

Message:

Use completion handlers instead of return values for sending websocket data
​https://bugs.webkit.org/show_bug.cgi?id=169802

Reviewed by Carlos Garcia Campos.

Source/WebCore:

No change in behavior, but this is a baby step towards making things more asynchronous.

• Modules/websockets/WebSocketChannel.cpp:

(WebCore::WebSocketChannel::didOpenSocketStream):
(WebCore::WebSocketChannel::processOutgoingFrameQueue):
(WebCore::WebSocketChannel::sendFrame):

• Modules/websockets/WebSocketChannel.h:
• platform/network/SocketStreamHandle.cpp:

(WebCore::SocketStreamHandle::send):

• platform/network/SocketStreamHandle.h:
• platform/network/cf/SocketStreamHandleImpl.h:

Source/WebKit2:

• UIProcess/InspectorServer/WebSocketServerConnection.cpp:

(WebKit::WebSocketServerConnection::sendWebSocketMessage):
(WebKit::WebSocketServerConnection::sendHTTPResponseHeader):
(WebKit::WebSocketServerConnection::sendRawData):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/Modules/websockets/WebSocketChannel.cpp (modified) (6 diffs)
• WebCore/Modules/websockets/WebSocketChannel.h (modified) (1 diff)
• WebCore/platform/network/SocketStreamHandle.cpp (modified) (4 diffs)
• WebCore/platform/network/SocketStreamHandle.h (modified) (1 diff)
• WebCore/platform/network/cf/SocketStreamHandleImpl.h (modified) (1 diff)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp (modified) (3 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2017-03-16  Alex Christensen  <achristensen@webkit.org>
+
+        Use completion handlers instead of return values for sending websocket data
+        https://bugs.webkit.org/show_bug.cgi?id=169802
+
+        Reviewed by Carlos Garcia Campos.
+
+        No change in behavior, but this is a baby step towards making things more asynchronous.
+
+        * Modules/websockets/WebSocketChannel.cpp:
+        (WebCore::WebSocketChannel::didOpenSocketStream):
+        (WebCore::WebSocketChannel::processOutgoingFrameQueue):
+        (WebCore::WebSocketChannel::sendFrame):
+        * Modules/websockets/WebSocketChannel.h:
+        * platform/network/SocketStreamHandle.cpp:
+        (WebCore::SocketStreamHandle::send):
+        * platform/network/SocketStreamHandle.h:
+        * platform/network/cf/SocketStreamHandleImpl.h:
+
 2017-03-17  Zan Dobersek  <zdobersek@igalia.com>
 

trunk/Source/WebCore/Modules/websockets/WebSocketChannel.cpp

@@ -279 +279 @@
         InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_document, m_identifier, m_handshake->clientHandshakeRequest());
     CString handshakeMessage = m_handshake->clientHandshakeMessage();
-    if (!handle.send(handshakeMessage.data(), handshakeMessage.length()))
-        fail("Failed to send WebSocket handshake.");
+    handle.send(handshakeMessage.data(), handshakeMessage.length(), [this, protectedThis = makeRef(*this)] (bool success) {
+        if (!success)
+            fail("Failed to send WebSocket handshake.");
+    });
 }
 
@@ -743 +745 @@
         switch (frame->frameType) {
         case QueuedFrameTypeString: {
-            if (!sendFrame(frame->opCode, frame->stringData.data(), frame->stringData.length()))
-                fail("Failed to send WebSocket frame.");
+            sendFrame(frame->opCode, frame->stringData.data(), frame->stringData.length(), [this, protectedThis = makeRef(*this)] (bool success) {
+                if (!success)
+                    fail("Failed to send WebSocket frame.");
+            });
             break;
         }
 
         case QueuedFrameTypeVector:
-            if (!sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size()))
-                fail("Failed to send WebSocket frame.");
+            sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size(), [this, protectedThis = makeRef(*this)] (bool success) {
+                if (!success)
+                    fail("Failed to send WebSocket frame.");
+            });
             break;
 
@@ -774 +780 @@
                 m_blobLoader = nullptr;
                 m_blobLoaderStatus = BlobLoaderNotStarted;
-                if (!sendFrame(frame->opCode, static_cast<const char*>(result->data()), result->byteLength()))
-                    fail("Failed to send WebSocket frame.");
+                sendFrame(frame->opCode, static_cast<const char*>(result->data()), result->byteLength(), [this, protectedThis = makeRef(*this)] (bool success) {
+                    if (!success)
+                        fail("Failed to send WebSocket frame.");
+                });
                 break;
             }
@@ -805 +813 @@
 }
 
-bool WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
+void WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength, Function<void(bool)> completionHandler)
 {
     ASSERT(m_handle);
@@ -816 +824 @@
     if (!deflateResult->succeeded()) {
         fail(deflateResult->failureReason());
-        return false;
+        return completionHandler(false);
     }
 
@@ -822 +830 @@
     frame.makeFrameData(frameData);
 
-    return m_handle->send(frameData.data(), frameData.size());
+    m_handle->send(frameData.data(), frameData.size(), WTFMove(completionHandler));
 }
 

trunk/Source/WebCore/Modules/websockets/WebSocketChannel.h

@@ -174 +174 @@
     // If you are going to send a hybi-10 frame, you need to use the outgoing frame queue
     // instead of call sendFrame() directly.
-    bool sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
+    void sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength, Function<void(bool)> completionHandler);
 
     enum BlobLoaderStatus {

trunk/Source/WebCore/platform/network/SocketStreamHandle.cpp

@@ -33 +33 @@
 
 #include "SocketStreamHandleClient.h"
+#include <wtf/Function.h>
 
 namespace WebCore {
@@ -50 +51 @@
 }
 
-bool SocketStreamHandle::send(const char* data, size_t length)
+void SocketStreamHandle::send(const char* data, size_t length, Function<void(bool)> completionHandler)
 {
     if (m_state == Connecting || m_state == Closing)
-        return false;
+        return completionHandler(false);
     if (!m_buffer.isEmpty()) {
         if (m_buffer.size() + length > bufferSize) {
             // FIXME: report error to indicate that buffer has no more space.
-            return false;
+            return completionHandler(false);
         }
         m_buffer.append(data, length);
         m_client.didUpdateBufferedAmount(static_cast<SocketStreamHandle&>(*this), bufferedAmount());
-        return true;
+        return completionHandler(true);
     }
     size_t bytesWritten = 0;
@@ -68 +69 @@
             bytesWritten = result.value();
         else
-            return false;
+            return completionHandler(false);
     }
     if (m_buffer.size() + length - bytesWritten > bufferSize) {
         // FIXME: report error to indicate that buffer has no more space.
-        return false;
+        return completionHandler(false);
     }
     if (bytesWritten < length) {
@@ -78 +79 @@
         m_client.didUpdateBufferedAmount(static_cast<SocketStreamHandle&>(*this), bufferedAmount());
     }
-    return true;
+    return completionHandler(true);
 }
 

trunk/Source/WebCore/platform/network/SocketStreamHandle.h

@@ -46 +46 @@
     SocketStreamState state() const;
 
-    bool send(const char* data, size_t length);
+    void send(const char* data, size_t length, Function<void(bool)>);
     void close(); // Disconnect after all data in buffer are sent.
     void disconnect();

trunk/Source/WebCore/platform/network/cf/SocketStreamHandleImpl.h

@@ -51 +51 @@
 
 private:
-    virtual std::optional<size_t> platformSend(const char* data, size_t length);
-    virtual void platformClose();
+    std::optional<size_t> platformSend(const char* data, size_t length) final;
+    void platformClose() final;
 
     WEBCORE_EXPORT SocketStreamHandleImpl(const URL&, SocketStreamHandleClient&, SessionID, const String& credentialPartition);

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2017-03-16  Alex Christensen  <achristensen@webkit.org>
+
+        Use completion handlers instead of return values for sending websocket data
+        https://bugs.webkit.org/show_bug.cgi?id=169802
+
+        Reviewed by Carlos Garcia Campos.
+
+        * UIProcess/InspectorServer/WebSocketServerConnection.cpp:
+        (WebKit::WebSocketServerConnection::sendWebSocketMessage):
+        (WebKit::WebSocketServerConnection::sendHTTPResponseHeader):
+        (WebKit::WebSocketServerConnection::sendRawData):
+
 2017-03-17  Tomas Popela  <tpopela@redhat.com>
 

trunk/Source/WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp

@@ -40 +40 @@
 #include <WebCore/WebSocketChannel.h>
 #include <WebCore/WebSocketHandshake.h>
+#include <wtf/Function.h>
 #include <wtf/text/CString.h>
 #include <wtf/text/StringBuilder.h>
@@ -92 +93 @@
     frame.makeFrameData(frameData);
 
-    m_socket->send(frameData.data(), frameData.size());
+    m_socket->send(frameData.data(), frameData.size(), [](bool) { });
 }
 
@@ -113 +114 @@
 
     CString header = builder.toString().latin1();
-    m_socket->send(header.data(), header.length());
+    m_socket->send(header.data(), header.length(), [](bool) { });
 }
 
 void WebSocketServerConnection::sendRawData(const char* data, size_t length)
 {
-    m_socket->send(data, length);
+    m_socket->send(data, length, [](bool) { });
 }