dpp::task Class Reference

A coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for parallel coroutines returning a value. More...

Public Member Functions
	task ()=default
	Default constructor, creates a task not bound to a coroutine. More...
	task (const task &)=delete
	Copy constructor is disabled. More...
	task (task &&other) noexcept
	Move constructor, grabs another task's coroutine handle. More...
task &	operator= (const task &)=delete
	Copy assignment is disabled. More...
task &	operator= (task &&other) noexcept
	Move assignment, grabs another task's coroutine handle. More...
	~task ()
	Destructor. More...
bool	done () const noexcept
	Function to check if the task has finished its execution entirely. More...
task &	cancel () &noexcept
	Cancel the task, it will stop the next time it uses co_await. On co_await-ing this task, throws dpp::task_cancelled_exception. More...
task &&	cancel () &&noexcept
	Cancel the task, it will stop the next time it uses co_await. On co_await-ing this task, throws dpp::task_cancelled_exception. More...

Protected Member Functions
	task (handle_t handle_)
	Construct from a coroutine handle. Internal use only. More...
void	cleanup ()
	Clean up our handle, cancelling any running task. More...

Friends
struct	detail::task::promise_t< R >

Detailed Description

A coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for parallel coroutines returning a value.

Warning

- This feature is EXPERIMENTAL. The API may change at any time and there may be bugs. Please report any to GitHub Issues or to our Discord Server.

Template Parameters

R	Return type of the task. Cannot be a reference but can be void.

Constructor & Destructor Documentation

task() [1/4]

dpp::task::task ( handle_t  handle_ )

inlineexplicitprotected

Construct from a coroutine handle. Internal use only.

task() [2/4]

dpp::task::task ( )

default

Default constructor, creates a task not bound to a coroutine.

task() [3/4]

dpp::task::task ( const task &  )

delete

Copy constructor is disabled.

task() [4/4]

dpp::task::task ( task &&  other )

inlinenoexcept

Move constructor, grabs another task's coroutine handle.

Parameters

other

Task to move the handle from

~task()

dpp::task::~task ( )

inline

Destructor.

Destroys the handle. If the task is still running, it will be cancelled.

Member Function Documentation

cancel() [1/2]

task&& dpp::task::cancel ( ) &&

inlinenoexcept

Cancel the task, it will stop the next time it uses co_await. On co_await-ing this task, throws dpp::task_cancelled_exception.

Returns

*this

cancel() [2/2]

task& dpp::task::cancel ( ) &

inlinenoexcept

Cancel the task, it will stop the next time it uses co_await. On co_await-ing this task, throws dpp::task_cancelled_exception.

Returns

*this

cleanup()

void dpp::task::cleanup ( )

inlineprotected

Clean up our handle, cancelling any running task.

done()

bool dpp::task::done ( ) const

inlinenoexcept

Function to check if the task has finished its execution entirely.

Returns

bool Whether the task is finished.

operator=() [1/2]

task& dpp::task::operator= ( const task &  )

delete

Copy assignment is disabled.

operator=() [2/2]

task& dpp::task::operator= ( task &&  other )

inlinenoexcept

Move assignment, grabs another task's coroutine handle.

Parameters

other

Task to move the handle from

Friends And Related Function Documentation

detail::task::promise_t< R >

friend struct detail::task::promise_t< R >

friend