WebCore/storage/IDBTransactionBackendInterface.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 IDBTransactionBackendInterface_h
  27 #define IDBTransactionBackendInterface_h
  28
  29 #include "ExceptionCode.h"
  30 #include "IDBCallbacks.h"
  31 #include "PlatformString.h"
  32 #include "ScriptExecutionContext.h"
  33 #include <wtf/Threading.h>
  34
  35 #if ENABLE(INDEXED_DATABASE)
  36
  37 namespace WebCore {
  38
  39 class IDBObjectStoreBackendInterface;
  40 class IDBTransactionCallbacks;
  41 class SQLiteDatabase;
  42
  43 // This class is shared by IDBTransaction (async) and IDBTransactionSync (sync).
  44 // This is implemented by IDBTransactionBackendImpl and optionally others (in order to proxy
  45 // calls across process barriers). All calls to these classes should be non-blocking and
  46 // trigger work on a background thread if necessary.
  47 class IDBTransactionBackendInterface : public ThreadSafeShared<IDBTransactionBackendInterface> {
  48 public:
  49     virtual ~IDBTransactionBackendInterface() { }
  50
  51     virtual PassRefPtr<IDBObjectStoreBackendInterface> objectStore(const String& name) = 0;
  52     virtual unsigned short mode() const = 0;
  53     virtual bool scheduleTask(PassOwnPtr<ScriptExecutionContext::Task> task, PassOwnPtr<ScriptExecutionContext::Task> abortTask = 0) = 0;
  54     virtual void didCompleteTaskEvents() = 0;
  55     virtual void abort() = 0;
  56     virtual void setCallbacks(IDBTransactionCallbacks*) = 0;
  57 };
  58
  59 } // namespace WebCore
  60
  61 #endif
  62
  63 #endif // IDBTransactionBackendInterface_h
  64