uvco::Coroutine< T > Class Template Reference

A coroutine object used internally by C++20 coroutines ("promise object"). More...

#include <promise.h>

Collaboration diagram for uvco::Coroutine< T >:

Public Member Functions
	Coroutine ()
	Coroutine (const Coroutine &other)=delete
Coroutine &	operator= (const Coroutine &other)=delete
	Coroutine (Coroutine &&other)=delete
Coroutine &	operator= (Coroutine &&other)=delete
	~Coroutine ()
Promise< T >	get_return_object ()
void	return_value (T value)
std::suspend_never	initial_suspend () noexcept
std::suspend_never	final_suspend () noexcept
void	unhandled_exception ()

Protected Attributes
SharedCore_	core_

Private Types
using	PromiseCore_ = PromiseCore<T>
	PromiseCore_ handles the inner mechanics of resumption and suspension.
using	SharedCore_ = PromiseCore_ *

Detailed Description

template<typename T>
class uvco::Coroutine< T >

A coroutine object used internally by C++20 coroutines ("promise object").

Member Typedef Documentation

PromiseCore_

template<typename T >

using uvco::Coroutine< T >::PromiseCore_ = PromiseCore<T>

private

PromiseCore_ handles the inner mechanics of resumption and suspension.

SharedCore_

template<typename T >

using uvco::Coroutine< T >::SharedCore_ = PromiseCore_ *

private

Constructor & Destructor Documentation

Coroutine() [1/3]

template<typename T >

uvco::Coroutine< T >::Coroutine ( )

inline

Coroutine object lives and is pinned within the coroutine frame; copy/move is disallowed.

: core_{makeRefCounted<PromiseCore_>()} {}

Coroutine() [2/3]

template<typename T >

uvco::Coroutine< T >::Coroutine ( const Coroutine< T > &  other )

delete

Coroutine() [3/3]

template<typename T >

uvco::Coroutine< T >::Coroutine ( Coroutine< T > &&  other )

delete

~Coroutine()

template<typename T >

uvco::Coroutine< T >::~Coroutine ( )

inline

               {
    if (core_ != nullptr) {
      core_->delRef();
    }
  }

Member Function Documentation

final_suspend()

template<typename T >

std::suspend_never uvco::Coroutine< T >::final_suspend ( )

inlinenoexcept

Part of the coroutine protocol: called upon co_return or unhandled exception.

{ return {}; }

get_return_object()

template<typename T >

Promise< T > uvco::Coroutine< T >::get_return_object ( )

inline

Part of the coroutine protocol: Called on first suspension point (co_await) or co_return.

{ return Promise<T>{core_}; }

initial_suspend()

template<typename T >

std::suspend_never uvco::Coroutine< T >::initial_suspend ( )

inlinenoexcept

Part of the coroutine protocol: called after construction of Promise object, i.e. before starting the coroutine.

In uvco, the coroutine always runs at least up to its first suspension point, at which point it may be suspended (if the awaited object is not ready).

{ return {}; }

operator=() [1/2]

template<typename T >

Coroutine & uvco::Coroutine< T >::operator= ( const Coroutine< T > &  other )

delete

operator=() [2/2]

template<typename T >

Coroutine & uvco::Coroutine< T >::operator= ( Coroutine< T > &&  other )

delete

return_value()

template<typename T >

void uvco::Coroutine< T >::return_value ( T  value )

inline

Part of the coroutine protocol: Called by co_return. Schedules the awaiting coroutine for resumption.

                             {
    // Probably cancelled.
    if (core_->slot.has_value() && core_->slot->index() == 1) {
      return;
    }
    BOOST_ASSERT(!core_->slot);
    core_->slot = std::move(value);
    core_->resume();
  }

unhandled_exception()

template<typename T >

void uvco::Coroutine< T >::unhandled_exception ( )

inline

                             {
    core_->except(std::current_exception());
    core_->resume();
  }

Member Data Documentation

core_

template<typename T >

SharedCore_ uvco::Coroutine< T >::core_

protected

---

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

• uvco/promise/promise.h