xref: /aosp_15_r20/external/cronet/base/task/task_observer.h (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2018 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker 
5*6777b538SAndroid Build Coastguard Worker #ifndef BASE_TASK_TASK_OBSERVER_H_
6*6777b538SAndroid Build Coastguard Worker #define BASE_TASK_TASK_OBSERVER_H_
7*6777b538SAndroid Build Coastguard Worker 
8*6777b538SAndroid Build Coastguard Worker #include "base/base_export.h"
9*6777b538SAndroid Build Coastguard Worker #include "base/pending_task.h"
10*6777b538SAndroid Build Coastguard Worker 
11*6777b538SAndroid Build Coastguard Worker namespace base {
12*6777b538SAndroid Build Coastguard Worker 
13*6777b538SAndroid Build Coastguard Worker // A TaskObserver is an object that receives notifications about tasks being
14*6777b538SAndroid Build Coastguard Worker // processed on the thread it's associated with.
15*6777b538SAndroid Build Coastguard Worker //
16*6777b538SAndroid Build Coastguard Worker // NOTE: A TaskObserver implementation should be extremely fast!
17*6777b538SAndroid Build Coastguard Worker 
18*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT TaskObserver {
19*6777b538SAndroid Build Coastguard Worker  public:
20*6777b538SAndroid Build Coastguard Worker   // This method is called before processing a task.
21*6777b538SAndroid Build Coastguard Worker   // |was_blocked_or_low_priority| indicates if the task was at some point in a
22*6777b538SAndroid Build Coastguard Worker   // queue that was blocked or less important than "normal".
23*6777b538SAndroid Build Coastguard Worker   virtual void WillProcessTask(const PendingTask& pending_task,
24*6777b538SAndroid Build Coastguard Worker                                bool was_blocked_or_low_priority) = 0;
25*6777b538SAndroid Build Coastguard Worker 
26*6777b538SAndroid Build Coastguard Worker   // This method is called after processing a task.
27*6777b538SAndroid Build Coastguard Worker   virtual void DidProcessTask(const PendingTask& pending_task) = 0;
28*6777b538SAndroid Build Coastguard Worker 
29*6777b538SAndroid Build Coastguard Worker  protected:
30*6777b538SAndroid Build Coastguard Worker   virtual ~TaskObserver() = default;
31*6777b538SAndroid Build Coastguard Worker };
32*6777b538SAndroid Build Coastguard Worker 
33*6777b538SAndroid Build Coastguard Worker }  // namespace base
34*6777b538SAndroid Build Coastguard Worker 
35*6777b538SAndroid Build Coastguard Worker #endif  // BASE_TASK_TASK_OBSERVER_H_
36