blob: f736421d9df6d96fd110bd202d7284df6e0867bc [file] [log] [blame]
// found in the LICENSE file.
#include <array>
#include "base/base_export.h"
#include "base/callback.h"
#include "base/containers/queue.h"
#include "base/location.h"
#include "base/optional.h"
#include "base/time/time.h"
namespace base {
enum class Nestable {
// Contains data about a pending task. Stored in TaskQueue and DelayedTaskQueue
// for use by classes that queue and execute tasks.
struct BASE_EXPORT PendingTask {
PendingTask(const Location& posted_from,
OnceClosure task,
TimeTicks delayed_run_time = TimeTicks(),
Nestable nestable = Nestable::kNestable);
PendingTask(PendingTask&& other);
PendingTask& operator=(PendingTask&& other);
// Used to support sorting.
bool operator<(const PendingTask& other) const;
// The task to run.
OnceClosure task;
// The site this PendingTask was posted from.
Location posted_from;
// The time when the task should be run.
base::TimeTicks delayed_run_time;
// The time at which the task was queued. For SequenceManager tasks and
// TaskScheduler non-delayed tasks, this happens at post time. For
// TaskScheduler delayed tasks, this happens some time after the task's delay
// has expired. This is not set for SequenceManager tasks if
// SetAddQueueTimeToTasks(true) wasn't call. This defaults to a null TimeTicks
// if the task hasn't been inserted in a sequence yet.
TimeTicks queue_time;
// Chain of up-to-four symbols of the parent tasks which led to this one being
// posted.
std::array<const void*, 4> task_backtrace = {};
// Secondary sort key for run time.
int sequence_num = 0;
// OK to dispatch from a nested loop.
Nestable nestable;
// Needs high resolution timers.
bool is_high_res = false;
using TaskQueue = base::queue<PendingTask>;
// PendingTasks are sorted by their |delayed_run_time| property.
using DelayedTaskQueue = std::priority_queue<base::PendingTask>;
} // namespace base