C/C++ API Reference
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
pw::async2::Poll< void > Class Reference
pw_async2 » Poll

Overview

The Poll<void> specialization does not hold a value. It only indicates whether the operation is Ready or Pending.

Poll<void> provides value() accessors that resolve to ReadyType instead of void. This simplifies templates that use Poll, since all Poll instantiations offer a value() that returns an instantiable, referencable type.

Public Types

using value_type = void
 

Public Member Functions

constexpr Poll (const Poll &)=default
 
constexpr Poll & operator= (const Poll &)=default
 
constexpr Poll (Poll &&)=default
 
constexpr Poll & operator= (Poll &&)=default
 
constexpr Poll (std::in_place_t)
 
constexpr Poll (std::in_place_t, ReadyType)
 
constexpr Poll (ReadyType)
 
constexpr Poll & operator= (ReadyType)
 
constexpr Poll (PendingType)
 
constexpr Poll & operator= (PendingType)
 
constexpr bool IsReady () const noexcept
 
constexpr bool IsPending () const noexcept
 
constexpr Poll Readiness () const noexcept
 
constexpr ReadyType & value () noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr const ReadyType & value () const noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr const ReadyType * operator-> () const noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr ReadyType * operator-> () noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr const ReadyType & operator* () const noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr ReadyType & operator* () noexcept
 Returns a ReadyType for compatibility with non-void Poll.
 
constexpr void IgnorePoll () const
 

Friends

constexpr bool operator== (const Poll &lhs, const Poll &rhs)
 
constexpr bool operator!= (const Poll &lhs, const Poll &rhs)
 

Member Function Documentation

◆ operator*() [1/2]

constexpr const ReadyType & pw::async2::Poll< void >::operator* ( ) const
inlineconstexprnoexcept

Returns a ReadyType for compatibility with non-void Poll.

◆ operator*() [2/2]

constexpr ReadyType & pw::async2::Poll< void >::operator* ( )
inlineconstexprnoexcept

Returns a ReadyType for compatibility with non-void Poll.

◆ operator->() [1/2]

constexpr const ReadyType * pw::async2::Poll< void >::operator-> ( ) const
inlineconstexprnoexcept

Returns a ReadyType for compatibility with non-void Poll.

◆ operator->() [2/2]

constexpr ReadyType * pw::async2::Poll< void >::operator-> ( )
inlineconstexprnoexcept

Returns a ReadyType for compatibility with non-void Poll.

◆ value()

constexpr const ReadyType & pw::async2::Poll< void >::value ( ) const
inlineconstexprnoexcept

Returns a ReadyType for compatibility with non-void Poll.

Friends And Related Function Documentation

◆ operator!=

constexpr bool operator!= ( const Poll< void > &  lhs,
const Poll< void > &  rhs 
)
friend

Returns whether two instances of Poll<T> are unequal.

Note that this comparison operator will return false if both values are currently Pending, even if the eventual results of each operation might differ.

◆ operator==

constexpr bool operator== ( const Poll< void > &  lhs,
const Poll< void > &  rhs 
)
friend

Returns whether two instances of Poll<T> are equal.

Note that this comparison operator will return true if both values are currently Pending, even if the eventual results of each operation might differ.

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