Home | History | Annotate | Download | only in storage 
      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 IDBDatabaseBackendInterface_h
     27 #define IDBDatabaseBackendInterface_h
     28 
     29 #include "ExceptionCode.h"
     30 #include "PlatformString.h"
     31 #include <wtf/PassRefPtr.h>
     32 #include <wtf/Threading.h>
     33 
     34 #if ENABLE(INDEXED_DATABASE)
     35 
     36 namespace WebCore {
     37 
     38 class DOMStringList;
     39 class Frame;
     40 class IDBCallbacks;
     41 class IDBDatabaseCallbacks;
     42 class IDBObjectStoreBackendInterface;
     43 class IDBTransactionBackendInterface;
     44 
     45 // This class is shared by IDBDatabase (async) and IDBDatabaseSync (sync).
     46 // This is implemented by IDBDatabaseBackendImpl and optionally others (in order to proxy
     47 // calls across process barriers). All calls to these classes should be non-blocking and
     48 // trigger work on a background thread if necessary.
     49 class IDBDatabaseBackendInterface : public ThreadSafeRefCounted<IDBDatabaseBackendInterface> {
     50 public:
     51     virtual ~IDBDatabaseBackendInterface() { }
     52 
     53     virtual String name() const = 0;
     54     virtual String version() const = 0;
     55     virtual PassRefPtr<DOMStringList> objectStoreNames() const = 0;
     56 
     57     virtual PassRefPtr<IDBObjectStoreBackendInterface> createObjectStore(const String& name, const String& keyPath, bool autoIncrement, IDBTransactionBackendInterface*, ExceptionCode&) = 0;
     58     virtual void deleteObjectStore(const String& name, IDBTransactionBackendInterface*, ExceptionCode&) = 0;
     59     virtual void setVersion(const String& version, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBDatabaseCallbacks>, ExceptionCode&) = 0;
     60     virtual PassRefPtr<IDBTransactionBackendInterface> transaction(DOMStringList* storeNames, unsigned short mode, ExceptionCode&) = 0;
     61     virtual void close(PassRefPtr<IDBDatabaseCallbacks>) = 0;
     62 
     63     virtual void open(PassRefPtr<IDBDatabaseCallbacks>) = 0;
     64 };
     65 
     66 } // namespace WebCore
     67 
     68 #endif
     69 
     70 #endif // IDBDatabaseBackendInterface_h
     71