mtcore::thread::Future< T, E > Struct Template Reference

Represents a value that will be made available in the future Can wait on the value for when it is ready. More...

#include <future.hpp>

Inheritance diagram for mtcore::thread::Future< T, E >:

Collaboration diagram for mtcore::thread::Future< T, E >:

Public Member Functions
Result< Future, ArcError >	acquire (Allocator &alloc)
	Acquires a new reference to the future (if you want multiple parts of your code to read it)
T	wait ()
	Blocks to wait for result.
void	deinit (Allocator &alloc)
	Cleans up future.

Public Attributes
Arc< FutureState< T, E > >	state

Detailed Description

template<typename T, typename E = void>
struct mtcore::thread::Future< T, E >

Represents a value that will be made available in the future Can wait on the value for when it is ready.

Atomic Reference Counting

• 1-2 for state

Condition Variables:

• 1 condition variables for receiving

Non-Blocking Availability:

• None

Template Parameters

T	Value that will be returned
E	Extra state in the underlying state

Definition at line 50 of file future.hpp.

Member Function Documentation

acquire()

template<typename T, typename E = void>

Result< Future, ArcError > mtcore::thread::Future< T, E >::acquire ( Allocator & alloc )

inline

Acquires a new reference to the future (if you want multiple parts of your code to read it)

Parameters

alloc

Allocator for arc

Definition at line 57 of file future.hpp.

                                                       {
      auto res = state.acquire(alloc);
      if (res.is_error()) {
        return res.error();
      }
      return Future{.state = res.value()};
    }

deinit()

template<typename T, typename E = void>

void mtcore::thread::Future< T, E >::deinit ( Allocator & alloc )

inline

Cleans up future.

Parameters

alloc

Allocator for cleaning up Arc (if we were the last to hold it)

Definition at line 74 of file future.hpp.

{ state.deinit(alloc); }

wait()

template<typename T, typename E = void>

T mtcore::thread::Future< T, E >::wait ( )

inlinenodiscard

Blocks to wait for result.

Definition at line 68 of file future.hpp.

{ return state->wait(); }

Member Data Documentation

state

template<typename T, typename E = void>

Arc<FutureState<T, E> > mtcore::thread::Future< T, E >::state

Definition at line 51 of file future.hpp.

---

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

• future.hpp