blob: 1f35198479a2b7c06c0117e1f2113e50e296041b [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.
#include <memory>
#include <string>
#include "base/macros.h"
#include "net/base/net_export.h"
#include "net/reporting/reporting_context.h"
class GURL;
namespace url {
class Origin;
} // namespace url
namespace net {
// Keeps track of which endpoints are pending (have active delivery attempts to
// them) or in exponential backoff after one or more failures, and chooses an
// endpoint from an endpoint group to receive reports for an origin.
class NET_EXPORT ReportingEndpointManager {
// |context| must outlive the ReportingEndpointManager.
static std::unique_ptr<ReportingEndpointManager> Create(
ReportingContext* context);
virtual ~ReportingEndpointManager();
// Finds an endpoint configured by |origin| in group |group| that is not
// pending, in exponential backoff from failed requests, or expired.
// Deliberately chooses an endpoint randomly to ensure sites aren't relying on
// any sort of fallback ordering.
// Returns true and sets |*endpoint_url_out| to the endpoint URL if an
// endpoint was chosen; returns false (and leaves |*endpoint_url_out| invalid)
// if no endpoint was found.
virtual bool FindEndpointForOriginAndGroup(const url::Origin& origin,
const std::string& group,
GURL* endpoint_url_out) = 0;
// Adds |endpoint| to the set of pending endpoints, preventing it from being
// chosen for a second parallel delivery attempt.
virtual void SetEndpointPending(const GURL& endpoint) = 0;
// Removes |endpoint| from the set of pending endpoints.
virtual void ClearEndpointPending(const GURL& endpoint) = 0;
// Informs the EndpointManager of a successful or unsuccessful request made to
// |endpoint| so it can manage exponential backoff of failing endpoints.
virtual void InformOfEndpointRequest(const GURL& endpoint,
bool succeeded) = 0;
} // namespace net