Anklang-0.3.0.dev712+gdc4e642f anklang-0.3.0.dev712+gdc4e642f
ASE — Anklang Sound Engine (C++)

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Attributes | List of all members
Ase::CoTask< Result > Struct Template Reference

General purpose coroutine task. More...

#include "cotask.hh"

Classes

struct  promise_type
 

Public Member Functions

constexpr bool await_ready () const noexcept
 
Result await_resume ()
 
std::coroutine_handle await_suspend (std::coroutine_handle<> waiter) noexcept
 
 CoTask (std::coroutine_handle< promise_type > h)
 
 CoTask (CoTask &&o) noexcept
 
CoTaskoperator= (CoTask &&o) noexcept
 
 CoTask (const CoTask &)=delete
 
CoTaskoperator= (const CoTask &)=delete
 

Protected Attributes

std::coroutine_handle< promise_typeframe_
 Handle for this task.
 

Detailed Description

template<typename Result>
struct Ase::CoTask< Result >

General purpose coroutine task.

This class represents a unit of asynchronous work that lazily executes when awaited. It is designed for composition (Task A awaits Task B).

Definition at line 92 of file cotask.hh.

Constructor & Destructor Documentation

◆ CoTask() [1/2]

template<typename Result >
Ase::CoTask< Result >::CoTask ( std::coroutine_handle< promise_type h)
explicit

Definition at line 127 of file cotask.hh.

◆ ~CoTask()

template<typename Result >
Ase::CoTask< Result >::~CoTask ( )

Definition at line 128 of file cotask.hh.

◆ CoTask() [2/2]

template<typename Result >
Ase::CoTask< Result >::CoTask ( CoTask< Result > &&  o)
noexcept

Definition at line 134 of file cotask.hh.

Member Function Documentation

◆ await_ready()

template<typename Result >
constexpr bool Ase::CoTask< Result >::await_ready ( ) const
constexprnoexcept

Definition at line 111 of file cotask.hh.

◆ await_resume()

template<typename Result >
Result Ase::CoTask< Result >::await_resume ( )

Definition at line 113 of file cotask.hh.

◆ await_suspend()

template<typename Result >
std::coroutine_handle Ase::CoTask< Result >::await_suspend ( std::coroutine_handle<>  waiter)
noexcept

Definition at line 119 of file cotask.hh.

◆ operator=()

template<typename Result >
CoTask & Ase::CoTask< Result >::operator= ( CoTask< Result > &&  o)
noexcept

Definition at line 135 of file cotask.hh.

Member Data Documentation

◆ frame_

template<typename Result >
std::coroutine_handle<promise_type> Ase::CoTask< Result >::frame_
protected

Handle for this task.

Definition at line 139 of file cotask.hh.


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