Merge Chromium + Blink git repositories
[chromium-blink-merge.git] / content / child / indexed_db / webidbcursor_impl.h
blob39282ea002af701e55bd885ecefc0bd4291354d0
1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CONTENT_CHILD_INDEXED_DB_WEBIDBCURSOR_IMPL_H_
6 #define CONTENT_CHILD_INDEXED_DB_WEBIDBCURSOR_IMPL_H_
8 #include <deque>
9 #include <vector>
11 #include "base/basictypes.h"
12 #include "base/compiler_specific.h"
13 #include "base/gtest_prod_util.h"
14 #include "base/memory/ref_counted.h"
15 #include "content/common/content_export.h"
16 #include "content/common/indexed_db/indexed_db_key.h"
17 #include "third_party/WebKit/public/platform/WebData.h"
18 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBCallbacks.h"
19 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBCursor.h"
20 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBKey.h"
22 namespace content {
23 class ThreadSafeSender;
25 class CONTENT_EXPORT WebIDBCursorImpl
26 : NON_EXPORTED_BASE(public blink::WebIDBCursor) {
27 public:
28 WebIDBCursorImpl(int32 ipc_cursor_id,
29 int64 transaction_id,
30 ThreadSafeSender* thread_safe_sender);
31 virtual ~WebIDBCursorImpl();
33 virtual void advance(unsigned long count, blink::WebIDBCallbacks* callback);
34 virtual void continueFunction(const blink::WebIDBKey& key,
35 blink::WebIDBCallbacks* callback);
36 virtual void continueFunction(const blink::WebIDBKey& key,
37 const blink::WebIDBKey& primary_key,
38 blink::WebIDBCallbacks* callback);
39 virtual void postSuccessHandlerCallback();
41 void SetPrefetchData(
42 const std::vector<IndexedDBKey>& keys,
43 const std::vector<IndexedDBKey>& primary_keys,
44 const std::vector<blink::WebData>& values,
45 const std::vector<blink::WebVector<blink::WebBlobInfo> >& blob_info);
47 void CachedAdvance(unsigned long count, blink::WebIDBCallbacks* callbacks);
48 void CachedContinue(blink::WebIDBCallbacks* callbacks);
50 // This method is virtual so it can be overridden in unit tests.
51 virtual void ResetPrefetchCache();
53 int64 transaction_id() const { return transaction_id_; }
55 private:
56 FRIEND_TEST_ALL_PREFIXES(IndexedDBDispatcherTest, CursorReset);
57 FRIEND_TEST_ALL_PREFIXES(IndexedDBDispatcherTest, CursorTransactionId);
58 FRIEND_TEST_ALL_PREFIXES(WebIDBCursorImplTest, AdvancePrefetchTest);
59 FRIEND_TEST_ALL_PREFIXES(WebIDBCursorImplTest, PrefetchReset);
60 FRIEND_TEST_ALL_PREFIXES(WebIDBCursorImplTest, PrefetchTest);
62 enum { kInvalidCursorId = -1 };
63 enum { kPrefetchContinueThreshold = 2 };
64 enum { kMinPrefetchAmount = 5 };
65 enum { kMaxPrefetchAmount = 100 };
67 int32 ipc_cursor_id_;
68 int64 transaction_id_;
70 // Prefetch cache.
71 std::deque<IndexedDBKey> prefetch_keys_;
72 std::deque<IndexedDBKey> prefetch_primary_keys_;
73 std::deque<blink::WebData> prefetch_values_;
74 std::deque<blink::WebVector<blink::WebBlobInfo> > prefetch_blob_info_;
76 // Number of continue calls that would qualify for a pre-fetch.
77 int continue_count_;
79 // Number of items used from the last prefetch.
80 int used_prefetches_;
82 // Number of onsuccess handlers we are waiting for.
83 int pending_onsuccess_callbacks_;
85 // Number of items to request in next prefetch.
86 int prefetch_amount_;
88 scoped_refptr<ThreadSafeSender> thread_safe_sender_;
91 } // namespace content
93 #endif // CONTENT_CHILD_INDEXED_DB_WEBIDBCURSOR_IMPL_H_