Let the bindings generator use WTF::Optional for optional parameters using [Clamp]
[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(Optional<unsigned short> code, const String& reason, ExceptionCode&);
80
81     const URL& url() const;
82     State readyState() const;
83     unsigned long bufferedAmount() const;
84
85     String protocol() const;
86     String extensions() const;
87
88     String binaryType() const;
89     void setBinaryType(const String&, ExceptionCode&);
90
91     // EventTarget functions.
92     EventTargetInterface eventTargetInterface() const override;
93     ScriptExecutionContext* scriptExecutionContext() const override;
94
95     using RefCounted<WebSocket>::ref;
96     using RefCounted<WebSocket>::deref;
97
98     // WebSocketChannelClient functions.
99     void didConnect() override;
100     void didReceiveMessage(const String& message) override;
101     void didReceiveBinaryData(Vector<uint8_t>&&) override;
102     void didReceiveMessageError() override;
103     void didUpdateBufferedAmount(unsigned long bufferedAmount) override;
104     void didStartClosingHandshake() override;
105     void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) override;
106
107 private:
108     explicit WebSocket(ScriptExecutionContext&);
109
110     void resumeTimerFired();
111     void dispatchOrQueueErrorEvent();
112     void dispatchOrQueueEvent(Ref<Event>&&);
113
114     // ActiveDOMObject API.
115     void contextDestroyed() override;
116     bool canSuspendForDocumentSuspension() const override;
117     void suspend(ReasonForSuspension) override;
118     void resume() override;
119     void stop() override;
120     const char* activeDOMObjectName() const override;
121
122     void refEventTarget() override { ref(); }
123     void derefEventTarget() override { deref(); }
124
125     size_t getFramingOverhead(size_t payloadSize);
126
127     enum BinaryType {
128         BinaryTypeBlob,
129         BinaryTypeArrayBuffer
130     };
131
132     RefPtr<ThreadableWebSocketChannel> m_channel;
133
134     State m_state;
135     URL m_url;
136     unsigned long m_bufferedAmount;
137     unsigned long m_bufferedAmountAfterClose;
138     BinaryType m_binaryType;
139     String m_subprotocol;
140     String m_extensions;
141
142     Timer m_resumeTimer;
143     bool m_shouldDelayEventFiring { false };
144     Deque<Ref<Event>> m_pendingEvents;
145     bool m_dispatchedErrorEvent { false };
146 };
147
148 } // namespace WebCore
149
150 #endif // ENABLE(WEB_SOCKETS)
151
152 #endif // WebSocket_h