Modern IDB: Pipe through cursor functions from client to server.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBConnectionToServerDelegate.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 IDBConnectionToServerDelegate_h
27 #define IDBConnectionToServerDelegate_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include <wtf/text/WTFString.h>
32
33 namespace WebCore {
34
35 class IDBCursorInfo;
36 class IDBIndexInfo;
37 class IDBKey;
38 class IDBKeyData;
39 class IDBObjectStoreInfo;
40 class IDBRequestData;
41 class IDBResourceIdentifier;
42 class IDBTransactionInfo;
43 class SerializedScriptValue;
44
45 namespace IndexedDB {
46 enum class ObjectStoreOverwriteMode;
47 }
48
49 struct IDBKeyRangeData;
50
51 namespace IDBClient {
52
53 class IDBConnectionToServerDelegate {
54 public:
55     virtual ~IDBConnectionToServerDelegate() { }
56
57     virtual uint64_t identifier() const = 0;
58     virtual void deleteDatabase(IDBRequestData&) = 0;
59     virtual void openDatabase(IDBRequestData&) = 0;
60     virtual void abortTransaction(IDBResourceIdentifier&) = 0;
61     virtual void commitTransaction(IDBResourceIdentifier&) = 0;
62     virtual void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&) = 0;
63     virtual void deleteObjectStore(const IDBRequestData&, const String& objectStoreName) = 0;
64     virtual void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier) = 0;
65     virtual void createIndex(const IDBRequestData&, const IDBIndexInfo&) = 0;
66     virtual void putOrAdd(const IDBRequestData&, IDBKey*, SerializedScriptValue&, const IndexedDB::ObjectStoreOverwriteMode) = 0;
67     virtual void getRecord(const IDBRequestData&, const IDBKeyRangeData&) = 0;
68     virtual void getCount(const IDBRequestData&, const IDBKeyRangeData&) = 0;
69     virtual void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&) = 0;
70     virtual void openCursor(const IDBRequestData&, const IDBCursorInfo&) = 0;
71     virtual void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count) = 0;
72
73     virtual void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&) = 0;
74
75     virtual void databaseConnectionClosed(uint64_t databaseConnectionIdentifier) = 0;
76
77     virtual void ref() = 0;
78     virtual void deref() = 0;
79 };
80
81 } // namespace IDBClient
82 } // namespace WebCore
83
84 #endif // ENABLE(INDEXED_DATABASE)
85 #endif // IDBConnectionToServerDelegate_h