dom/storage/SessionStorageObserver.h
author Jan de Mooij <jdemooij@mozilla.com>
Wed, 13 Feb 2019 06:41:44 +0000
changeset 516733 8c306186cbd7672259b3a730471cfcbe44a9b0d0
parent 515429 04eecadabb485bd398c6c37e258ba47b946e7982
permissions -rw-r--r--
Bug 1526588 - Fix some issues with js::GetFirstGlobalInCompartment and XPCWrappedNativeScope::UpdateWeakPointersInAllScopesAfterGC. r=bzbarsky Differential Revision: https://phabricator.services.mozilla.com/D19493

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_SessionStorageObserver_h
#define mozilla_dom_SessionStorageObserver_h

namespace mozilla {
namespace dom {

class SessionStorageObserverChild;

/**
 * Effectively just a refcounted life-cycle management wrapper around
 * SessionStorageObserverChild which exists to receive chrome observer
 * notifications from the main process.
 *
 * ## Lifecycle ##
 * - Created by SessionStorageManager::SessionStorageManager.  Placed in the
 *   gSessionStorageObserver variable for subsequent SessionStorageManager's via
 *   SessionStorageObserver::Get lookup.
 * - The SessionStorageObserverChild directly handles "Observe" messages,
 *   shunting them directly to StorageObserver::Notify which distributes them to
 *   individual observer sinks.
 * - Destroyed when refcount goes to zero due to all owning
 *   SessionStorageManager being destroyed.
 */
class SessionStorageObserver final {
  friend class SessionStorageManager;

  SessionStorageObserverChild* mActor;

 public:
  static SessionStorageObserver* Get();

  NS_INLINE_DECL_REFCOUNTING(SessionStorageObserver)

  void AssertIsOnOwningThread() const {
    NS_ASSERT_OWNINGTHREAD(SessionStorageObserver);
  }

  void SetActor(SessionStorageObserverChild* aActor);

  void ClearActor() {
    AssertIsOnOwningThread();
    MOZ_ASSERT(mActor);

    mActor = nullptr;
  }

 private:
  // Only created by SessionStorageManager.
  SessionStorageObserver();

  ~SessionStorageObserver();
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_SessionStorageObserver_h