blob: e2a8463459249ddb6fa655f2e7f52be0c285c864 [file] [log] [blame]
// Copyright 2014 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 "base/callback.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "components/metrics/net/network_metrics_provider.h"
namespace metrics {
// Scheduler task to drive a MetricsService object's uploading.
// TODO(holte): Remove this once we've switched to split schedulers.
class MetricsReportingScheduler {
// Creates MetricsServiceScheduler object with the given |upload_callback|
// callback to call when uploading should happen and
// |upload_interval_callback| to determine the interval between uploads
// in steady state.
const base::Closure& upload_callback,
const base::Callback<base::TimeDelta(void)>& upload_interval_callback);
virtual ~MetricsReportingScheduler();
// Starts scheduling uploads. This in a no-op if the scheduler is already
// running, so it is safe to call more than once.
void Start();
// Stops scheduling uploads.
void Stop();
// Callback from MetricsService when the startup init task has completed.
void InitTaskComplete();
// Callback from MetricsService when a triggered upload finishes.
void UploadFinished(bool server_is_healthy, bool more_logs_remaining);
// Callback from MetricsService when a triggered upload is cancelled by the
// MetricsService.
void UploadCancelled();
// Sets the upload interval to a specific value, exposed for unit tests.
void SetUploadIntervalForTesting(base::TimeDelta interval);
enum InitSequence {
// Record the init sequence order histogram.
virtual void LogMetricsInitSequence(InitSequence sequence);
// Record the upload interval time.
virtual void LogActualUploadInterval(base::TimeDelta interval);
// Timer callback indicating it's time for the MetricsService to upload
// metrics.
void TriggerUpload();
// Schedules a future call to TriggerUpload if one isn't already pending.
void ScheduleNextUpload();
// Increases the upload interval each time it's called, to handle the case
// where the server is having issues.
void BackOffUploadInterval();
// Returns upload interval to use in steady state.
base::TimeDelta GetStandardUploadInterval();
// The MetricsService method to call when uploading should happen.
const base::Closure upload_callback_;
base::OneShotTimer upload_timer_;
// The interval between being told an upload is done and starting the next
// upload.
base::TimeDelta upload_interval_;
// The tick count of the last time log upload has been finished and null if no
// upload has been done yet.
base::TimeTicks last_upload_finish_time_;
// Indicates that the scheduler is running (i.e., that Start has been called
// more recently than Stop).
bool running_;
// Indicates that the last triggered upload hasn't resolved yet.
bool callback_pending_;
// Whether the InitTaskComplete() callback has been called.
bool init_task_complete_;
// Whether the initial scheduled upload timer has fired before the init task
// has been completed.
bool waiting_for_init_task_complete_;
// Callback function used to get the standard upload time.
base::Callback<base::TimeDelta(void)> upload_interval_callback_;
} // namespace metrics