[WebSocket]Browser must fail connection if Sec-WebSocket-Protocol mismatched.
[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 "KURL.h"
41 #include "WebSocketChannelClient.h"
42 #include <wtf/Forward.h>
43 #include <wtf/OwnPtr.h>
44 #include <wtf/RefCounted.h>
45 #include <wtf/text/AtomicStringHash.h>
46
47 namespace WebCore {
48
49 class Blob;
50 class ThreadableWebSocketChannel;
51
52 class WebSocket : public RefCounted<WebSocket>, public EventTarget, public ActiveDOMObject, public WebSocketChannelClient {
53 public:
54     static void setIsAvailable(bool);
55     static bool isAvailable();
56     static const char* subProtocolSeperator();
57     static PassRefPtr<WebSocket> create(ScriptExecutionContext*);
58     virtual ~WebSocket();
59
60     enum State {
61         CONNECTING = 0,
62         OPEN = 1,
63         CLOSING = 2,
64         CLOSED = 3
65     };
66
67     void connect(const String& url, ExceptionCode&);
68     void connect(const String& url, const String& protocol, ExceptionCode&);
69     void connect(const String& url, const Vector<String>& protocols, ExceptionCode&);
70
71     bool send(const String& message, ExceptionCode&);
72     bool send(ArrayBuffer*, ExceptionCode&);
73     bool send(Blob*, ExceptionCode&);
74
75     void close(int code, const String& reason, ExceptionCode&);
76
77     const KURL& url() const;
78     State readyState() const;
79     unsigned long bufferedAmount() const;
80
81     String protocol() const;
82     String extensions() const;
83
84     String binaryType() const;
85     void setBinaryType(const String& binaryType, ExceptionCode&);
86
87     DEFINE_ATTRIBUTE_EVENT_LISTENER(open);
88     DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
89     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
90     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
91
92     // EventTarget functions.
93     virtual const AtomicString& interfaceName() const OVERRIDE;
94     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
95
96     // ActiveDOMObject functions.
97     virtual void contextDestroyed() OVERRIDE;
98     virtual bool canSuspend() const OVERRIDE;
99     virtual void suspend(ReasonForSuspension) OVERRIDE;
100     virtual void resume() OVERRIDE;
101     virtual void stop() 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     WebSocket(ScriptExecutionContext*);
117
118     virtual void refEventTarget() { ref(); }
119     virtual void derefEventTarget() { deref(); }
120     virtual EventTargetData* eventTargetData();
121     virtual EventTargetData* ensureEventTargetData();
122
123     size_t getFramingOverhead(size_t payloadSize);
124
125     enum BinaryType {
126         BinaryTypeBlob,
127         BinaryTypeArrayBuffer
128     };
129
130     RefPtr<ThreadableWebSocketChannel> m_channel;
131
132     State m_state;
133     KURL m_url;
134     EventTargetData m_eventTargetData;
135     unsigned long m_bufferedAmount;
136     unsigned long m_bufferedAmountAfterClose;
137     BinaryType m_binaryType;
138     bool m_useHixie76Protocol;
139     String m_subprotocol;
140     String m_extensions;
141 };
142
143 } // namespace WebCore
144
145 #endif // ENABLE(WEB_SOCKETS)
146
147 #endif // WebSocket_h