Leaf EventTarget subclasses should be FINAL.
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocket.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 WebSocket_h
32 #define WebSocket_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "ActiveDOMObject.h"
37 #include "EventListener.h"
38 #include "EventNames.h"
39 #include "EventTarget.h"
40 #include "URL.h"
41 #include "WebSocketChannel.h"
42 #include "WebSocketChannelClient.h"
43 #include <wtf/Forward.h>
44 #include <wtf/OwnPtr.h>
45 #include <wtf/RefCounted.h>
46 #include <wtf/text/AtomicStringHash.h>
47
48 namespace WebCore {
49
50 class Blob;
51 class ThreadableWebSocketChannel;
52
53 class WebSocket FINAL : public RefCounted<WebSocket>, public EventTargetWithInlineData, public ActiveDOMObject, public WebSocketChannelClient {
54 public:
55     static void setIsAvailable(bool);
56     static bool isAvailable();
57     static const char* subProtocolSeperator();
58     static PassRefPtr<WebSocket> create(ScriptExecutionContext*);
59     static PassRefPtr<WebSocket> create(ScriptExecutionContext*, const String& url, ExceptionCode&);
60     static PassRefPtr<WebSocket> create(ScriptExecutionContext*, const String& url, const String& protocol, ExceptionCode&);
61     static PassRefPtr<WebSocket> create(ScriptExecutionContext*, const String& url, const Vector<String>& protocols, ExceptionCode&);
62     virtual ~WebSocket();
63
64     enum State {
65         CONNECTING = 0,
66         OPEN = 1,
67         CLOSING = 2,
68         CLOSED = 3
69     };
70
71     void connect(const String& url, ExceptionCode&);
72     void connect(const String& url, const String& protocol, ExceptionCode&);
73     void connect(const String& url, const Vector<String>& protocols, ExceptionCode&);
74
75     void send(const String& message, ExceptionCode&);
76     void send(JSC::ArrayBuffer*, ExceptionCode&);
77     void send(JSC::ArrayBufferView*, ExceptionCode&);
78     void send(Blob*, ExceptionCode&);
79
80     void close(int code, const String& reason, ExceptionCode&);
81     void close(ExceptionCode& ec) { close(WebSocketChannel::CloseEventCodeNotSpecified, String(), ec); }
82     void close(int code, ExceptionCode& ec) { close(code, String(), ec); }
83
84     const URL& url() const;
85     State readyState() const;
86     unsigned long bufferedAmount() const;
87
88     String protocol() const;
89     String extensions() const;
90
91     String binaryType() const;
92     void setBinaryType(const String&);
93
94     DEFINE_ATTRIBUTE_EVENT_LISTENER(open);
95     DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
96     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
97     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
98
99     // EventTarget functions.
100     virtual EventTargetInterface eventTargetInterface() const OVERRIDE;
101     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
102
103     using RefCounted<WebSocket>::ref;
104     using RefCounted<WebSocket>::deref;
105
106     // WebSocketChannelClient functions.
107     virtual void didConnect() OVERRIDE;
108     virtual void didReceiveMessage(const String& message) OVERRIDE;
109     virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> >) OVERRIDE;
110     virtual void didReceiveMessageError() OVERRIDE;
111     virtual void didUpdateBufferedAmount(unsigned long bufferedAmount) OVERRIDE;
112     virtual void didStartClosingHandshake() OVERRIDE;
113     virtual void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) OVERRIDE;
114
115 private:
116     explicit WebSocket(ScriptExecutionContext*);
117
118     // ActiveDOMObject functions.
119     virtual void contextDestroyed() OVERRIDE;
120     virtual bool canSuspend() const OVERRIDE;
121     virtual void suspend(ReasonForSuspension) OVERRIDE;
122     virtual void resume() OVERRIDE;
123     virtual void stop() OVERRIDE;
124
125     virtual void refEventTarget() OVERRIDE { ref(); }
126     virtual void derefEventTarget() OVERRIDE { deref(); }
127
128     size_t getFramingOverhead(size_t payloadSize);
129
130     enum BinaryType {
131         BinaryTypeBlob,
132         BinaryTypeArrayBuffer
133     };
134
135     RefPtr<ThreadableWebSocketChannel> m_channel;
136
137     State m_state;
138     URL m_url;
139     unsigned long m_bufferedAmount;
140     unsigned long m_bufferedAmountAfterClose;
141     BinaryType m_binaryType;
142     String m_subprotocol;
143     String m_extensions;
144 };
145
146 } // namespace WebCore
147
148 #endif // ENABLE(WEB_SOCKETS)
149
150 #endif // WebSocket_h