pw::async2::OwnedTask Class Reference

Overview

A Task that the Dispatcher takes ownership of when it is posted.

OwnedTask adds a virtual DoDestroy() function. This function is called by the dispatcher after the task completes. DoDestroy() must destroy the task and deallocate its memory.

After it is posted to a dispatcher, an OwnedTask may only be accessed from the dispatcher via the Task::DoPend() implementation.

Inheritance diagram for pw::async2::OwnedTask:

Protected Member Functions
constexpr	OwnedTask (log::Token name=kDefaultName)
Protected Member Functions inherited from pw::containers::future::IntrusiveList< T >::Item
constexpr	Item ()=default

Private Member Functions
virtual void	DoDestroy ()=0

Additional Inherited Members
Public Member Functions inherited from pw::async2::Task
constexpr	Task (log::Token name=kDefaultName)
	Task (const Task &)=delete
	Task (Task &&)=delete
Task &	operator= (const Task &)=delete
Task &	operator= (Task &&)=delete
virtual	~Task ()
Poll	Pend (Context &cx)
bool	IsRegistered () const
void	Deregister ()
void	Join ()

Member Function Documentation

DoDestroy()

virtual void pw::async2::OwnedTask::DoDestroy ( )

privatepure virtual

The DoDestroy implementation must destroy this task and free its memory.

DoDestroy is normally invoked by a Dispatcher after a Posted OwnedTask completes.

This function is currently private, but potentially could be used by a Tasks delegating to other OwnedTasks.

Implemented in pw::async2::internal::AllocatedTask< Pendable >, and pw::async2::internal::RunHeapFuncTask< Func >.

---

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

• pw_async2/public/pw_async2/owned_task.h