gecko-dev/dom/base/PlacesObservers.h
Marco Bonardo 4261669447 Bug 1873629 - Add counters to PlacesObservers. r=daisuke,places-reviewers,farre
Add a new `counts` property to PlacesObservers counting the number of times
a PlacesEvent has been fired. This can be used to statistically evaluate
the user activity, and increase/decrease rate of background recalculations
when large events (migrations) happen, without having to do expensive I/O.

Differential Revision: https://phabricator.services.mozilla.com/D204338
2024-03-20 13:01:52 +00:00

69 lines
2.8 KiB
C++

/* -*- 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_PlacesObservers__
#define mozilla_dom_PlacesObservers__
#include "mozilla/AlreadyAddRefed.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/PlacesObserversBinding.h"
#include "mozilla/dom/PlacesEvent.h"
#include "mozilla/dom/PlacesEventCounts.h"
#include "mozilla/places/INativePlacesEventCallback.h"
#include "nsIWeakReferenceUtils.h"
namespace mozilla {
class ErrorResult;
namespace dom {
class PlacesObservers {
public:
static void AddListener(GlobalObject& aGlobal,
const nsTArray<PlacesEventType>& aEventTypes,
PlacesEventCallback& aCallback, ErrorResult& rv);
static void AddListener(GlobalObject& aGlobal,
const nsTArray<PlacesEventType>& aEventTypes,
PlacesWeakCallbackWrapper& aCallback,
ErrorResult& rv);
static void AddListener(const nsTArray<PlacesEventType>& aEventTypes,
places::INativePlacesEventCallback* aCallback);
static void RemoveListener(GlobalObject& aGlobal,
const nsTArray<PlacesEventType>& aEventTypes,
PlacesEventCallback& aCallback, ErrorResult& rv);
static void RemoveListener(GlobalObject& aGlobal,
const nsTArray<PlacesEventType>& aEventTypes,
PlacesWeakCallbackWrapper& aCallback,
ErrorResult& rv);
static void RemoveListener(const nsTArray<PlacesEventType>& aEventTypes,
places::INativePlacesEventCallback* aCallback);
MOZ_CAN_RUN_SCRIPT
static void NotifyListeners(
GlobalObject& aGlobal,
const Sequence<OwningNonNull<PlacesEvent>>& aEvents, ErrorResult& rv);
MOZ_CAN_RUN_SCRIPT
static void NotifyListeners(
const Sequence<OwningNonNull<PlacesEvent>>& aEvents);
static StaticRefPtr<PlacesEventCounts> sCounts;
static already_AddRefed<PlacesEventCounts> Counts(const GlobalObject& global);
private:
static void RemoveListener(uint32_t aFlags, PlacesEventCallback& aCallback);
static void RemoveListener(uint32_t aFlags,
PlacesWeakCallbackWrapper& aCallback);
static void RemoveListener(uint32_t aFlags,
places::INativePlacesEventCallback* aCallback);
MOZ_CAN_RUN_SCRIPT static void NotifyNext();
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_PlacesObservers__