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 "WebSocketHandshake.h"
39#include <wtf/RefCounted.h>
40
41namespace WebCore {
42
43    class ScriptExecutionContext;
44    class String;
45    class SocketStreamHandle;
46    class SocketStreamError;
47    class WebSocketChannelClient;
48
49    class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient, public ThreadableWebSocketChannel {
50    public:
51        static PassRefPtr<WebSocketChannel> create(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol) { return adoptRef(new WebSocketChannel(context, client, url, protocol)); }
52        virtual ~WebSocketChannel();
53
54        virtual void connect();
55        virtual bool send(const String& message);
56        virtual unsigned long bufferedAmount() const;
57        virtual void close();
58        virtual void disconnect(); // Will suppress didClose().
59
60        virtual void didOpen(SocketStreamHandle*);
61        virtual void didClose(SocketStreamHandle*);
62        virtual void didReceiveData(SocketStreamHandle*, const char*, int);
63        virtual void didFail(SocketStreamHandle*, const SocketStreamError&);
64        virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
65        virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&);
66
67        using RefCounted<WebSocketChannel>::ref;
68        using RefCounted<WebSocketChannel>::deref;
69
70    protected:
71        virtual void refThreadableWebSocketChannel() { ref(); }
72        virtual void derefThreadableWebSocketChannel() { deref(); }
73
74    private:
75        WebSocketChannel(ScriptExecutionContext*, WebSocketChannelClient*, const KURL&, const String& protocol);
76
77        bool appendToBuffer(const char* data, int len);
78        void skipBuffer(int len);
79
80        ScriptExecutionContext* m_context;
81        WebSocketChannelClient* m_client;
82        WebSocketHandshake m_handshake;
83        RefPtr<SocketStreamHandle> m_handle;
84        char* m_buffer;
85        int m_bufferSize;
86    };
87
88} // namespace WebCore
89
90#endif // ENABLE(WEB_SOCKETS)
91
92#endif // WebSocketChannel_h
93