Class IThreadFutureBase

quantum/interface/quantum_ithread_future_base.h:32–53

============================================================================================== interface IThreadFutureBase ============================================================================================== @interface ICoroFutureBase @brief Exposes methods to access a non-coroutine future (i.e. accessed from a thread)

/// @interface ICoroFutureBase
/// @brief Exposes methods to access a non-coroutine future (i.e. accessed from a thread)
struct IThreadFutureBase
{
    using Ptr = std::shared_ptr<IThreadFutureBase>;
    
    /// @brief Virtual destructor
    virtual ~IThreadFutureBase() = default;
    
    /// @brief Determines if this future still has a shared state with the promise object.
    /// @return True if valid, false otherwise.
    virtual bool valid() const = 0;
    
    /// @brief Waits for the future value.
    /// @note This method blocks until the future is ready or until an exception is thrown.
    virtual void wait() const = 0;
    
    /// @brief Waits for the future value up to a maximum 'timeMs' milliseconds.
    /// @param[in] timeMs The maximum amount of milliseconds to wait until the future value becomes ready.
    ///                   Using -1 is equivalent to calling wait(). Other negative values will throw.
    /// @return 'ready' if value was posted before duration expired or 'timeout' otherwise.
    /// @note Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown.
    virtual std::future_status waitFor(std::chrono::milliseconds timeMs) const = 0;
};

using IThreadFutureBasePtr = IThreadFutureBase::Ptr;