20#ifndef KICAD_API_TASK_SCHEDULER_H
21#define KICAD_API_TASK_SCHEDULER_H
41class TaskStatusResponse;
50 virtual void Run() = 0;
53 virtual void FillStatus( kiapi::common::tasks::TaskStatusResponse& aStatus )
const = 0;
77 std::optional<std::string>
StartTask(
const std::shared_ptr<API_TASK>& aTask,
const wxString& aDescription );
83 std::optional<kiapi::common::tasks::TaskStatusResponse>
GetStatus(
const std::string& aToken )
const;
89 std::shared_ptr<API_TASK>
GetFinishedTask(
const std::string& aToken )
const;
105 std::shared_ptr<API_TASK>
task;
114 void runTask(
const std::string& aToken );
117 std::map<std::string, std::shared_ptr<TASK_ENTRY>>
m_tasks;
std::shared_ptr< API_TASK > GetFinishedTask(const std::string &aToken) const
Look up a task that has finished, for result retrieval.
std::optional< kiapi::common::tasks::TaskStatusResponse > GetStatus(const std::string &aToken) const
Get a snapshot of the task's current status.
API_TASK_SCHEDULER & operator=(const API_TASK_SCHEDULER &)=delete
bool AnyTaskRunning() const
std::deque< std::string > m_finishedTokens
void onTaskRunEvent(wxCommandEvent &aEvent)
void Pump()
Run the current task to completion, synchronously.
void runTask(const std::string &aToken)
static API_TASK_SCHEDULER & Instance()
API_TASK_SCHEDULER(const API_TASK_SCHEDULER &)=delete
static constexpr size_t MAX_FINISHED_TASKS
std::map< std::string, std::shared_ptr< TASK_ENTRY > > m_tasks
std::optional< std::string > StartTask(const std::shared_ptr< API_TASK > &aTask, const wxString &aDescription)
Register a new task and begin running it.
virtual ~API_TASK()=default
virtual void Run()=0
The task runner; called on the main thread.
virtual void FillStatus(kiapi::common::tasks::TaskStatusResponse &aStatus) const =0
Called after Run() returns; should fill in the result of the run.
std::string failureMessage
std::shared_ptr< API_TASK > task