Class endstone::Task

ClassList > endstone > Task

Represents a task being executed by the scheduler.

• #include <endstone/scheduler/task.h>

Public Functions

Type	Name
virtual void	cancel () = 0
virtual Plugin *	getOwner () const = 0
virtual TaskId	getTaskId () const = 0
virtual bool	isCancelled () const = 0
virtual bool	isSync () const = 0
virtual	~Task () = default

Public Functions Documentation

function cancel

virtual void endstone::Task::cancel () = 0

Attempts to cancel this task.

---

function getOwner

virtual Plugin * endstone::Task::getOwner () const = 0

Returns the Plugin that owns this task.

Returns:

The Plugin that owns the task

---

function getTaskId

virtual TaskId endstone::Task::getTaskId () const = 0

Returns the taskId for the task.

Returns:

Task id number

---

function isCancelled

virtual bool endstone::Task::isCancelled () const = 0

Returns true if this task has been cancelled.

Returns:

true if the task has been cancelled

---

function isSync

virtual bool endstone::Task::isSync () const = 0

Returns true if the Task is a sync task.

Returns:

true if the task is run by server thread

---

function ~Task

virtual endstone::Task::~Task () = default

---

---

The documentation for this class was generated from the following file include/endstone/scheduler/task.h