Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

Class template future

boost::compute::future — Holds the result of an asynchronous computation.

Synopsis

// In header: <boost/compute/async/future.hpp>

template<typename T> 
class future {
public:
  // construct/copy/destruct
  future();
  future(const T &, const event &);
  future(const future< T > &);
  future & operator=(const future< T > &);
  ~future();

  // public member functions
  T get();
  bool valid() const;
  void wait() const;
  event get_event() const;
};

Description

See Also:

event, wait_list

`future` public construct/copy/destruct

```
future();
```

future(const T & result, const event & event);

```
future(const future< T > & other);
```

future & operator=(const future< T > & other);

```
~future();
```

`future` public member functions

```
T get();
```
Returns the result of the computation. This will block until the result is ready.
```
bool valid() const;
```
Returns true if the future is valid.
```
void wait() const;
```
Blocks until the computation is complete.
```
event get_event() const;
```
Returns the underlying event object.