ThreadWeaver::ResourceRestrictionPolicy Class
class ThreadWeaver::ResourceRestrictionPolicyResourceRestrictionPolicy is used to limit the number of concurrent accesses to the same resource. More...
| Header: | #include <ThreadWeaver/ResourceRestrictionPolicy> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS ThreadWeaver)target_link_libraries(mytarget PRIVATE KF6::ThreadWeaver) |
| Inherits: | ThreadWeaver::QueuePolicy |
Public Functions
| ResourceRestrictionPolicy(int cap = 0) | |
| int | cap() const |
| void | setCap(int newCap) |
Detailed Description
If a set of Jobs accesses a resource that can be overloaded, this may degrade application performance. For example, loading too many files from the hard disc at the same time may lead to longer load times. ResourceRestrictionPolicy can be used to cap the number of accesses. Resource restriction policies are shared between the affected jobs. All jobs that share a resource restriction policy have to acquire permission from the policy before they can run. In this way, resource restrictions can be compared to semaphores, only that they require no locking at the thread level. The example uses a resource restriction to limit the number of images files that are loaded from the disk at the same time.
Member Function Documentation
[explicit] ResourceRestrictionPolicy::ResourceRestrictionPolicy(int cap = 0)
int ResourceRestrictionPolicy::cap() const
See also setCap().
void ResourceRestrictionPolicy::setCap(int newCap)
Cap the number of simultaneously executing jobs. Capping the amount of jobs will make sure that at max the number of jobs executing at any time is limited to the capped amount. Note that immediately after setting the amount of running jobs may be higher than the set amount. This setting only limits the starting of new jobs. newCap the new cap to limit the amount of parallel jobs.
See also cap().