PSYQO SDK
Coroutine
coroutine.hh · the coroutine module
Module
the coroutine module.
Include this module
C++ include
#include "psyqo/coroutine.hh"Types
AwaiterThe awaiter type.StructChainAwaiterThe awaiter type for coroutine-to-coroutine chaining via co_await.StructCoroutineA suitable type to hold and return a C++20 coroutine.Class templateEmptyStruct declared by the coroutine module for the coroutine module.Structpromise_typeType alias declared by the coroutine module for the coroutine module.Type aliasStackfulStackful coroutine class.Class templateStackfulBaseClass declared by the coroutine module for the coroutine module.ClassFunctions and methods
~ChainAwaiterReleases the resources owned by `psyqo::Coroutine::ChainAwaiter`.destructor~Coroutine<T>Releases the resources owned by `psyqo::Coroutine`.destructorawait_readyPerforms `await ready` as part of the coroutine module.Methodawait_readyPerforms `await ready` as part of the coroutine module.Methodawait_resumePerforms `await resume` as part of the coroutine module.Methodawait_resumePerforms `await resume` as part of the coroutine module.Methodawait_suspendPerforms `await suspend` as part of the coroutine module.Methodawait_suspendPerforms `await suspend` as part of the coroutine module.MethodawaiterCreates an `Awaiter` object.MethodAwaiterConstructs `psyqo::Coroutine::Awaiter` for the coroutine module.constructorChainAwaiterConstructs `psyqo::Coroutine::ChainAwaiter` for the coroutine module.constructorCoroutine<T>Constructs `psyqo::Coroutine` for the coroutine module.constructordoneReturns the status of the coroutine.MethodinitializeInitialize the coroutine with a function and an argument.MethodisAliveCheck if the coroutine is currently alive.Methodoperator co_awaitPerforms `operator co await` as part of the coroutine module.Methodoperator=Performs `operator =` as part of the coroutine module.Methodoperator=Performs `operator =` as part of the coroutine module.Methodoperator=Performs `operator =` as part of the coroutine module.Methodoperator=Performs `operator =` as part of the coroutine module.MethodresumeResumes the coroutine.MethodresumeResume the coroutine.MethodStackful<StackSize>Constructs `psyqo::Stackful` for the coroutine module.constructorvalueReturns the value returned by the coroutine.MethodyieldYield the coroutine.Method