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