Add a new Logging Channel for IndexedDB Operation scheduling.
[WebKit.git] / Source / WebCore / Modules / indexeddb / shared / IDBGetAllRecordsData.h
1 /*
2  * Copyright (C) 2016 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 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBKeyRangeData.h"
31 #include <wtf/Optional.h>
32
33 namespace WebCore {
34
35 namespace IndexedDB {
36 enum class DataSource;
37 enum class GetAllType;
38 }
39
40 struct IDBGetAllRecordsData {
41     IDBKeyRangeData keyRangeData;
42     IndexedDB::GetAllType getAllType;
43     std::optional<uint32_t> count;
44     uint64_t objectStoreIdentifier;
45     uint64_t indexIdentifier;
46
47     IDBGetAllRecordsData isolatedCopy() const;
48
49 #if !LOG_DISABLED
50     String loggingString() const;
51 #endif
52
53     template<class Encoder> void encode(Encoder&) const;
54     template<class Decoder> static bool decode(Decoder&, IDBGetAllRecordsData&);
55 };
56
57 template<class Encoder>
58 void IDBGetAllRecordsData::encode(Encoder& encoder) const
59 {
60     encoder << keyRangeData;
61     encoder.encodeEnum(getAllType);
62     encoder << count << objectStoreIdentifier << indexIdentifier;
63 }
64
65 template<class Decoder>
66 bool IDBGetAllRecordsData::decode(Decoder& decoder, IDBGetAllRecordsData& getAllRecordsData)
67 {
68     if (!decoder.decode(getAllRecordsData.keyRangeData))
69         return false;
70
71     if (!decoder.decodeEnum(getAllRecordsData.getAllType))
72         return false;
73
74     if (!decoder.decode(getAllRecordsData.count))
75         return false;
76
77     if (!decoder.decode(getAllRecordsData.objectStoreIdentifier))
78         return false;
79
80     if (!decoder.decode(getAllRecordsData.indexIdentifier))
81         return false;
82
83     return true;
84 }
85
86 } // namespace WebCore
87
88 #endif // ENABLE(INDEXED_DATABASE)