src/third_party/WebKit/Source/modules/indexeddb/IDBPendingTransactionMonitor.h

   1 /*
   2  * Copyright (C) 2010 Google 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef IDBPendingTransactionMonitor_h
  27 #define IDBPendingTransactionMonitor_h
  28
  29 #include "platform/heap/Handle.h"
  30 #include "wtf/Noncopyable.h"
  31
  32 namespace blink {
  33
  34 class IDBCursor;
  35 class IDBDisposerDispatcher;
  36 class IDBRequest;
  37 class IDBTransaction;
  38
  39 // This class keeps track of the transactions created during the current
  40 // Javascript execution context. Transactions have an internal |active| flag
  41 // which is set to true on creation, but must be set to false when control
  42 // returns to the event loop.
  43 // Also, this class is responsible to call IDBRequest::dispose() before an
  44 // IDBRequest object dies, and responsible to call IDBCursor::dispose() before
  45 // an IDBCursor object dies.
  46 // FIXME: Rename the class name.
  47 class IDBPendingTransactionMonitor {
  48     WTF_MAKE_NONCOPYABLE(IDBPendingTransactionMonitor);
  49
  50 public:
  51     IDBPendingTransactionMonitor();
  52     ~IDBPendingTransactionMonitor();
  53
  54     void addNewTransaction(IDBTransaction&);
  55     void deactivateNewTransactions();
  56     void registerRequest(IDBRequest&);
  57     // It's ok to call unregisterRequest(*this) inside
  58     // IDBRequest::dispose(). But we must not call unregisterRequest() with
  59     // an object different from |this| of IDBRequest::dispose().
  60     void unregisterRequest(IDBRequest&);
  61     void registerCursor(IDBCursor&);
  62     // It's ok to call unregisterCursor(*this) inside IDBCursor::dispose(). But
  63     // we must not call unregisterCursor() with an object different from |this|
  64     // of IDBCursor::dispose().
  65     void unregisterCursor(IDBCursor&);
  66
  67 private:
  68     PersistentHeapVector<Member<IDBTransaction> > m_transactions;
  69     RefPtr<IDBDisposerDispatcher> m_dispatcher;
  70 };
  71
  72 } // namespace blink
  73
  74 #endif // IDBPendingTransactionMonitor_h