DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
DiscordCoreAPI::CoRoutine< void > Class Reference

A CoRoutine - representing a potentially asynchronous operation/function. More...

#include <CoRoutine.hpp>

Inherits DiscordCoreAPI::CoRoutineBase.

Public Member Functions

void cancel ()
 Cancels the currently executing CoRoutine and returns the current result. More...
 
void get ()
 Gets the resulting value of the CoRoutine. More...
 
CoRoutineStatus getStatus ()
 Collects the status of the CoRoutine. More...
 

Member Function Documentation

◆ cancel()

void DiscordCoreAPI::CoRoutine< void >::cancel ( )
inline

Cancels the currently executing CoRoutine and returns the current result.

Definition at line 345 of file CoRoutine.hpp.

◆ get()

void DiscordCoreAPI::CoRoutine< void >::get ( )
inline

Gets the resulting value of the CoRoutine.

Definition at line 327 of file CoRoutine.hpp.

Here is the caller graph for this function:

◆ getStatus()

CoRoutineStatus DiscordCoreAPI::CoRoutine< void >::getStatus ( )
inline

Collects the status of the CoRoutine.

Returns
CoRoutineStatus The status of the CoRoutine.

Definition at line 315 of file CoRoutine.hpp.


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