uni20::async::BasicTask Class Reference

Move-only promise-neutral ownership claim for a Uni20 coroutine. More...

#include <async_task.hpp>

Inheritance diagram for uni20::async::BasicTask:

Classes
struct	construction_key

Public Member Functions
void	abandon_leak ()
	Intentionally leak the coroutine during emergency unwinding.
bool	await_ready () const noexcept
void	await_resume ()
template<TaskPromise ParentPromise>
std::coroutine_handle	await_suspend (std::coroutine_handle< ParentPromise > parent)
	Await a nested task from any Uni20 task promise type.
	BasicTask () noexcept=default
	Construct an empty task.
	BasicTask (BasicTask &&other) noexcept
	Move-construct one ownership claim.
	BasicTask (BasicTask const &)=delete
std::coroutine_handle	coroutine_handle () const noexcept
	Return the generic coroutine handle for diagnostics.
BasicTask &	debug_name (std::string const &label)
	Assign an optional debug label.
void	destroy () noexcept
	Destroy an exclusively owned coroutine.
void	exception_on_resume (std::exception_ptr error) noexcept
	Store an exception for delivery on the next resume.
TaskHandle	handle () const noexcept
	Return the erased task identity.
	operator bool () const noexcept
BasicTask &	operator= (BasicTask &&other) noexcept
	Move-assign one ownership claim.
BasicTask &	operator= (BasicTask const &)=delete
std::optional< int >	preferred_numa_node () const noexcept
TaskHandle	release_handle ()
	Release this ownership claim to a scheduler activation.
void	resume ()
	Resume the coroutine and transfer this ownership claim.
void	set_cancel_on_resume () noexcept
	Request cancellation before the next resume.
void	set_preferred_numa_node (std::optional< int > node) noexcept
bool	set_scheduler (IScheduler *scheduler)
	Install the scheduler used for later resumption.
	~BasicTask () noexcept
	Release the ownership claim and destroy the frame when appropriate.

Static Public Member Functions
static BasicTask	make_sole_owner (BasicTask &&task)
	Retain a task only when it is the sole ownership claimant.
static void	reschedule (BasicTask task)
	Reschedule a task when it becomes the sole ownership claimant.

Protected Member Functions
	BasicTask (TaskHandle handle, construction_key) noexcept

Friends
struct	AsyncTaskTestAccess
class	TaskFactory
class	TaskPromiseBase

Detailed Description

Move-only promise-neutral ownership claim for a Uni20 coroutine.

BasicTask is the internal task currency used by awaiters, continuations, and schedulers after typed initial admission.

Constructor & Destructor Documentation

BasicTask() [1/4]

uni20::async::BasicTask::BasicTask ( )

defaultnoexcept

Construct an empty task.

BasicTask() [2/4]

uni20::async::BasicTask::BasicTask ( BasicTask const &  )

delete

BasicTask() [3/4]

uni20::async::BasicTask::BasicTask ( BasicTask &&  other )

inlinenoexcept

Move-construct one ownership claim.

~BasicTask()

uni20::async::BasicTask::~BasicTask ( )

inlinenoexcept

Release the ownership claim and destroy the frame when appropriate.

BasicTask() [4/4]

uni20::async::BasicTask::BasicTask ( TaskHandle  handle, construction_key    )

inlineexplicitprotectednoexcept

Member Function Documentation

abandon_leak()

void uni20::async::BasicTask::abandon_leak ( )

inline

Intentionally leak the coroutine during emergency unwinding.

await_ready()

bool uni20::async::BasicTask::await_ready ( ) const

inlinenoexcept

await_resume()

void uni20::async::BasicTask::await_resume ( )

inline

await_suspend()

template<TaskPromise ParentPromise>

std::coroutine_handle uni20::async::BasicTask::await_suspend

(

std::coroutine_handle< ParentPromise >

parent

)

Await a nested task from any Uni20 task promise type.

coroutine_handle()

std::coroutine_handle uni20::async::BasicTask::coroutine_handle ( ) const

inlinenoexcept

Return the generic coroutine handle for diagnostics.

debug_name()

BasicTask & uni20::async::BasicTask::debug_name ( std::string const &  label )

inline

Assign an optional debug label.

destroy()

void uni20::async::BasicTask::destroy ( )

inlinenoexcept

Destroy an exclusively owned coroutine.

exception_on_resume()

void uni20::async::BasicTask::exception_on_resume ( std::exception_ptr  error )

inlinenoexcept

Store an exception for delivery on the next resume.

handle()

TaskHandle uni20::async::BasicTask::handle ( ) const

inlinenoexcept

Return the erased task identity.

make_sole_owner()

BasicTask uni20::async::BasicTask::make_sole_owner ( BasicTask &&  task )

inlinestatic

Retain a task only when it is the sole ownership claimant.

operator bool()

uni20::async::BasicTask::operator bool ( ) const

inlineexplicitnoexcept

operator=() [1/2]

BasicTask & uni20::async::BasicTask::operator= ( BasicTask &&  other )

inlinenoexcept

Move-assign one ownership claim.

operator=() [2/2]

BasicTask & uni20::async::BasicTask::operator= ( BasicTask const &  )

delete

preferred_numa_node()

std::optional< int > uni20::async::BasicTask::preferred_numa_node ( ) const

inlinenoexcept

release_handle()

TaskHandle uni20::async::BasicTask::release_handle ( )

inline

Release this ownership claim to a scheduler activation.

reschedule()

void uni20::async::BasicTask::reschedule ( BasicTask  task )

inlinestatic

Reschedule a task when it becomes the sole ownership claimant.

resume()

void uni20::async::BasicTask::resume ( )

inline

Resume the coroutine and transfer this ownership claim.

set_cancel_on_resume()

void uni20::async::BasicTask::set_cancel_on_resume ( )

inlinenoexcept

Request cancellation before the next resume.

set_preferred_numa_node()

void uni20::async::BasicTask::set_preferred_numa_node ( std::optional< int >  node )

inlinenoexcept

set_scheduler()

bool uni20::async::BasicTask::set_scheduler ( IScheduler *  scheduler )

inline

Install the scheduler used for later resumption.

Friends And Related Symbol Documentation

AsyncTaskTestAccess

friend struct AsyncTaskTestAccess

friend

TaskFactory

friend class TaskFactory

friend

TaskPromiseBase

friend class TaskPromiseBase

friend

---

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

• async_task.hpp
• async_task_impl.hpp