uni20::async::ReadOrCancelAwaiter< T > Class Template Reference

Awaiter returning owning read access or throwing task_cancelled. More...

#include <buffers.hpp>

Public Types
using	value_type = OwningReadAccessProxy< T >

Public Member Functions
bool	await_ready () const noexcept
	Check if the value is already ready to be read.
value_type	await_resume ()
	Resume execution and return an owning read proxy.
void	await_suspend (BasicTask &&t) noexcept
	Suspend this coroutine and enqueue for resumption.
	ReadOrCancelAwaiter (ReadOrCancelAwaiter &&)=default
	Move constructor.

Detailed Description

template<typename T>
class uni20::async::ReadOrCancelAwaiter< T >

Awaiter returning owning read access or throwing task_cancelled.

Template Parameters

T	Stored value type.

Member Typedef Documentation

value_type

template<typename T >

using uni20::async::ReadOrCancelAwaiter< T >::value_type = OwningReadAccessProxy<T>

Constructor & Destructor Documentation

ReadOrCancelAwaiter()

template<typename T >

uni20::async::ReadOrCancelAwaiter< T >::ReadOrCancelAwaiter ( ReadOrCancelAwaiter< T > &&  )

default

Move constructor.

Member Function Documentation

await_ready()

template<typename T >

bool uni20::async::ReadOrCancelAwaiter< T >::await_ready ( ) const

inlinenoexcept

Check if the value is already ready to be read.

Returns

true if the epoch is ready and no suspension is needed.

await_resume()

template<typename T >

value_type uni20::async::ReadOrCancelAwaiter< T >::await_resume ( )

inline

Resume execution and return an owning read proxy.

Exceptions

task_cancelled	when the read source has no value.
Any	exception stored by a failed writer.

await_suspend()

template<typename T >

void uni20::async::ReadOrCancelAwaiter< T >::await_suspend ( BasicTask &&  t )

inlinenoexcept

Suspend this coroutine and enqueue for resumption.

Parameters

t	Coroutine task to enqueue.

---

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

• buffers.hpp