blob: 8d61c11fa753fdb1b8085e23f0dbdd76b982d6d0 [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_RESOURCE_COORDINATOR_PAGE_SIGNAL_RECEIVER_H_
#define CHROME_BROWSER_RESOURCE_COORDINATOR_PAGE_SIGNAL_RECEIVER_H_
#include "base/macros.h"
#include "base/observer_list.h"
#include "mojo/public/cpp/bindings/binding.h"
#include "services/resource_coordinator/public/interfaces/page_signal.mojom.h"
namespace content {
class WebContents;
}
namespace resource_coordinator {
// A PageSignalObserver is implemented to receive notifications from
// PageSignalReceiver by adding itself to PageSignalReceiver.
class PageSignalObserver {
public:
virtual ~PageSignalObserver() = default;
// PageSignalReceiver will deliver signals with a |web_contents| even it's not
// managed by the client. Thus the clients are responsible for checking the
// passed |web_contents| by themselves.
virtual void OnPageAlmostIdle(content::WebContents* web_contents) {}
virtual void OnExpectedTaskQueueingDurationSet(
content::WebContents* web_contents,
base::TimeDelta duration) {}
};
// Implementation of resource_coordinator::mojom::PageSignalReceiver.
// PageSignalReceiver constructs a mojo channel to PageSignalGenerator in
// resource coordinator, passes an interface pointer to PageSignalGenerator,
// receives page scoped signals from PageSignalGenerator, and dispatches them
// with WebContents to PageSignalObservers.
// The mojo channel won't be constructed until PageSignalReceiver has the first
// observer.
class PageSignalReceiver : public mojom::PageSignalReceiver {
public:
PageSignalReceiver();
~PageSignalReceiver() override;
static bool IsEnabled();
// Callers do not take ownership.
static PageSignalReceiver* GetInstance();
// mojom::PageSignalReceiver implementation.
void NotifyPageAlmostIdle(const CoordinationUnitID& cu_id) override;
void SetExpectedTaskQueueingDuration(const CoordinationUnitID& cu_id,
base::TimeDelta duration) override;
void AddObserver(PageSignalObserver* observer);
void RemoveObserver(PageSignalObserver* observer);
void AssociateCoordinationUnitIDWithWebContents(
const CoordinationUnitID& cu_id,
content::WebContents* web_contents);
void RemoveCoordinationUnitID(const CoordinationUnitID& cu_id);
private:
mojo::Binding<mojom::PageSignalReceiver> binding_;
std::map<CoordinationUnitID, content::WebContents*> cu_id_web_contents_map_;
base::ObserverList<PageSignalObserver> observers_;
DISALLOW_COPY_AND_ASSIGN(PageSignalReceiver);
};
} // namespace resource_coordinator
#endif // CHROME_BROWSER_RESOURCE_COORDINATOR_PAGE_SIGNAL_RECEIVER_H_