PrevUpHomeNext

Class execution

boost::pipeline::execution

Synopsis

// In header: <boost/pipeline/execution.hpp>


class execution {
public:
  // construct/copy/destruct
  execution(std::future< void > &&);

  // public member functions
  bool is_done();
  void wait();
};

Description

Handle to an executing pipeline.

An instance of this class returned every time run() is called on a complete pipeline.

Holds a future which is set on pipeline completition, destructor blocks until pipeline is terminated. std::move it if it's not desired.

execution public construct/copy/destruct

  1. execution(std::future< void > && future);

    Creates an exectution holding future

    Parameters:

    future

    Future promised by the terminating segment of the represented pipeline.

execution public member functions

  1. bool is_done();

    Checks if the pipeline has terminated

    Returns:

    true, if the execution of the pipeline is done, false otherwise

  2. void wait();

    Waits until the execution of the pipeline is completed

    Postconditions:

    Blocks until the execution is done


PrevUpHomeNext