REGRESSION(r227340): ArrayBuffers were not being serialized when sent via MessagePorts
[WebKit-https.git] / Source / WebCore / dom / messageports / MessageWithMessagePorts.h
1 /*
2  * Copyright (C) 2018 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "MessagePortIdentifier.h"
29 #include "SerializedScriptValue.h"
30 #include <wtf/RefPtr.h>
31
32 namespace WebCore {
33
34 // When a message port is transferred, it is represented by a pair of identifiers.
35 // The first identifier is the port being transferred and the second is its remote port.
36 typedef Vector<std::pair<WebCore::MessagePortIdentifier, WebCore::MessagePortIdentifier>> TransferredMessagePortArray;
37
38 struct MessageWithMessagePorts {
39     RefPtr<SerializedScriptValue> message;
40     TransferredMessagePortArray transferredPorts;
41
42     template<class Encoder> void encode(Encoder&) const;
43     template<class Decoder> static std::optional<MessageWithMessagePorts> decode(Decoder&);
44 };
45
46
47 template<class Encoder>
48 void MessageWithMessagePorts::encode(Encoder& encoder) const
49 {
50     ASSERT(message);
51     encoder << *message << transferredPorts;
52 }
53
54 template<class Decoder>
55 std::optional<MessageWithMessagePorts> MessageWithMessagePorts::decode(Decoder& decoder)
56 {
57     MessageWithMessagePorts result;
58
59     result.message = SerializedScriptValue::decode(decoder);
60     if (!result.message)
61         return std::nullopt;
62
63     if (!decoder.decode(result.transferredPorts))
64         return std::nullopt;
65
66     return result;
67 }
68
69 } // namespace WebCore