Topaz/job_8hpp_source.html

#ifndef TOPAZ_CORE_JOB_HPP

#define TOPAZ_CORE_JOB_HPP

#include "tz/core/handle.hpp"

#include <functional>


namespace tz

{

    namespace detail

    {

        struct job_tag_t{};

    }

    using job_handle = tz::handle<detail::job_tag_t>;

    using job_function = std::function<void()>;

    using job_worker = std::size_t;


    job_handle job_execute(job_function fn);

    job_handle job_execute_on(job_function fn, job_worker worker);

    void job_wait(job_handle job);

    bool job_complete(job_handle job);

    std::size_t job_count();

    std::size_t job_worker_count();

}


#endif // TOPAZ_CORE_JOB_HPP

tz::handle
Represents a generic opaque handle.
Definition handle.hpp:32

tz::job_count
std::size_t job_count()
Estimate the total number of jobs that have been created but not yet completed.

tz::job_function
std::function< void()> job_function
Represents a function that will be executed on a job worker via job_execute.
Definition job.hpp:22

tz::job_execute
job_handle job_execute(job_function fn)
Execute a function as a new job.

tz::job_execute_on
job_handle job_execute_on(job_function fn, job_worker worker)
Execute a function as a new job - but can only be picked up by a specific worker.

tz::job_worker_count
std::size_t job_worker_count()
Retrieve the number of worker threads.

tz::job_wait
void job_wait(job_handle job)
Block the current thread until the job specified has been fully completed.

tz::job_complete
bool job_complete(job_handle job)
Query as to whether the specific job has been fully completed or not.