2011-05-24 Yuta Kitamura <yutak@chromium.org>
[WebKit-https.git] / Source / WebCore / websockets / WebSocketChannel.h
1 /*
2  * Copyright (C) 2009 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 void connect();
58         virtual bool send(const String& message);
59         virtual unsigned long bufferedAmount() const;
60         virtual void close();
61         virtual void fail(const String& reason);
62         virtual void disconnect();
63
64         virtual void suspend();
65         virtual void resume();
66
67         virtual void didOpen(SocketStreamHandle*);
68         virtual void didClose(SocketStreamHandle*);
69         virtual void didReceiveData(SocketStreamHandle*, const char*, int);
70         virtual void didFail(SocketStreamHandle*, const SocketStreamError&);
71         virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
72         virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
73
74         using RefCounted<WebSocketChannel>::ref;
75         using RefCounted<WebSocketChannel>::deref;
76
77     protected:
78         virtual void refThreadableWebSocketChannel() { ref(); }
79         virtual void derefThreadableWebSocketChannel() { deref(); }
80
81     private:
82         WebSocketChannel(ScriptExecutionContext*, WebSocketChannelClient*, const KURL&, const String& protocol);
83
84         bool appendToBuffer(const char* data, size_t len);
85         void skipBuffer(size_t len);
86         bool processBuffer();
87         void resumeTimerFired(Timer<WebSocketChannel>* timer);
88
89         ScriptExecutionContext* m_context;
90         WebSocketChannelClient* m_client;
91         WebSocketHandshake m_handshake;
92         RefPtr<SocketStreamHandle> m_handle;
93         char* m_buffer;
94         size_t m_bufferSize;
95
96         Timer<WebSocketChannel> m_resumeTimer;
97         bool m_suspended;
98         bool m_closed;
99         bool m_shouldDiscardReceivedData;
100         unsigned long m_unhandledBufferedAmount;
101
102         unsigned long m_identifier; // m_identifier == 0 means that we could not obtain a valid identifier.
103     };
104
105 } // namespace WebCore
106
107 #endif // ENABLE(WEB_SOCKETS)
108
109 #endif // WebSocketChannel_h