Decouple WebSocketChannelClient from WebSocketImpl

Source/web/WebSocketChannelClientProxy.h

 /*
  * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 10 matching lines @@
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef WebSocketImpl_h
-#define WebSocketImpl_h
+#ifndef WebSocketChannelClientProxy_h
+#define WebSocketChannelClientProxy_h
 
 #include "modules/websockets/WebSocketChannelClient.h"
 #include "platform/heap/Handle.h"
-#include "public/platform/WebCommon.h"
-#include "public/platform/WebString.h"
-#include "public/web/WebSocket.h"
 #include "public/web/WebSocketClient.h"

[yhirano, 2014/08/04 01:05:53]

No need to include WebSocketClient.h

[haraken, 2014/08/04 01:21:57]

We need to include WebSocketClient.h for ClosingHandshakeCompletionStatus.

[yhirano, 2014/08/04 01:48:28]

ClosingHandshakeCompletionStatus used in this header is one defined in
WebSocketChannelClient, isn't it?

[haraken, 2014/08/04 02:34:17]

You're right. Removed WebSocketClient.h from includes.

+#include "web/WebSocketImpl.h"
 #include "wtf/OwnPtr.h"

[yhirano, 2014/08/04 01:05:53]

PassOwnPtr.h instead of OwnPtr.h

[haraken, 2014/08/04 01:21:57]

Done.

 #include "wtf/RefPtr.h"

[yhirano, 2014/08/04 01:05:52]

No need to include RefPtr.h

[haraken, 2014/08/04 01:21:57]

Done.

+#include "wtf/Vector.h"
+#include "wtf/text/WTFString.h"
 
 namespace blink { class WebSocketChannel; }
 
 namespace blink {
 
-class WebDocument;
-class WebURL;
+// Ideally we want to simply make WebSocketImpl inherit from WebSocketChannelClient,

[yhirano, 2014/08/04 01:05:52]

Please wrap comments in 80 columns.

[haraken, 2014/08/04 01:21:57]

Done.

+// but we cannot do that because WebSocketChannelClient needs to be on Oilpan's heap
+// whereas WebSocketImpl cannot be on Oilpan's heap. Thus we need to introduce a proxy
+// class to decouple WebSocketImpl from WebSocketChannelClient.
+class WebSocketChannelClientProxy FINAL : public NoBaseWillBeGarbageCollectedFinalized<WebSocketChannelClientProxy>, public blink::WebSocketChannelClient {
+    WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(WebSocketChannelClientProxy)
+public:
+    static PassOwnPtrWillBeRawPtr<WebSocketChannelClientProxy> create(WebSocketImpl* impl)
+    {
+        return adoptPtrWillBeNoop(new WebSocketChannelClientProxy(impl));
+    }
 
-class WebSocketImpl FINAL : public NoBaseWillBeGarbageCollectedFinalized<WebSocketImpl>, public WebSocket, public blink::WebSocketChannelClient {
-    WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(WebSocketImpl)
-public:
-    WebSocketImpl(const WebDocument&, WebSocketClient*);
-    virtual ~WebSocketImpl();
-
-    bool isNull() const { return !m_private; }
-
-    virtual BinaryType binaryType() const OVERRIDE;
-    virtual bool setBinaryType(BinaryType) OVERRIDE;
-    virtual void connect(const WebURL&, const WebString& protocol) OVERRIDE;
-    virtual WebString subprotocol() OVERRIDE;
-    virtual WebString extensions() OVERRIDE;
-    virtual bool sendText(const WebString&) OVERRIDE;
-    virtual bool sendArrayBuffer(const WebArrayBuffer&) OVERRIDE;
-    virtual unsigned long bufferedAmount() const OVERRIDE;
-    virtual void close(int code, const WebString& reason) OVERRIDE;
-    virtual void fail(const WebString& reason) OVERRIDE;
-    virtual void disconnect() OVERRIDE;
-
-    // WebSocketChannelClient
-    virtual void didConnect(const String& subprotocol, const String& extensions) OVERRIDE;
-    virtual void didReceiveMessage(const String& message) OVERRIDE;
-    virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData) OVERRIDE;
-    virtual void didReceiveMessageError() OVERRIDE;
-    virtual void didConsumeBufferedAmount(unsigned long consumed) OVERRIDE;
-    virtual void didStartClosingHandshake() OVERRIDE;
-    virtual void didClose(ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) OVERRIDE;
-
-    virtual void trace(blink::Visitor*) OVERRIDE;
+    virtual void didConnect(const String& subprotocol, const String& extensions) OVERRIDE
+    {
+        m_impl->didConnect(subprotocol, extensions);
+    }
+    virtual void didReceiveMessage(const String& message) OVERRIDE
+    {
+        m_impl->didReceiveMessage(message);
+    }
+    virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData) OVERRIDE
+    {
+        m_impl->didReceiveBinaryData(binaryData);
+    }
+    virtual void didReceiveMessageError() OVERRIDE
+    {
+        m_impl->didReceiveMessageError();
+    }
+    virtual void didConsumeBufferedAmount(unsigned long consumed) OVERRIDE
+    {
+        m_impl->didConsumeBufferedAmount(consumed);
+    }
+    virtual void didStartClosingHandshake() OVERRIDE
+    {
+        m_impl->didStartClosingHandshake();
+    }
+    virtual void didClose(ClosingHandshakeCompletionStatus status, unsigned short code, const String& reason) OVERRIDE
+    {
+        m_impl->didClose(status, code, reason);

[yhirano, 2014/08/04 01:05:52]

Clearing m_impl would be good.

WebSocketImpl* impl = m_impl;
m_impl = nullptr;
impl->didClose(status, code, reason);

[haraken, 2014/08/04 01:21:57]

Done.

+    }
 
 private:
-    RefPtrWillBeMember<blink::WebSocketChannel> m_private;
-    WebSocketClient* m_client;
-    BinaryType m_binaryType;
-    WebString m_subprotocol;
-    WebString m_extensions;
-    bool m_isClosingOrClosed;
-    // m_bufferedAmount includes m_bufferedAmountAfterClose.
-    unsigned long m_bufferedAmount;
-    unsigned long m_bufferedAmountAfterClose;
+    explicit WebSocketChannelClientProxy(WebSocketImpl* impl)
+        : m_impl(impl)
+    {
+    }
+
+    WebSocketImpl* m_impl;
 };
 
 } // namespace blink
 
-#endif // WebWebSocketChannelImpl_h
+#endif // WebSocketChannelClientProxy_h