src/third_party/WebKit/public/platform/WebSocketHandle.h

   1 /*
   2  * Copyright (C) 2013 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 WebSocketHandle_h
  32 #define WebSocketHandle_h
  33
  34 #include "WebCommon.h"
  35 #include "WebVector.h"
  36
  37 namespace blink {
  38
  39 class WebSocketHandleClient;
  40 class WebString;
  41 class WebURL;
  42
  43 // FIXME: This class will replace WebSocketStreamHandle.
  44 //
  45 // WebSocketHandle is an interface class designed to be a handle of WebSocket connection.
  46 // WebSocketHandle will be used together with WebSocketHandleClient.
  47 //
  48 // Once a WebSocketHandle is deleted there will be no notification to the corresponding WebSocketHandleClient.
  49 // Once a WebSocketHandleClient receives DidClose, any method of the corresponding WebSocketHandle can't be called.
  50
  51 class WebSocketHandle {
  52 public:
  53     enum MessageType {
  54         MessageTypeContinuation,
  55         MessageTypeText,
  56         MessageTypeBinary,
  57     };
  58
  59     virtual ~WebSocketHandle() { }
  60
  61     virtual void connect(const WebURL& /* url */, const WebVector<WebString>& protocols, const WebString& origin, WebSocketHandleClient*) = 0;
  62     virtual void send(bool fin, MessageType, const char* data, size_t /* size */) = 0;
  63     virtual void flowControl(int64_t quota) = 0;
  64     virtual void close(unsigned short code, const WebString& reason) = 0;
  65 };
  66
  67 } // namespace blink
  68
  69 #endif // WebSocketHandle_h