Move basic IDBBackingStoreTransaction operations to IDBServerConnection
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBServerConnection.h
1 /*
2  * Copyright (C) 2013 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 IDBServerConnection_h
27 #define IDBServerConnection_h
28
29 #include "IDBMetadata.h"
30 #include "IndexedDB.h"
31 #include <functional>
32 #include <wtf/HashSet.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/text/WTFString.h>
35
36 #if ENABLE(INDEXED_DATABASE)
37
38 namespace WebCore {
39
40 class IDBBackingStoreInterface;
41 class IDBBackingStoreTransactionInterface;
42
43 // This interface provides a single asynchronous layer between the web-facing frontend
44 // and the I/O performing backend of IndexedDatabase.
45 // If an operation's completion needs to be confirmed that must be done through use of a callback function.
46 class IDBServerConnection : public RefCounted<IDBServerConnection> {
47 public:
48     virtual ~IDBServerConnection() { }
49
50     // FIXME: For now, server connection provides a synchronous accessor to the in-process backing store objects.
51     // This is temporary and will be removed soon.
52     virtual IDBBackingStoreInterface* deprecatedBackingStore() = 0;
53     virtual IDBBackingStoreTransactionInterface* deprecatedBackingStoreTransaction(int64_t transactionID) = 0;
54
55     virtual bool isClosed() = 0;
56
57     typedef std::function<void (bool success)> BoolCallbackFunction;
58
59     // Database-level operations
60     typedef std::function<void (const IDBDatabaseMetadata&, bool success)> GetIDBDatabaseMetadataFunction;
61     virtual void getOrEstablishIDBDatabaseMetadata(const String& name, GetIDBDatabaseMetadataFunction) = 0;
62     virtual void deleteDatabase(const String& name, BoolCallbackFunction successCallback) = 0;
63     virtual void close() = 0;
64
65     // Transaction-level operations
66     virtual void openTransaction(int64_t transactionID, const HashSet<int64_t>& objectStoreIds, IndexedDB::TransactionMode, BoolCallbackFunction successCallback) = 0;
67     virtual void beginTransaction(int64_t transactionID, std::function<void()> completionCallback) = 0;
68     virtual void commitTransaction(int64_t transactionID, BoolCallbackFunction successCallback) = 0;
69     virtual void resetTransaction(int64_t transactionID, std::function<void()> completionCallback) = 0;
70     virtual void rollbackTransaction(int64_t transactionID, std::function<void()> completionCallback) = 0;
71 };
72
73 } // namespace WebCore
74
75 #endif // ENABLE(INDEXED_DATABASE)
76 #endif // IDBServerConnection_h