src/third_party/WebKit/Source/modules/webdatabase/DatabaseContext.h

   1 /*
   2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
   3  * Copyright (C) 2011 Google, Inc. All Rights Reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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 COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  */
  27
  28 #ifndef DatabaseContext_h
  29 #define DatabaseContext_h
  30
  31 #include "core/dom/ActiveDOMObject.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/PassRefPtr.h"
  34 #include "wtf/ThreadSafeRefCounted.h"
  35
  36 namespace blink {
  37
  38 class Database;
  39 class DatabaseContext;
  40 class TaskSynchronizer;
  41 class DatabaseThread;
  42 class ExecutionContext;
  43 class SecurityOrigin;
  44
  45 class DatabaseContext FINAL
  46     : public ThreadSafeRefCountedWillBeGarbageCollectedFinalized<DatabaseContext>
  47     , public ActiveDOMObject {
  48 public:
  49     friend class DatabaseManager;
  50
  51     static PassRefPtrWillBeRawPtr<DatabaseContext> create(ExecutionContext*);
  52
  53     virtual ~DatabaseContext();
  54     void trace(Visitor*);
  55
  56     // For life-cycle management (inherited from ActiveDOMObject):
  57     virtual void contextDestroyed() OVERRIDE;
  58     virtual void stop() OVERRIDE;
  59
  60     DatabaseContext* backend();
  61     DatabaseThread* databaseThread();
  62     bool databaseThreadAvailable();
  63
  64     void setHasOpenDatabases() { m_hasOpenDatabases = true; }
  65     // Blocks the caller thread until cleanup tasks are completed.
  66     void stopDatabases();
  67
  68     bool allowDatabaseAccess() const;
  69
  70     SecurityOrigin* securityOrigin() const;
  71     bool isContextThread() const;
  72
  73 private:
  74     explicit DatabaseContext(ExecutionContext*);
  75
  76     RefPtrWillBeMember<DatabaseThread> m_databaseThread;
  77     bool m_hasOpenDatabases; // This never changes back to false, even after the database thread is closed.
  78     bool m_hasRequestedTermination;
  79 };
  80
  81 } // namespace blink
  82
  83 #endif // DatabaseContext_h