Reviewed by Alexey Proskuryakov.
[WebKit-https.git] / 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 "WebSocketHandshake.h"
38 #include <wtf/RefCounted.h>
39
40 namespace WebCore {
41
42     class ScriptExecutionContext;
43     class String;
44     class SocketStreamHandle;
45     class SocketStreamError;
46     class WebSocketChannelClient;
47
48     class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient {
49     public:
50         static PassRefPtr<WebSocketChannel> create(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol) { return new WebSocketChannel(context, client, url, protocol); }
51         virtual ~WebSocketChannel();
52
53         virtual void connect();
54
55         virtual bool send(const String& msg);
56         virtual unsigned long bufferedAmount() const;
57
58         virtual void close();
59
60         virtual void willOpenStream(SocketStreamHandle*, const KURL&);
61         virtual void willSendData(SocketStreamHandle*, const char*, int);
62         virtual void didOpen(SocketStreamHandle*);
63         virtual void didClose(SocketStreamHandle*);
64         virtual void didReceiveData(SocketStreamHandle*, const char*, int);
65         virtual void didFail(SocketStreamHandle*, const SocketStreamError&);
66
67     private:
68         WebSocketChannel(ScriptExecutionContext*, WebSocketChannelClient*, const KURL&, const String&);
69
70         bool appendToBuffer(const char* data, int len);
71         void skipBuffer(int len);
72
73         ScriptExecutionContext* m_context;
74         WebSocketChannelClient* m_client;
75         WebSocketHandshake m_handshake;
76         RefPtr<SocketStreamHandle> m_handle;
77         char* m_buffer;
78         int m_bufferSize;
79         unsigned long m_unhandledBufferSize;
80     };
81
82 }  // namespace WebCore
83
84 #endif  // ENABLE(WEB_SOCKETS)
85
86 #endif  // WebSocketChannel_h