Source/WebKit/chromium/src/WebSocketImpl.h

   1 /*
   2  * Copyright (C) 2011 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 "WebCommon.h"
  35 #include "WebSocket.h"
  36 #include "WebSocketChannelClient.h"
  37 #include "WebSocketClient.h"
  38 #include <wtf/OwnPtr.h>
  39 #include <wtf/RefPtr.h>
  40
  41 namespace WebCore { class WebSocketChannel; }
  42
  43 namespace WebKit {
  44
  45 class WebData;
  46 class WebDocument;
  47 class WebString;
  48 class WebURL;
  49
  50 class WebSocketImpl : public WebSocket, public WebCore::WebSocketChannelClient {
  51 public:
  52     WebSocketImpl(const WebDocument&, WebSocketClient*);
  53     virtual ~WebSocketImpl();
  54
  55     bool isNull() const { return !m_private; }
  56
  57     virtual void connect(const WebURL&, const WebString& protocol);
  58     virtual WebString subprotocol();
  59     virtual bool sendText(const WebString& message);
  60     virtual bool sendBinary(const WebData& binaryData);
  61     virtual unsigned long bufferedAmount() const;
  62     virtual void close(int code, const WebString& reason);
  63     virtual void fail(const WebString& reason);
  64     virtual void disconnect();
  65
  66     // WebSocketChannelClient
  67     virtual void didConnect();
  68     virtual void didReceiveMessage(const String& message);
  69     virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData);
  70     virtual void didReceiveMessageError();
  71     virtual void didStartClosingHandshake();
  72     virtual void didClose(unsigned long bufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const String& reason);
  73
  74 private:
  75     RefPtr<WebCore::WebSocketChannel> m_private;
  76     WebSocketClient* m_client;
  77 };
  78
  79 } // namespace WebKit
  80
  81 #endif // WebWebSocketChannelImpl_h