src/third_party/WebKit/public/platform/WebSocketHandleClient.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 WebSocketHandleClient_h
  32 #define WebSocketHandleClient_h
  33
  34 #include "WebCommon.h"
  35 #include "public/platform/WebSocketHandle.h"
  36
  37 namespace blink {
  38
  39 class WebSocketHandshakeRequestInfo;
  40 class WebSocketHandshakeResponseInfo;
  41 class WebString;
  42 class WebURL;
  43
  44 // FIXME: This class should replace WebSocketStreamHandleClient.
  45 class WebSocketHandleClient {
  46 public:
  47     // Called when the handle is opened.
  48     virtual void didConnect(WebSocketHandle*, bool fail, const WebString& selectedProtocol, const WebString& extensions) = 0;
  49
  50     // Called when the browser starts the opening handshake.
  51     // This notification can be omitted when the inspector is not active.
  52     virtual void didStartOpeningHandshake(WebSocketHandle*, const WebSocketHandshakeRequestInfo&) = 0;
  53
  54     // Called when the browser finishes the opening handshake.
  55     // This notification precedes didConnect.
  56     // This notification can be omitted when the inspector is not active.
  57     virtual void didFinishOpeningHandshake(WebSocketHandle*, const WebSocketHandshakeResponseInfo&) = 0;
  58
  59     // Called when the browser is required to fail the connection.
  60     // |message| can be displayed in the inspector, but should not be passed
  61     // to scripts.
  62     // This message also implies that channel is closed with
  63     // (wasClean = false, code = 1006, reason = "") and
  64     // |handle| becomes unavailable.
  65     virtual void didFail(WebSocketHandle* /* handle */, const WebString& message) = 0;
  66
  67     // Called when data are received.
  68     virtual void didReceiveData(WebSocketHandle*, bool fin, WebSocketHandle::MessageType, const char* data, size_t /* size */) = 0;
  69
  70     // Called when the handle is closed.
  71     // |handle| becomes unavailable once this notification arrives.
  72     virtual void didClose(WebSocketHandle* /* handle */, bool wasClean, unsigned short code, const WebString& reason) = 0;
  73
  74     virtual void didReceiveFlowControl(WebSocketHandle*, int64_t quota) = 0;
  75 };
  76
  77 } // namespace blink
  78
  79 #endif // WebSocketHandleClient_h