fml::TaskSource Class Reference

#include <task_source.h>

Classes
struct	TopTask

Public Member Functions
	TaskSource (TaskQueueId task_queue_id)
	Construts a TaskSource with the given task_queue_id.
	~TaskSource ()
void	ShutDown ()
	Drops the pending tasks from both primary and secondary task heaps.
void	RegisterTask (const DelayedTask &task)
void	PopTask (TaskSourceGrade grade)
	Pops the task heap corresponding to the TaskSourceGrade.
size_t	GetNumPendingTasks () const
bool	IsEmpty () const
	Returns true if GetNumPendingTasks is zero.
TopTask	Top () const
void	PauseSecondary ()
	Pause providing tasks from secondary task heap.
void	ResumeSecondary ()
	Resume providing tasks from secondary task heap.

Detailed Description

A Source of tasks for the MessageLoopTaskQueues task dispatcher. This is a wrapper around a primary and secondary task heap with the difference between them being that the secondary task heap can be paused and resumed by the task dispatcher. TaskSourceGrade determines what task heap the task is assigned to.

Registering Tasks

The task dispatcher associates a task source with each TaskQueueID. When the user of the task dispatcher registers a task, the task is in-turn registered with the TaskSource corresponding to the TaskQueueID.

Processing Tasks

Task dispatcher provides the event loop a way to acquire tasks to run via GetNextTaskToRun. Task dispatcher asks the underlying TaskSource for the next task.

Definition at line 35 of file task_source.h.

Constructor & Destructor Documentation

TaskSource()

fml::TaskSource::TaskSource ( TaskQueueId  task_queue_id )

explicit

Construts a TaskSource with the given task_queue_id.

Definition at line 11 of file task_source.cc.

    : task_queue_id_(task_queue_id) {}

~TaskSource()

fml::TaskSource::~TaskSource

(

)

Definition at line 14 of file task_source.cc.

                        {
  ShutDown();
}

Member Function Documentation

GetNumPendingTasks()

size_t fml::TaskSource::GetNumPendingTasks

(

)

const

Returns the number of pending tasks. Excludes the tasks from the secondary heap if it's paused.

Definition at line 51 of file task_source.cc.

                                            {
  size_t size = primary_task_queue_.size();
  if (secondary_pause_requests_ == 0) {
    size += secondary_task_queue_.size();
  }
  return size;
}

IsEmpty()

bool fml::TaskSource::IsEmpty

(

)

const

Returns true if GetNumPendingTasks is zero.

Definition at line 59 of file task_source.cc.

                               {
  return GetNumPendingTasks() == 0;
}

PauseSecondary()

void fml::TaskSource::PauseSecondary

(

)

Pause providing tasks from secondary task heap.

Definition at line 94 of file task_source.cc.

                                {
  secondary_pause_requests_++;
}

PopTask()

void fml::TaskSource::PopTask

(

TaskSourceGrade

grade

)

Pops the task heap corresponding to the TaskSourceGrade.

Definition at line 37 of file task_source.cc.

                                              {
  switch (grade) {
    case TaskSourceGrade::kUserInteraction:
      primary_task_queue_.pop();
      break;
    case TaskSourceGrade::kUnspecified:
      primary_task_queue_.pop();
      break;
    case TaskSourceGrade::kDartEventLoop:
      secondary_task_queue_.pop();
      break;
  }
}

RegisterTask()

void fml::TaskSource::RegisterTask

(

const DelayedTask &

task

)

Adds a task to the corresponding task heap as dictated by the TaskSourceGrade of the DelayedTask.

Definition at line 23 of file task_source.cc.

                                                     {
  switch (task.GetTaskSourceGrade()) {
    case TaskSourceGrade::kUserInteraction:
      primary_task_queue_.push(task);
      break;
    case TaskSourceGrade::kUnspecified:
      primary_task_queue_.push(task);
      break;
    case TaskSourceGrade::kDartEventLoop:
      secondary_task_queue_.push(task);
      break;
  }
}

ResumeSecondary()

void fml::TaskSource::ResumeSecondary

(

)

Resume providing tasks from secondary task heap.

Definition at line 98 of file task_source.cc.

                                 {
  secondary_pause_requests_--;
  FML_DCHECK(secondary_pause_requests_ >= 0);
}

ShutDown()

void fml::TaskSource::ShutDown

(

)

Drops the pending tasks from both primary and secondary task heaps.

Definition at line 18 of file task_source.cc.

                          {
  primary_task_queue_ = {};
  secondary_task_queue_ = {};
}

Top()

TaskSource::TopTask fml::TaskSource::Top

(

)

const

Returns the top task based on scheduled time, taking into account whether the secondary heap has been paused or not.

Definition at line 63 of file task_source.cc.

                                        {
  FML_CHECK(!IsEmpty());
  if (secondary_pause_requests_ > 0 || secondary_task_queue_.empty()) {
    const auto& primary_top = primary_task_queue_.top();
    return {
        .task_queue_id = task_queue_id_,
        .task = primary_top,
    };
  } else if (primary_task_queue_.empty()) {
    const auto& secondary_top = secondary_task_queue_.top();
    return {
        .task_queue_id = task_queue_id_,
        .task = secondary_top,
    };
  } else {
    const auto& primary_top = primary_task_queue_.top();
    const auto& secondary_top = secondary_task_queue_.top();
    if (primary_top > secondary_top) {
      return {
          .task_queue_id = task_queue_id_,
          .task = secondary_top,
      };
    } else {
      return {
          .task_queue_id = task_queue_id_,
          .task = primary_top,
      };
    }
  }
}

---

The documentation for this class was generated from the following files:

• fml/task_source.h
• fml/task_source.cc