Modern IDB: Pipe through cursor functions from client to server.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / UniqueIDBDatabaseTransaction.h
1 /*
2  * Copyright (C) 2015 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 #ifndef UniqueIDBDatabaseTransaction_h
27 #define UniqueIDBDatabaseTransaction_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBTransactionInfo.h"
32 #include "UniqueIDBDatabaseConnection.h"
33 #include <wtf/Ref.h>
34 #include <wtf/RefCounted.h>
35
36 namespace WebCore {
37
38 class IDBCursorInfo;
39 class IDBDatabaseInfo;
40 class IDBError;
41 class IDBIndexInfo;
42 class IDBKeyData;
43 class IDBObjectStoreInfo;
44 class IDBRequestData;
45 class ThreadSafeDataBuffer;
46
47 struct IDBKeyRangeData;
48
49 namespace IDBServer {
50
51 class UniqueIDBDatabaseConnection;
52
53 class UniqueIDBDatabaseTransaction : public RefCounted<UniqueIDBDatabaseTransaction> {
54 public:
55     static Ref<UniqueIDBDatabaseTransaction> create(UniqueIDBDatabaseConnection&, const IDBTransactionInfo&);
56
57     ~UniqueIDBDatabaseTransaction();
58
59     UniqueIDBDatabaseConnection& databaseConnection() { return m_databaseConnection.get(); }
60     const IDBTransactionInfo& info() const { return m_transactionInfo; }
61     bool isVersionChange() const;
62     bool isReadOnly() const;
63
64     IDBDatabaseInfo* originalDatabaseInfo() const;
65
66     void abort();
67     void commit();
68
69     void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
70     void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
71     void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
72     void createIndex(const IDBRequestData&, const IDBIndexInfo&);
73     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
74     void getRecord(const IDBRequestData&, const IDBKeyRangeData&);
75     void getCount(const IDBRequestData&, const IDBKeyRangeData&);
76     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
77     void openCursor(const IDBRequestData&, const IDBCursorInfo&);
78     void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count);
79
80     void didActivateInBackingStore(const IDBError&);
81
82     const Vector<uint64_t>& objectStoreIdentifiers();
83
84 private:
85     UniqueIDBDatabaseTransaction(UniqueIDBDatabaseConnection&, const IDBTransactionInfo&);
86
87     Ref<UniqueIDBDatabaseConnection> m_databaseConnection;
88     IDBTransactionInfo m_transactionInfo;
89
90     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfo;
91
92     Vector<uint64_t> m_objectStoreIdentifiers;
93 };
94
95 } // namespace IDBServer
96 } // namespace WebCore
97
98 #endif // ENABLE(INDEXED_DATABASE)
99 #endif // UniqueIDBDatabaseTransaction_h