<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[214106] trunk/Source</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/214106">214106</a></dd>
<dt>Author</dt> <dd>achristensen@apple.com</dd>
<dt>Date</dt> <dd>2017-03-17 08:57:23 -0700 (Fri, 17 Mar 2017)</dd>
</dl>
<h3>Log Message</h3>
<pre>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):</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoreModuleswebsocketsWebSocketChannelcpp">trunk/Source/WebCore/Modules/websockets/WebSocketChannel.cpp</a></li>
<li><a href="#trunkSourceWebCoreModuleswebsocketsWebSocketChannelh">trunk/Source/WebCore/Modules/websockets/WebSocketChannel.h</a></li>
<li><a href="#trunkSourceWebCoreplatformnetworkSocketStreamHandlecpp">trunk/Source/WebCore/platform/network/SocketStreamHandle.cpp</a></li>
<li><a href="#trunkSourceWebCoreplatformnetworkSocketStreamHandleh">trunk/Source/WebCore/platform/network/SocketStreamHandle.h</a></li>
<li><a href="#trunkSourceWebCoreplatformnetworkcfSocketStreamHandleImplh">trunk/Source/WebCore/platform/network/cf/SocketStreamHandleImpl.h</a></li>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessInspectorServerWebSocketServerConnectioncpp">trunk/Source/WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/ChangeLog 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -1,3 +1,22 @@
</span><ins>+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:
+
</ins><span class="cx"> 2017-03-17 Zan Dobersek <zdobersek@igalia.com>
</span><span class="cx">
</span><span class="cx"> WebGPU: build fixes for non-Cocoa platforms
</span></span></pre></div>
<a id="trunkSourceWebCoreModuleswebsocketsWebSocketChannelcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/websockets/WebSocketChannel.cpp (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/websockets/WebSocketChannel.cpp 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/Modules/websockets/WebSocketChannel.cpp 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -278,8 +278,10 @@
</span><span class="cx"> if (m_identifier)
</span><span class="cx"> InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_document, m_identifier, m_handshake->clientHandshakeRequest());
</span><span class="cx"> CString handshakeMessage = m_handshake->clientHandshakeMessage();
</span><del>- if (!handle.send(handshakeMessage.data(), handshakeMessage.length()))
- fail("Failed to send WebSocket handshake.");
</del><ins>+ handle.send(handshakeMessage.data(), handshakeMessage.length(), [this, protectedThis = makeRef(*this)] (bool success) {
+ if (!success)
+ fail("Failed to send WebSocket handshake.");
+ });
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebSocketChannel::didCloseSocketStream(SocketStreamHandle& handle)
</span><span class="lines">@@ -742,14 +744,18 @@
</span><span class="cx"> auto frame = m_outgoingFrameQueue.takeFirst();
</span><span class="cx"> switch (frame->frameType) {
</span><span class="cx"> case QueuedFrameTypeString: {
</span><del>- if (!sendFrame(frame->opCode, frame->stringData.data(), frame->stringData.length()))
- fail("Failed to send WebSocket frame.");
</del><ins>+ sendFrame(frame->opCode, frame->stringData.data(), frame->stringData.length(), [this, protectedThis = makeRef(*this)] (bool success) {
+ if (!success)
+ fail("Failed to send WebSocket frame.");
+ });
</ins><span class="cx"> break;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> case QueuedFrameTypeVector:
</span><del>- if (!sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size()))
- fail("Failed to send WebSocket frame.");
</del><ins>+ sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size(), [this, protectedThis = makeRef(*this)] (bool success) {
+ if (!success)
+ fail("Failed to send WebSocket frame.");
+ });
</ins><span class="cx"> break;
</span><span class="cx">
</span><span class="cx"> case QueuedFrameTypeBlob: {
</span><span class="lines">@@ -773,8 +779,10 @@
</span><span class="cx"> RefPtr<ArrayBuffer> result = m_blobLoader->arrayBufferResult();
</span><span class="cx"> m_blobLoader = nullptr;
</span><span class="cx"> m_blobLoaderStatus = BlobLoaderNotStarted;
</span><del>- if (!sendFrame(frame->opCode, static_cast<const char*>(result->data()), result->byteLength()))
- fail("Failed to send WebSocket frame.");
</del><ins>+ 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.");
+ });
</ins><span class="cx"> break;
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -804,7 +812,7 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>-bool WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
</del><ins>+void WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength, Function<void(bool)> completionHandler)
</ins><span class="cx"> {
</span><span class="cx"> ASSERT(m_handle);
</span><span class="cx"> ASSERT(!m_suspended);
</span><span class="lines">@@ -815,13 +823,13 @@
</span><span class="cx"> auto deflateResult = m_deflateFramer.deflate(frame);
</span><span class="cx"> if (!deflateResult->succeeded()) {
</span><span class="cx"> fail(deflateResult->failureReason());
</span><del>- return false;
</del><ins>+ return completionHandler(false);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> Vector<char> frameData;
</span><span class="cx"> frame.makeFrameData(frameData);
</span><span class="cx">
</span><del>- return m_handle->send(frameData.data(), frameData.size());
</del><ins>+ m_handle->send(frameData.data(), frameData.size(), WTFMove(completionHandler));
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> } // namespace WebCore
</span></span></pre></div>
<a id="trunkSourceWebCoreModuleswebsocketsWebSocketChannelh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/websockets/WebSocketChannel.h (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/websockets/WebSocketChannel.h 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/Modules/websockets/WebSocketChannel.h 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -173,7 +173,7 @@
</span><span class="cx">
</span><span class="cx"> // If you are going to send a hybi-10 frame, you need to use the outgoing frame queue
</span><span class="cx"> // instead of call sendFrame() directly.
</span><del>- bool sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
</del><ins>+ void sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength, Function<void(bool)> completionHandler);
</ins><span class="cx">
</span><span class="cx"> enum BlobLoaderStatus {
</span><span class="cx"> BlobLoaderNotStarted,
</span></span></pre></div>
<a id="trunkSourceWebCoreplatformnetworkSocketStreamHandlecpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/platform/network/SocketStreamHandle.cpp (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/platform/network/SocketStreamHandle.cpp 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/platform/network/SocketStreamHandle.cpp 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -32,6 +32,7 @@
</span><span class="cx"> #include "SocketStreamHandle.h"
</span><span class="cx">
</span><span class="cx"> #include "SocketStreamHandleClient.h"
</span><ins>+#include <wtf/Function.h>
</ins><span class="cx">
</span><span class="cx"> namespace WebCore {
</span><span class="cx">
</span><span class="lines">@@ -49,18 +50,18 @@
</span><span class="cx"> return m_state;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-bool SocketStreamHandle::send(const char* data, size_t length)
</del><ins>+void SocketStreamHandle::send(const char* data, size_t length, Function<void(bool)> completionHandler)
</ins><span class="cx"> {
</span><span class="cx"> if (m_state == Connecting || m_state == Closing)
</span><del>- return false;
</del><ins>+ return completionHandler(false);
</ins><span class="cx"> if (!m_buffer.isEmpty()) {
</span><span class="cx"> if (m_buffer.size() + length > bufferSize) {
</span><span class="cx"> // FIXME: report error to indicate that buffer has no more space.
</span><del>- return false;
</del><ins>+ return completionHandler(false);
</ins><span class="cx"> }
</span><span class="cx"> m_buffer.append(data, length);
</span><span class="cx"> m_client.didUpdateBufferedAmount(static_cast<SocketStreamHandle&>(*this), bufferedAmount());
</span><del>- return true;
</del><ins>+ return completionHandler(true);
</ins><span class="cx"> }
</span><span class="cx"> size_t bytesWritten = 0;
</span><span class="cx"> if (m_state == Open) {
</span><span class="lines">@@ -67,17 +68,17 @@
</span><span class="cx"> if (auto result = platformSend(data, length))
</span><span class="cx"> bytesWritten = result.value();
</span><span class="cx"> else
</span><del>- return false;
</del><ins>+ return completionHandler(false);
</ins><span class="cx"> }
</span><span class="cx"> if (m_buffer.size() + length - bytesWritten > bufferSize) {
</span><span class="cx"> // FIXME: report error to indicate that buffer has no more space.
</span><del>- return false;
</del><ins>+ return completionHandler(false);
</ins><span class="cx"> }
</span><span class="cx"> if (bytesWritten < length) {
</span><span class="cx"> m_buffer.append(data + bytesWritten, length - bytesWritten);
</span><span class="cx"> m_client.didUpdateBufferedAmount(static_cast<SocketStreamHandle&>(*this), bufferedAmount());
</span><span class="cx"> }
</span><del>- return true;
</del><ins>+ return completionHandler(true);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void SocketStreamHandle::close()
</span></span></pre></div>
<a id="trunkSourceWebCoreplatformnetworkSocketStreamHandleh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/platform/network/SocketStreamHandle.h (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/platform/network/SocketStreamHandle.h 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/platform/network/SocketStreamHandle.h 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -45,7 +45,7 @@
</span><span class="cx"> virtual ~SocketStreamHandle() { }
</span><span class="cx"> SocketStreamState state() const;
</span><span class="cx">
</span><del>- bool send(const char* data, size_t length);
</del><ins>+ void send(const char* data, size_t length, Function<void(bool)>);
</ins><span class="cx"> void close(); // Disconnect after all data in buffer are sent.
</span><span class="cx"> void disconnect();
</span><span class="cx"> size_t bufferedAmount() const { return m_buffer.size(); }
</span></span></pre></div>
<a id="trunkSourceWebCoreplatformnetworkcfSocketStreamHandleImplh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/platform/network/cf/SocketStreamHandleImpl.h (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/platform/network/cf/SocketStreamHandleImpl.h 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebCore/platform/network/cf/SocketStreamHandleImpl.h 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -50,8 +50,8 @@
</span><span class="cx"> virtual ~SocketStreamHandleImpl();
</span><span class="cx">
</span><span class="cx"> private:
</span><del>- virtual std::optional<size_t> platformSend(const char* data, size_t length);
- virtual void platformClose();
</del><ins>+ std::optional<size_t> platformSend(const char* data, size_t length) final;
+ void platformClose() final;
</ins><span class="cx">
</span><span class="cx"> WEBCORE_EXPORT SocketStreamHandleImpl(const URL&, SocketStreamHandleClient&, SessionID, const String& credentialPartition);
</span><span class="cx"> void createStreams();
</span></span></pre></div>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebKit2/ChangeLog 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -1,3 +1,15 @@
</span><ins>+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):
+
</ins><span class="cx"> 2017-03-17 Tomas Popela <tpopela@redhat.com>
</span><span class="cx">
</span><span class="cx"> Fix uninitialized public members in WebProcess
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessInspectorServerWebSocketServerConnectioncpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp (214105 => 214106)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp 2017-03-17 14:11:24 UTC (rev 214105)
+++ trunk/Source/WebKit2/UIProcess/InspectorServer/WebSocketServerConnection.cpp 2017-03-17 15:57:23 UTC (rev 214106)
</span><span class="lines">@@ -39,6 +39,7 @@
</span><span class="cx"> #include <WebCore/SocketStreamHandle.h>
</span><span class="cx"> #include <WebCore/WebSocketChannel.h>
</span><span class="cx"> #include <WebCore/WebSocketHandshake.h>
</span><ins>+#include <wtf/Function.h>
</ins><span class="cx"> #include <wtf/text/CString.h>
</span><span class="cx"> #include <wtf/text/StringBuilder.h>
</span><span class="cx">
</span><span class="lines">@@ -91,7 +92,7 @@
</span><span class="cx"> Vector<char> frameData;
</span><span class="cx"> frame.makeFrameData(frameData);
</span><span class="cx">
</span><del>- m_socket->send(frameData.data(), frameData.size());
</del><ins>+ m_socket->send(frameData.data(), frameData.size(), [](bool) { });
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebSocketServerConnection::sendHTTPResponseHeader(int statusCode, const String& statusText, const HTTPHeaderMap& headerFields)
</span><span class="lines">@@ -112,12 +113,12 @@
</span><span class="cx"> builder.appendLiteral("\r\n");
</span><span class="cx">
</span><span class="cx"> CString header = builder.toString().latin1();
</span><del>- m_socket->send(header.data(), header.length());
</del><ins>+ m_socket->send(header.data(), header.length(), [](bool) { });
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebSocketServerConnection::sendRawData(const char* data, size_t length)
</span><span class="cx"> {
</span><del>- m_socket->send(data, length);
</del><ins>+ m_socket->send(data, length, [](bool) { });
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> void WebSocketServerConnection::didCloseSocketStream(SocketStreamHandle&)
</span></span></pre>
</div>
</div>
</body>
</html>