duckdb::Task Class Reference

Generic parallel task. More...

#include <duckdb.hpp>

Inheritance diagram for duckdb::Task:

Collaboration diagram for duckdb::Task:

Public Member Functions
virtual TaskExecutionResult	Execute (TaskExecutionMode mode)=0
virtual void	Deschedule ()
virtual void	Reschedule ()
	Ensures a task is rescheduled to the correct queue.
virtual bool	TaskBlockedOnResult () const
virtual string	TaskType () const
Public Member Functions inherited from duckdb::enable_shared_from_this< Task >
shared_ptr< Task >	shared_from_this ()
shared_ptr< Task const >	shared_from_this () const

Public Attributes
optional_ptr< ProducerToken >	token

Additional Inherited Members
Protected Member Functions inherited from duckdb::enable_shared_from_this< Task >
	enable_shared_from_this (enable_shared_from_this const &) noexcept
enable_shared_from_this &	operator= (enable_shared_from_this const &) noexcept

Detailed Description

Generic parallel task.

Constructor & Destructor Documentation

~Task()

virtual duckdb::Task::~Task ( )

inlinevirtual

                    {
    }

Member Function Documentation

Execute()

virtual TaskExecutionResult duckdb::Task::Execute ( TaskExecutionMode  mode )

pure virtual

Execute the task in the specified execution mode If mode is PROCESS_ALL, Execute should always finish processing and return TASK_FINISHED If mode is PROCESS_PARTIAL, Execute can return TASK_NOT_FINISHED, in which case Execute will be called again In case of an error, TASK_ERROR is returned In case the task has interrupted, BLOCKED is returned.

Implemented in duckdb::ExecutorTask.

Deschedule()

virtual void duckdb::Task::Deschedule ( )

inlinevirtual

Descheduling a task ensures the task is not executed, but remains available for rescheduling as long as required, generally until some code in an operator calls the InterruptState::Callback() method of a state of the InterruptMode::TASK mode.

Reimplemented in duckdb::ExecutorTask.

                              {
        throw InternalException("Cannot deschedule task of base Task class");
    };

Reschedule()

virtual void duckdb::Task::Reschedule ( )

inlinevirtual

Ensures a task is rescheduled to the correct queue.

Reimplemented in duckdb::ExecutorTask.

                              {
        throw InternalException("Cannot reschedule task of base Task class");
    }

TaskBlockedOnResult()

virtual bool duckdb::Task::TaskBlockedOnResult ( ) const

inlinevirtual

                                             {
        return false;
    }

TaskType()

virtual string duckdb::Task::TaskType ( ) const

inlinevirtual

                                    {
        return "UnnamedTask";
    }

---

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

• external/duckdb/duckdb.hpp