File: calendar_event_fetch.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (110 lines) | stat: -rw-r--r-- 4,084 bytes parent folder | download | duplicates (6)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ASH_SYSTEM_TIME_CALENDAR_EVENT_FETCH_H_
#define ASH_SYSTEM_TIME_CALENDAR_EVENT_FETCH_H_

#include "ash/ash_export.h"
#include "ash/system/time/calendar_event_fetch_types.h"
#include "base/functional/callback.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "google_apis/calendar/calendar_api_response_types.h"
#include "google_apis/common/api_error_codes.h"

namespace base {

class TickClock;

}  // namespace base

namespace ash {
// Represents a single fetch of a given month's calendar events. Fetch begins
// immediately on construction.
class ASH_EXPORT CalendarEventFetch {
 public:
  // A callback invoked when a fetch of calendar events is complete.
  using FetchCompleteCallback =
      base::OnceCallback<void(base::Time start_of_month,
                              std::string calendar_id,
                              google_apis::ApiErrorCode error,
                              const google_apis::calendar::EventList* events)>;

  // A callback invoked when a fetch of calendar events did not complete, due
  // to an internal error.
  using FetchInternalErrorCallback =
      base::OnceCallback<void(base::Time start_of_month,
                              std::string calendar_id,
                              CalendarEventFetchInternalErrorCode error)>;

  CalendarEventFetch(const base::Time& start_of_month,
                     FetchCompleteCallback complete_callback,
                     FetchInternalErrorCallback internal_error_callback,
                     const base::TickClock* tick_clock);
  CalendarEventFetch(const base::Time& start_of_month,
                     FetchCompleteCallback complete_callback,
                     FetchInternalErrorCallback internal_error_callback,
                     const base::TickClock* tick_clock,
                     const std::string& calendar_id,
                     const std::string& calendar_color_id);
  CalendarEventFetch(const CalendarEventFetch& other) = delete;
  CalendarEventFetch& operator=(const CalendarEventFetch& other) = delete;
  ~CalendarEventFetch();

  // Cancels the fetch request, invokes `cancel_closure_`.
  void Cancel();

 private:
  // Sends the request for an event list from the user's primary calendar.
  // Cancels any in-progress fetch request.
  void SendFetchRequest();

  // Sends the request for an event list given a calendar ID.
  // Cancels any in-progress fetch request.
  // Events on the event list without a color ID will take on the value of
  // `calendar_color_id_`.
  void SendFetchRequestByCalendarId();

  // Callback invoked when results of a fetch are available.
  void OnResultReceived(
      google_apis::ApiErrorCode error,
      std::unique_ptr<google_apis::calendar::EventList> events);

  // Callback invoked when we've gone too long without receiving a response.
  void OnTimeout();

  // Start of the month whose events we're fetching.
  const base::Time start_of_month_;

  // Fetch start/end times.
  const std::pair<base::Time, base::Time> time_range_;

  // Callback invoked when the fetch is complete.
  FetchCompleteCallback complete_callback_;

  // Callback invoked when the fetch failed with an internal error.
  FetchInternalErrorCallback internal_error_callback_;

  // Timestamp of the start of the fetch, used for duration metrics.
  const base::TimeTicks fetch_start_time_;

  // Timer we run at the start of a fetch, to ensure that we terminate if we
  // go too long without a response.
  base::OneShotTimer timeout_;

  // The ID of the calendar we want to fetch events from.
  const std::string calendar_id_;

  // The color ID of the calendar we want to fetch events from.
  const std::string calendar_color_id_;

  // Closure to be invoked if the request needs to be canceled.
  base::OnceClosure cancel_closure_;

  base::WeakPtrFactory<CalendarEventFetch> weak_factory_{this};
};

}  // namespace ash

#endif  // ASH_SYSTEM_TIME_CALENDAR_EVENT_FETCH_H_