duckdb::Event Class Reference

Inheritance diagram for duckdb::Event:

Collaboration diagram for duckdb::Event:

Public Member Functions
	Event (Executor &executor)
virtual void	Schedule ()=0
virtual void	FinishEvent ()
	Called right after the event is finished.
virtual void	FinalizeFinish ()
	Called after the event is entirely finished.
void	FinishTask ()
void	Finish ()
void	AddDependency (Event &event)
bool	HasDependencies () const
const vector< reference< Event > > &	GetParentsVerification () const
void	CompleteDependency ()
void	SetTasks (vector< shared_ptr< Task > > tasks)
void	InsertEvent (shared_ptr< Event > replacement_event)
bool	IsFinished () const
virtual void	PrintPipeline ()
ClientContext &	GetClientContext ()
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const
Public Member Functions inherited from duckdb::enable_shared_from_this< Event >
shared_ptr< Event >	shared_from_this ()
shared_ptr< Event const >	shared_from_this () const

Protected Attributes
Executor &	executor
atomic< idx_t >	finished_tasks
	The current threads working on the event.
atomic< idx_t >	total_tasks
	The maximum amount of threads that can work on the event.
atomic< idx_t >	finished_dependencies
idx_t	total_dependencies
	The total amount of dependencies.
vector< weak_ptr< Event > >	parents
	The events that depend on this event to run.
vector< reference< Event > >	parents_raw
	Raw pointers to the parents (used for verification only)
atomic< bool >	finished
	Whether or not the event is finished executing.

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

Member Function Documentation

FinishEvent()

virtual void duckdb::Event::FinishEvent ( )

inlinevirtual

Called right after the event is finished.

                               {
    }

FinalizeFinish()

virtual void duckdb::Event::FinalizeFinish ( )

inlinevirtual

Called after the event is entirely finished.

                                  {
    }

HasDependencies()

bool duckdb::Event::HasDependencies ( ) const

inline

                                 {
        return total_dependencies != 0;
    }

IsFinished()

bool duckdb::Event::IsFinished ( ) const

inline

                            {
        return finished;
    }

PrintPipeline()

virtual void duckdb::Event::PrintPipeline ( )

inlinevirtual

                                 {
    }

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::Event::Cast ( )

inline

                   {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<TARGET &>(*this);
    }

Cast() [2/2]

template<class TARGET >

const TARGET & duckdb::Event::Cast ( ) const

inline

                               {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<const TARGET &>(*this);
    }

Member Data Documentation

finished_dependencies

atomic<idx_t> duckdb::Event::finished_dependencies

protected

The amount of completed dependencies The event can only be started after the dependencies have finished executing

---

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

• external/duckdb/duckdb.cpp