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 WebSocketClient_h
32#define WebSocketClient_h
33
34#include "../platform/WebCommon.h"
35
36namespace blink {
37
38class WebArrayBuffer;
39class WebString;
40
41class WebSocketClient {
42public:
43    enum ClosingHandshakeCompletionStatus {
44        ClosingHandshakeIncomplete,
45        ClosingHandshakeComplete
46    };
47
48    virtual ~WebSocketClient() { }
49    virtual void didConnect(const WebString& subprotocol, const WebString& extensions) { }
50    virtual void didReceiveMessage(const WebString& message) { }
51    virtual void didReceiveArrayBuffer(const WebArrayBuffer& arrayBuffer) { }
52    virtual void didReceiveMessageError() { }
53    virtual void didConsumeBufferedAmount(unsigned long consumed) { }
54    virtual void didStartClosingHandshake() { }
55    virtual void didClose(ClosingHandshakeCompletionStatus, unsigned short code, const WebString& reason) { }
56
57    // FIXME: Deperecate these methods.
58    virtual void didConnect() { }
59    virtual void didUpdateBufferedAmount(unsigned long bufferedAmount) { }
60    virtual void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const WebString& reason) { }
61};
62
63} // namespace blink
64
65#endif // WebSocketClient_h
66