File: WebSocketHandleClient.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (92 lines) | stat: -rw-r--r-- 3,919 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 * Copyright (C) 2013 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
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * 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 WebSocketHandleClient_h
#define WebSocketHandleClient_h

#include "modules/websockets/WebSocketHandle.h"
#include "wtf/Forward.h"

namespace blink {
class WebSocketHandshakeRequest;
class WebSocketHandshakeResponse;

class WebSocketHandleClient {
 public:
  // Called when the handle is opened.
  virtual void didConnect(WebSocketHandle*,
                          const String& selectedProtocol,
                          const String& extensions) = 0;

  // Called when the browser starts the opening handshake.
  // This notification can be omitted when the inspector is not active.
  virtual void didStartOpeningHandshake(
      WebSocketHandle*,
      PassRefPtr<WebSocketHandshakeRequest>) = 0;

  // Called when the browser finishes the opening handshake.
  // This notification precedes didConnect.
  // This notification can be omitted when the inspector is not active.
  virtual void didFinishOpeningHandshake(WebSocketHandle*,
                                         const WebSocketHandshakeResponse*) = 0;

  // Called when the browser is required to fail the connection.
  // |message| can be displayed in the inspector, but should not be passed
  // to scripts.
  // This message also implies that channel is closed with
  // (wasClean = false, code = 1006, reason = "") and
  // |handle| becomes unavailable.
  virtual void didFail(WebSocketHandle* /* handle */,
                       const String& message) = 0;

  // Called when data are received.
  virtual void didReceiveData(WebSocketHandle*,
                              bool fin,
                              WebSocketHandle::MessageType,
                              const char* data,
                              size_t) = 0;

  // Called when the handle is closed.
  // |handle| becomes unavailable once this notification arrives.
  virtual void didClose(WebSocketHandle* /* handle */,
                        bool wasClean,
                        unsigned short code,
                        const String& reason) = 0;

  virtual void didReceiveFlowControl(WebSocketHandle*, int64_t quota) = 0;

  // Called when the browser receives a Close frame from the remote
  // server. Not called when the renderer initiates the closing handshake.
  virtual void didStartClosingHandshake(WebSocketHandle*) = 0;
};

}  // namespace blink

#endif  // WebSocketHandleClient_h