WebSocket: Receive binary message as ArrayBuffer
[WebKit-https.git] / Source / WebCore / dom / MessageEvent.h
1 /*
2  * Copyright (C) 2007 Henry Mason (hmason@mac.com)
3  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  *
26  */
27
28 #ifndef MessageEvent_h
29 #define MessageEvent_h
30
31 #include "ArrayBuffer.h"
32 #include "Blob.h"
33 #include "DOMWindow.h"
34 #include "Event.h"
35 #include "MessagePort.h"
36 #include "SerializedScriptValue.h"
37
38 namespace WebCore {
39
40     class DOMWindow;
41
42     class MessageEvent : public Event {
43     public:
44         static PassRefPtr<MessageEvent> create()
45         {
46             return adoptRef(new MessageEvent);
47         }
48         static PassRefPtr<MessageEvent> create(PassOwnPtr<MessagePortArray> ports, PassRefPtr<SerializedScriptValue> data = 0, const String& origin = "", const String& lastEventId = "", PassRefPtr<DOMWindow> source = 0)
49         {
50             return adoptRef(new MessageEvent(data, origin, lastEventId, source, ports));
51         }
52         static PassRefPtr<MessageEvent> create(const String& data)
53         {
54             return adoptRef(new MessageEvent(data));
55         }
56         static PassRefPtr<MessageEvent> create(PassRefPtr<Blob> data)
57         {
58             return adoptRef(new MessageEvent(data));
59         }
60         static PassRefPtr<MessageEvent> create(PassRefPtr<ArrayBuffer> data)
61         {
62             return adoptRef(new MessageEvent(data));
63         }
64         virtual ~MessageEvent();
65
66         void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, PassOwnPtr<MessagePortArray>);
67
68         const String& origin() const { return m_origin; }
69         const String& lastEventId() const { return m_lastEventId; }
70         DOMWindow* source() const { return m_source.get(); }
71         MessagePortArray* ports() const { return m_ports.get(); }
72
73         // FIXME: Remove this when we have custom ObjC binding support.
74         SerializedScriptValue* data() const;
75
76         // FIXME: remove this when we update the ObjC bindings (bug #28774).
77         MessagePort* messagePort();
78         // FIXME: remove this when we update the ObjC bindings (bug #28774).
79         void initMessageEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, DOMWindow* source, MessagePort*);
80
81         virtual bool isMessageEvent() const;
82
83         enum DataType {
84             DataTypeSerializedScriptValue,
85             DataTypeString,
86             DataTypeBlob,
87             DataTypeArrayBuffer
88         };
89         DataType dataType() const { return m_dataType; }
90         SerializedScriptValue* dataAsSerializedScriptValue() const { return m_dataAsSerializedScriptValue.get(); }
91         String dataAsString() const { return m_dataAsString; }
92         Blob* dataAsBlob() const { return m_dataAsBlob.get(); }
93         ArrayBuffer* dataAsArrayBuffer() const { return m_dataAsArrayBuffer.get(); }
94
95     private:
96         MessageEvent();
97         MessageEvent(PassRefPtr<SerializedScriptValue> data, const String& origin, const String& lastEventId, PassRefPtr<DOMWindow> source, PassOwnPtr<MessagePortArray>);
98         explicit MessageEvent(const String& data);
99         explicit MessageEvent(PassRefPtr<Blob> data);
100         explicit MessageEvent(PassRefPtr<ArrayBuffer> data);
101
102         DataType m_dataType;
103         RefPtr<SerializedScriptValue> m_dataAsSerializedScriptValue;
104         String m_dataAsString;
105         RefPtr<Blob> m_dataAsBlob;
106         RefPtr<ArrayBuffer> m_dataAsArrayBuffer;
107         String m_origin;
108         String m_lastEventId;
109         RefPtr<DOMWindow> m_source;
110         OwnPtr<MessagePortArray> m_ports;
111     };
112
113 } // namespace WebCore
114
115 #endif // MessageEvent_h