Reviewed by Alexey Proskuryakov.
[WebKit-https.git] / WebCore / websockets / WebSocket.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 WebSocket_h
32 #define WebSocket_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "ActiveDOMObject.h"
37 #include "AtomicStringHash.h"
38 #include "EventListener.h"
39 #include "EventTarget.h"
40 #include "KURL.h"
41 #include "WebSocketChannelClient.h"
42 #include <wtf/OwnPtr.h>
43 #include <wtf/RefCounted.h>
44
45 namespace WebCore {
46
47     class String;
48     class WebSocketChannel;
49
50     class WebSocket : public RefCounted<WebSocket>, public EventTarget, public ActiveDOMObject, public WebSocketChannelClient {
51     public:
52         static PassRefPtr<WebSocket> create(ScriptExecutionContext* context) { return adoptRef(new WebSocket(context)); }
53         virtual ~WebSocket();
54
55         enum State {
56             CONNECTING = 0,
57             OPEN = 1,
58             CLOSED = 2
59         };
60
61         void connect(const KURL&, ExceptionCode&);
62         void connect(const KURL&, const String& protocol, ExceptionCode&);
63
64         bool send(const String& message, ExceptionCode&);
65
66         void close();
67
68         const KURL& url() const;
69         State readyState() const;
70         unsigned long bufferedAmount() const;
71
72         void setOnopen(PassRefPtr<EventListener> eventListener) { m_onopen = eventListener; }
73         EventListener* onopen() const { return m_onopen.get(); }
74         void setOnmessage(PassRefPtr<EventListener> eventListener) { m_onmessage = eventListener; }
75         EventListener* onmessage() const { return m_onmessage.get(); }
76         void setOnclose(PassRefPtr<EventListener> eventListener) { m_onclose = eventListener; }
77         EventListener* onclose() const { return m_onclose.get(); }
78
79         // EventTarget
80         virtual WebSocket* toWebSocket() { return this; }
81
82         virtual ScriptExecutionContext* scriptExecutionContext() const;
83
84         typedef Vector<RefPtr<EventListener> > ListenerVector;
85         typedef HashMap<AtomicString, ListenerVector> EventListenersMap;
86
87         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
88         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
89         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&);
90         EventListenersMap& eventListeners() { return m_eventListeners; }
91
92         // ActiveDOMObject
93         //  virtual bool hasPendingActivity() const;
94         // virtual void contextDestroyed();
95         // virtual bool canSuspend() const;
96         // virtual void suspend();
97         // virtual void resume();
98         // virtual void stop();
99
100         using RefCounted<WebSocket>::ref;
101         using RefCounted<WebSocket>::deref;
102
103         // WebSocketChannelClient
104         virtual void didConnect();
105         virtual void didReceiveMessage(const String& msg);
106         virtual void didClose();
107
108     private:
109         WebSocket(ScriptExecutionContext*);
110
111         virtual void refEventTarget() { ref(); }
112         virtual void derefEventTarget() { deref(); }
113
114         void dispatchOpenEvent(Event*);
115         void dispatchMessageEvent(Event*);
116         void dispatchCloseEvent(Event*);
117
118         RefPtr<WebSocketChannel> m_channel;
119
120         RefPtr<EventListener> m_onopen;
121         RefPtr<EventListener> m_onmessage;
122         RefPtr<EventListener> m_onclose;
123         EventListenersMap m_eventListeners;
124
125         State m_state;
126         KURL m_url;
127         String m_protocol;
128     };
129
130 }  // namespace WebCore
131
132 #endif  // ENABLE(WEB_SOCKETS)
133
134 #endif  // WebSocket_h