dpp::detail::job::promise< Args > Struct Template Reference

Coroutine promise type for a job. More...

#include "job.h"

Public Member Functions
std_coroutine::suspend_never	final_suspend () const noexcept
	Function called when the job is done. More...
dpp::job	get_return_object () const noexcept
	Function called to get the job object. More...
std_coroutine::suspend_never	initial_suspend () const noexcept
	Function called when the job is started. More...
void	return_void () const noexcept
	Function called when the job returns. More...
void	unhandled_exception () const
	Function called when an exception is thrown and not caught. More...

Detailed Description

template<typename... Args>
struct dpp::detail::job::promise< Args >

Coroutine promise type for a job.

Member Function Documentation

final_suspend()

template<typename... Args>

std_coroutine::suspend_never dpp::detail::job::promise< Args >::final_suspend ( ) const

inlinenoexcept

Function called when the job is done.

Returns

std::suspend_never Do not suspend at the end, destroying the handle immediately

get_return_object()

template<typename... Args>

dpp::job dpp::detail::job::promise< Args >::get_return_object ( ) const

inlinenoexcept

Function called to get the job object.

Returns

job

initial_suspend()

template<typename... Args>

std_coroutine::suspend_never dpp::detail::job::promise< Args >::initial_suspend ( ) const

inlinenoexcept

Function called when the job is started.

Returns

std::suspend_never Do not suspend at the start, starting the job immediately

return_void()

template<typename... Args>

void dpp::detail::job::promise< Args >::return_void ( ) const

inlinenoexcept

Function called when the job returns.

Does nothing.

unhandled_exception()

template<typename... Args>

void dpp::detail::job::promise< Args >::unhandled_exception ( ) const

inline

Function called when an exception is thrown and not caught.

Exceptions

Immediately

rethrows the exception to the caller / resumer

---

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

• job.h