IndexedDB 2.0: "close pending flag" and firing blocked events all need fixing.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBConnectionToServerDelegate.h
1 /*
2  * Copyright (C) 2015, 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 <wtf/text/WTFString.h>
31
32 namespace WebCore {
33
34 class IDBCursorInfo;
35 class IDBIndexInfo;
36 class IDBKeyData;
37 class IDBObjectStoreInfo;
38 class IDBRequestData;
39 class IDBResourceIdentifier;
40 class IDBTransactionInfo;
41 class IDBValue;
42
43 struct IDBGetAllRecordsData;
44 struct IDBGetRecordData;
45 struct IDBIterateCursorData;
46 struct SecurityOriginData;
47
48 namespace IndexedDB {
49 enum class ObjectStoreOverwriteMode;
50 }
51
52 struct IDBKeyRangeData;
53
54 namespace IDBClient {
55
56 class IDBConnectionToServerDelegate {
57 public:
58     virtual ~IDBConnectionToServerDelegate() { }
59
60     virtual uint64_t identifier() const = 0;
61     virtual void deleteDatabase(const IDBRequestData&) = 0;
62     virtual void openDatabase(const IDBRequestData&) = 0;
63     virtual void abortTransaction(const IDBResourceIdentifier&) = 0;
64     virtual void commitTransaction(const IDBResourceIdentifier&) = 0;
65     virtual void didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier&) = 0;
66     virtual void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&) = 0;
67     virtual void deleteObjectStore(const IDBRequestData&, const String& objectStoreName) = 0;
68     virtual void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName) = 0;
69     virtual void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier) = 0;
70     virtual void createIndex(const IDBRequestData&, const IDBIndexInfo&) = 0;
71     virtual void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName) = 0;
72     virtual void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName) = 0;
73     virtual void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, const IndexedDB::ObjectStoreOverwriteMode) = 0;
74     virtual void getRecord(const IDBRequestData&, const IDBGetRecordData&) = 0;
75     virtual void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&) = 0;
76     virtual void getCount(const IDBRequestData&, const IDBKeyRangeData&) = 0;
77     virtual void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&) = 0;
78     virtual void openCursor(const IDBRequestData&, const IDBCursorInfo&) = 0;
79     virtual void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&) = 0;
80
81     virtual void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&) = 0;
82     virtual void databaseConnectionPendingClose(uint64_t databaseConnectionIdentifier) = 0;
83     virtual void databaseConnectionClosed(uint64_t databaseConnectionIdentifier) = 0;
84     virtual void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier) = 0;
85     virtual void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier) = 0;
86     virtual void openDBRequestCancelled(const IDBRequestData&) = 0;
87     virtual void confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier) = 0;
88
89     virtual void getAllDatabaseNames(const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID) = 0;
90
91     virtual void ref() = 0;
92     virtual void deref() = 0;
93 };
94
95 } // namespace IDBClient
96 } // namespace WebCore
97
98 #endif // ENABLE(INDEXED_DATABASE)