You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
68 lines
2.2 KiB
C++
68 lines
2.2 KiB
C++
// Copyright (C) 2016 Davis E. King (davis@dlib.net)
|
|
// License: Boost Software License See LICENSE.txt for the full license.
|
|
#undef DLIB_AsYNC_ABSTRACT_Hh_
|
|
#ifdef DLIB_AsYNC_ABSTRACT_Hh_
|
|
|
|
#include "thread_pool_extension_abstract.h"
|
|
#include <future>
|
|
#include <functional>
|
|
|
|
namespace dlib
|
|
{
|
|
|
|
// ----------------------------------------------------------------------------------------
|
|
|
|
thread_pool& default_thread_pool(
|
|
);
|
|
/*!
|
|
ensures
|
|
- returns a reference to a global thread_pool. If the DLIB_NUM_THREADS
|
|
environment variable is set to an integer then the thread pool will contain
|
|
DLIB_NUM_THREADS threads, otherwise it will contain
|
|
std::thread::hardware_concurrency() threads.
|
|
!*/
|
|
|
|
// ----------------------------------------------------------------------------------------
|
|
|
|
template <
|
|
typename Function,
|
|
typename ...Args
|
|
>
|
|
std::future<typename std::result_of<Function(Args...)>::type> async(
|
|
thread_pool& tp,
|
|
Function&& f,
|
|
Args&&... args
|
|
);
|
|
/*!
|
|
requires
|
|
- f must be a function and f(args...) must be a valid expression.
|
|
ensures
|
|
- This function behaves just like std::async(std::launch::async, f, args)
|
|
except that instead of spawning a new thread to process each task it submits
|
|
the task to the provided dlib::thread_pool. Therefore, dlib::async() is
|
|
guaranteed to use a bounded number of threads unlike std::async(). This also
|
|
means that calls to dlib::async() will block if there aren't any free threads
|
|
in the thread pool.
|
|
!*/
|
|
|
|
// ----------------------------------------------------------------------------------------
|
|
|
|
template <
|
|
typename Function,
|
|
typename ...Args
|
|
>
|
|
std::future<typename std::result_of<Function(Args...)>::type> async(
|
|
Function&& f,
|
|
Args&&... args
|
|
);
|
|
/*!
|
|
ensures
|
|
- Calling this function is equivalent to directly calling async(default_thread_pool(), f, args...)
|
|
!*/
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------------------
|
|
|
|
#endif // DLIB_AsYNC_ABSTRACT_Hh_
|
|
|