.TH "std::shared_future< _Res >" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::shared_future< _Res > \- Primary template for shared_future\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBstd::__basic_future< _Res >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "template<\fBtypename\fP _Res > \fBusing\fP \fB_Ptr\fP = \fBunique_ptr\fP< _Res, _Result_base::_Deleter >" .br .RI "A unique_ptr for result objects\&. " .ti -1c .RI "\fBusing\fP \fB_State_base\fP = _State_baseV2" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBshared_future\fP (\fBconst\fP \fBshared_future\fP &\fB__sf\fP) \fBnoexcept\fP" .br .RI "Copy constructor\&. " .ti -1c .RI "\fBshared_future\fP (\fBfuture\fP< _Res > &&\fB__uf\fP) \fBnoexcept\fP" .br .RI "Construct from a future rvalue\&. " .ti -1c .RI "\fBshared_future\fP (\fBshared_future\fP &&\fB__sf\fP) \fBnoexcept\fP" .br .RI "Construct from a shared_future rvalue\&. " .ti -1c .RI "\fBconst\fP _Res & \fBget\fP () \fBconst\fP" .br .RI "Retrieving the value\&. " .ti -1c .RI "\fBshared_future\fP & \fBoperator=\fP (\fBconst\fP \fBshared_future\fP &\fB__sf\fP) \fBnoexcept\fP" .br .ti -1c .RI "\fBshared_future\fP & \fBoperator=\fP (\fBshared_future\fP &&\fB__sf\fP) \fBnoexcept\fP" .br .ti -1c .RI "bool \fBvalid\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBvoid\fP \fBwait\fP () \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > \fBfuture_status\fP \fBwait_for\fP (\fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > &\fB__rel\fP) \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > \fBfuture_status\fP \fBwait_until\fP (\fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > &\fB__abs\fP) \fBconst\fP" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "template<\fBtypename\fP _Res , \fBtypename\fP \fB_Allocator\fP > \fBstatic\fP \fB_Ptr\fP< \fB_Result_alloc\fP< _Res, \fB_Allocator\fP > > \fB_S_allocate_result\fP (\fBconst\fP \fB_Allocator\fP &__a)" .br .ti -1c .RI "template<\fBtypename\fP _Res , \fBtypename\fP _Tp > \fBstatic\fP \fB_Ptr\fP< \fB_Result\fP< _Res > > \fB_S_allocate_result\fP (\fBconst\fP \fBstd::allocator\fP< _Tp > &__a)" .br .ti -1c .RI "template<\fBtypename\fP _BoundFn > \fBstatic\fP \fBstd::shared_ptr\fP< _State_base > \fB_S_make_async_state\fP (_BoundFn &&\fB__fn\fP)" .br .ti -1c .RI "template<\fBtypename\fP _BoundFn > \fBstatic\fP \fBstd::shared_ptr\fP< _State_base > \fB_S_make_deferred_state\fP (_BoundFn &&\fB__fn\fP)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Res_ptr\fP , \fBtypename\fP _BoundFn > \fBstatic\fP _Task_setter< \fB_Res_ptr\fP, _BoundFn > \fB_S_task_setter\fP (\fB_Res_ptr\fP &\fB__ptr\fP, _BoundFn &__call)" .br .in -1c .SS "Protected Types" .in +1c .ti -1c .RI "\fBtypedef\fP \fB__future_base::_Result\fP< _Res > & \fB__result_type\fP" .br .ti -1c .RI "\fBtypedef\fP \fBshared_ptr\fP< _State_base > \fB__state_type\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fB__result_type\fP \fB_M_get_result\fP () \fBconst\fP" .br .RI "Wait for the state to be ready and rethrow any stored exception\&. " .ti -1c .RI "\fBvoid\fP \fB_M_swap\fP (\fB__basic_future\fP &\fB__that\fP) \fBnoexcept\fP" .br .in -1c .SH "Detailed Description" .PP .SS "template<\fBtypename\fP _Res> .br class std::shared_future< _Res >"Primary template for shared_future\&. .PP Definition at line \fB891\fP of file \fBfuture\fP\&. .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP _Res > \fBtypedef\fP \fB__future_base::_Result\fP<_Res>& \fBstd::__basic_future\fP< _Res >::__result_type\fC [protected]\fP, \fC [inherited]\fP" .PP Definition at line \fB675\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBtypedef\fP \fBshared_ptr\fP<_State_base> \fBstd::__basic_future\fP< _Res >::__state_type\fC [protected]\fP, \fC [inherited]\fP" .PP Definition at line \fB674\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBusing\fP \fBstd::__future_base::_Ptr\fP = \fBunique_ptr\fP<_Res, _Result_base::_Deleter>\fC [inherited]\fP" .PP A unique_ptr for result objects\&. .PP Definition at line \fB223\fP of file \fBfuture\fP\&. .SS "\fBusing\fP std::__future_base::_State_base = _State_baseV2\fC [inherited]\fP" .PP Definition at line \fB587\fP of file \fBfuture\fP\&. .SH "Constructor & Destructor Documentation" .PP .SS "template<\fBtypename\fP _Res > \fBconstexpr\fP \fBstd::shared_future\fP< _Res >::shared_future ()\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP" .PP Definition at line \fB896\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBstd::shared_future\fP< _Res >::shared_future (\fBconst\fP \fBshared_future\fP< _Res > & __sf)\fC [inline]\fP, \fC [noexcept]\fP" .PP Copy constructor\&. .PP Definition at line \fB899\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBstd::shared_future\fP< _Res >::shared_future (\fBfuture\fP< _Res > && __uf)\fC [inline]\fP, \fC [noexcept]\fP" .PP Construct from a future rvalue\&. .PP Definition at line \fB902\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBstd::shared_future\fP< _Res >::shared_future (\fBshared_future\fP< _Res > && __sf)\fC [inline]\fP, \fC [noexcept]\fP" .PP Construct from a shared_future rvalue\&. .PP Definition at line \fB907\fP of file \fBfuture\fP\&. .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP _Res > \fB__result_type\fP \fBstd::__basic_future\fP< _Res >::_M_get_result () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Wait for the state to be ready and rethrow any stored exception\&. .PP Definition at line \fB714\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBvoid\fP \fBstd::__basic_future\fP< _Res >::_M_swap (\fB__basic_future\fP< _Res > & __that)\fC [inline]\fP, \fC [protected]\fP, \fC [noexcept]\fP, \fC [inherited]\fP" .PP Definition at line \fB723\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res , \fBtypename\fP \fB_Allocator\fP > \fBstatic\fP \fB_Ptr\fP< \fB_Result_alloc\fP< _Res, \fB_Allocator\fP > > std::__future_base::_S_allocate_result (\fBconst\fP \fB_Allocator\fP & __a)\fC [inline]\fP, \fC [static]\fP, \fC [inherited]\fP" .PP Definition at line \fB288\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res , \fBtypename\fP _Tp > \fBstatic\fP \fB_Ptr\fP< \fB_Result\fP< _Res > > std::__future_base::_S_allocate_result (\fBconst\fP \fBstd::allocator\fP< _Tp > & __a)\fC [inline]\fP, \fC [static]\fP, \fC [inherited]\fP" .PP Definition at line \fB301\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP \fB_Res_ptr\fP , \fBtypename\fP _BoundFn > \fBstatic\fP _Task_setter< \fB_Res_ptr\fP, _BoundFn > std::__future_base::_S_task_setter (\fB_Res_ptr\fP & __ptr, _BoundFn & __call)\fC [inline]\fP, \fC [static]\fP, \fC [inherited]\fP" .PP Definition at line \fB619\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBconst\fP _Res & \fBstd::shared_future\fP< _Res >::get () const\fC [inline]\fP" .PP Retrieving the value\&. .PP Definition at line \fB925\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBshared_future\fP & \fBstd::shared_future\fP< _Res >::operator= (\fBconst\fP \fBshared_future\fP< _Res > & __sf)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB911\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBshared_future\fP & \fBstd::shared_future\fP< _Res >::operator= (\fBshared_future\fP< _Res > && __sf)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB917\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > bool \fBstd::__basic_future\fP< _Res >::valid () const\fC [inline]\fP, \fC [noexcept]\fP, \fC [inherited]\fP" .PP Definition at line \fB686\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > \fBvoid\fP \fBstd::__basic_future\fP< _Res >::wait () const\fC [inline]\fP, \fC [inherited]\fP" .PP Definition at line \fB689\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > \fBfuture_status\fP \fBstd::__basic_future\fP< _Res >::wait_for (\fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > & __rel) const\fC [inline]\fP, \fC [inherited]\fP" .PP Definition at line \fB697\fP of file \fBfuture\fP\&. .SS "template<\fBtypename\fP _Res > template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > \fBfuture_status\fP \fBstd::__basic_future\fP< _Res >::wait_until (\fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > & __abs) const\fC [inline]\fP, \fC [inherited]\fP" .PP Definition at line \fB705\fP of file \fBfuture\fP\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.