blob: 55107bc6c47439a8a389bd9883420e91e15507b7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/* -*- 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_localstorage_LSObserver_h
#define mozilla_dom_localstorage_LSObserver_h
#include "mozilla/Assertions.h"
#include "nsISupports.h"
#include "nsString.h"
namespace mozilla::dom {
class LSObserverChild;
/**
* Effectively just a refcounted life-cycle management wrapper around
* LSObserverChild which exists to receive "storage" event information from
* other processes. (Same-process events are handled within the process, see
* `LSObject::OnChange`.)
*
* ## Lifecycle ##
* - Created by LSObject::EnsureObserver via synchronous LSRequest idiom
* whenever the first window's origin adds a "storage" event. Placed in the
* gLSObservers LSObserverHashtable for subsequent LSObject's via
* LSObserver::Get lookup.
* - The LSObserverChild directly handles "Observe" messages, shunting them
* directly to Storage::NotifyChange which does all the legwork of notifying
* windows about "storage" events.
* - Destroyed when refcount goes to zero due to all owning LSObjects being
* destroyed or having their `LSObject::DropObserver` methods invoked due to
* the last "storage" event listener being removed from the owning window.
*/
class LSObserver final {
friend class LSObject;
LSObserverChild* mActor;
const nsCString mOrigin;
public:
static LSObserver* Get(const nsACString& aOrigin);
NS_INLINE_DECL_REFCOUNTING(LSObserver)
void AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(LSObserver); }
void SetActor(LSObserverChild* aActor);
void ClearActor() {
AssertIsOnOwningThread();
MOZ_ASSERT(mActor);
mActor = nullptr;
}
private:
// Only created by LSObject.
explicit LSObserver(const nsACString& aOrigin);
~LSObserver();
};
} // namespace mozilla::dom
#endif // mozilla_dom_localstorage_LSObserver_h
|
