WebSocket: Pass the value of useHixie76Protocol flag to WebSocket object
[WebKit-https.git] / Source / WebCore / websockets / WebSocketChannel.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 WebSocketChannel_h
32 #define WebSocketChannel_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "SocketStreamHandleClient.h"
37 #include "ThreadableWebSocketChannel.h"
38 #include "Timer.h"
39 #include "WebSocketHandshake.h"
40 #include <wtf/Forward.h>
41 #include <wtf/RefCounted.h>
42 #include <wtf/Vector.h>
43
44 namespace WebCore {
45
46     class ScriptExecutionContext;
47     class SocketStreamHandle;
48     class SocketStreamError;
49     class WebSocketChannelClient;
50
51     class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient, public ThreadableWebSocketChannel {
52         WTF_MAKE_FAST_ALLOCATED;
53     public:
54         static PassRefPtr<WebSocketChannel> create(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol) { return adoptRef(new WebSocketChannel(context, client, url, protocol)); }
55         virtual ~WebSocketChannel();
56
57         virtual bool useHixie76Protocol();
58         virtual void connect();
59         virtual bool send(const String& message);
60         virtual unsigned long bufferedAmount() const;
61         virtual void close(); // Start closing handshake.
62         virtual void fail(const String& reason);
63         virtual void disconnect();
64
65         virtual void suspend();
66         virtual void resume();
67
68         virtual void didOpen(SocketStreamHandle*);
69         virtual void didClose(SocketStreamHandle*);
70         virtual void didReceiveData(SocketStreamHandle*, const char*, int);
71         virtual void didFail(SocketStreamHandle*, const SocketStreamError&);
72         virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
73         virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
74
75         using RefCounted<WebSocketChannel>::ref;
76         using RefCounted<WebSocketChannel>::deref;
77
78     protected:
79         virtual void refThreadableWebSocketChannel() { ref(); }
80         virtual void derefThreadableWebSocketChannel() { deref(); }
81
82     private:
83         WebSocketChannel(ScriptExecutionContext*, WebSocketChannelClient*, const KURL&, const String& protocol);
84
85         bool appendToBuffer(const char* data, size_t len);
86         void skipBuffer(size_t len);
87         bool processBuffer();
88         void resumeTimerFired(Timer<WebSocketChannel>* timer);
89         void startClosingHandshake();
90         void closingTimerFired(Timer<WebSocketChannel>*);
91
92         // Hybi-10 opcodes.
93         typedef unsigned int OpCode;
94         static const OpCode OpCodeContinuation;
95         static const OpCode OpCodeText;
96         static const OpCode OpCodeBinary;
97         static const OpCode OpCodeClose;
98         static const OpCode OpCodePing;
99         static const OpCode OpCodePong;
100
101         static bool isNonControlOpCode(OpCode opCode) { return opCode == OpCodeContinuation || opCode == OpCodeText || opCode == OpCodeBinary; }
102         static bool isControlOpCode(OpCode opCode) { return opCode == OpCodeClose || opCode == OpCodePing || opCode == OpCodePong; }
103         static bool isReservedOpCode(OpCode opCode) { return !isNonControlOpCode(opCode) && !isControlOpCode(opCode); }
104
105         enum ParseFrameResult {
106             FrameOK,
107             FrameIncomplete,
108             FrameError
109         };
110
111         struct FrameData {
112             OpCode opCode;
113             bool final;
114             bool reserved1;
115             bool reserved2;
116             bool reserved3;
117             bool masked;
118             const char* payload;
119             size_t payloadLength;
120             const char* frameEnd;
121         };
122
123         ParseFrameResult parseFrame(FrameData&); // May modify part of m_buffer to unmask the frame.
124
125         bool processFrame();
126         bool processFrameHixie76();
127
128         bool sendFrame(OpCode, const char* data, size_t dataLength);
129         bool sendFrameHixie76(const char* data, size_t dataLength);
130
131         ScriptExecutionContext* m_context;
132         WebSocketChannelClient* m_client;
133         OwnPtr<WebSocketHandshake> m_handshake;
134         RefPtr<SocketStreamHandle> m_handle;
135         char* m_buffer;
136         size_t m_bufferSize;
137
138         Timer<WebSocketChannel> m_resumeTimer;
139         bool m_suspended;
140         bool m_closing;
141         bool m_receivedClosingHandshake;
142         Timer<WebSocketChannel> m_closingTimer;
143         bool m_closed;
144         bool m_shouldDiscardReceivedData;
145         unsigned long m_unhandledBufferedAmount;
146
147         unsigned long m_identifier; // m_identifier == 0 means that we could not obtain a valid identifier.
148
149         bool m_useHixie76Protocol;
150
151         // Private members only for hybi-10 protocol.
152         bool m_hasContinuousFrame;
153         OpCode m_continuousFrameOpCode;
154         Vector<char> m_continuousFrameData;
155     };
156
157 } // namespace WebCore
158
159 #endif // ENABLE(WEB_SOCKETS)
160
161 #endif // WebSocketChannel_h