src/third_party/WebKit/Source/web/WebSocketImpl.h

   1 /*
   2  * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebSocketImpl_h
  32 #define WebSocketImpl_h
  33
  34 #include "modules/websockets/WebSocketChannelClient.h"
  35 #include "platform/heap/Handle.h"
  36 #include "public/platform/WebCommon.h"
  37 #include "public/platform/WebString.h"
  38 #include "public/web/WebSocket.h"
  39 #include "public/web/WebSocketClient.h"
  40 #include "wtf/OwnPtr.h"
  41 #include "wtf/RefPtr.h"
  42
  43 namespace blink {
  44
  45 class WebDocument;
  46 class WebSocketChannel;
  47 class WebSocketChannelClientProxy;
  48 class WebURL;
  49
  50 class WebSocketImpl FINAL : public WebSocket {
  51 public:
  52     WebSocketImpl(const WebDocument&, WebSocketClient*);
  53     virtual ~WebSocketImpl();
  54
  55     bool isNull() const { return !m_private; }
  56
  57     virtual BinaryType binaryType() const OVERRIDE;
  58     virtual bool setBinaryType(BinaryType) OVERRIDE;
  59     virtual void connect(const WebURL&, const WebString& protocol) OVERRIDE;
  60     virtual WebString subprotocol() OVERRIDE;
  61     virtual WebString extensions() OVERRIDE;
  62     virtual bool sendText(const WebString&) OVERRIDE;
  63     virtual bool sendArrayBuffer(const WebArrayBuffer&) OVERRIDE;
  64     virtual unsigned long bufferedAmount() const OVERRIDE;
  65     virtual void close(int code, const WebString& reason) OVERRIDE;
  66     virtual void fail(const WebString& reason) OVERRIDE;
  67     virtual void disconnect() OVERRIDE;
  68
  69     // WebSocketChannelClient methods proxied by WebSocketChannelClientProxy.
  70     void didConnect(const String& subprotocol, const String& extensions);
  71     void didReceiveMessage(const String& message);
  72     void didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData);
  73     void didReceiveMessageError();
  74     void didConsumeBufferedAmount(unsigned long consumed);
  75     void didStartClosingHandshake();
  76     void didClose(WebSocketChannelClient::ClosingHandshakeCompletionStatus, unsigned short code, const String& reason);
  77
  78 private:
  79     Persistent<WebSocketChannel> m_private;
  80     WebSocketClient* m_client;
  81     Persistent<WebSocketChannelClientProxy> m_channelProxy;
  82     BinaryType m_binaryType;
  83     WebString m_subprotocol;
  84     WebString m_extensions;
  85     bool m_isClosingOrClosed;
  86     // m_bufferedAmount includes m_bufferedAmountAfterClose.
  87     unsigned long m_bufferedAmount;
  88     unsigned long m_bufferedAmountAfterClose;
  89 };
  90
  91 } // namespace blink
  92
  93 #endif // WebWebSocketChannelImpl_h