Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. pw::transport::internal::TransportFutureProvider< FutureType > Class Template Reference
pw::transport::internal::TransportFutureProvider< FutureType > Class Template Reference

Overview

template<typename FutureType>
class pw::transport::internal::TransportFutureProvider< FutureType >

One-to-one provider for AcceptFuture or ConnectFuture.

Wraps an async2::ValueProvider. At most one future may be pending at a time. The provider must resolve its future, if any, before it is destroyed.

Public Types

using ResultType = typename FutureType::value_type
 

Public Member Functions

 TransportFutureProvider (TransportFutureProvider &&) noexcept=default
 
TransportFutureProvider & operator= (TransportFutureProvider &&) noexcept=default
 
 TransportFutureProvider (const TransportFutureProvider &)=delete
 
TransportFutureProvider & operator= (const TransportFutureProvider &)=delete
 
FutureType Get ()
 
std::optional< FutureType > TryGet ()
 Returns a future if none is currently pending, or std::nullopt.
 
bool has_future () const
 Returns true if a vended future is still pending.
 
void Resolve (ResultType &&result)
 Resolves the pending future, if any, with result.
 
void Resolve (const ResultType &result)
 Resolves the pending future, if any, with result.
 

Member Function Documentation

◆ Get()

template<typename FutureType >
FutureType pw::transport::internal::TransportFutureProvider< FutureType >::Get ( )
inline

Returns a future that completes when Resolve is called.

Asserts if a previously vended future is still pending.


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