the_Foundation 1.0
Loading...
Searching...
No Matches
Data Structures | Functions | Variables
threadpool.h File Reference
#include "thread.h"
#include "queue.h"

Data Structures

struct  iThreadPoolClass
 
struct  iThreadPool
 

Functions

iThreadPool * new_ThreadPool (void)
 
void init_ThreadPool (iThreadPool *d)
 
void deinit_ThreadPool (iThreadPool *d)
 
iThreadPool * newLimits_ThreadPool (int minThreads, int reservedCores)
 
void initLimits_ThreadPool (iThreadPool *, int minThreads, int reservedCores)
 
iThread * run_ThreadPool (iThreadPool *, iThread *thread)
 
iBool yield_ThreadPool (iThreadPool *, double timeoutSeconds)
 

Variables

iThreadPoolClass Class_ThreadPool
 

Detailed Description

Thread pool.

Authors
Copyright (c) 2017 Jaakko Keränen jaakk.nosp@m.o.ke.nosp@m.ranen.nosp@m.@iki.nosp@m..fi
License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ newLimits_ThreadPool()

iThreadPool * newLimits_ThreadPool ( int minThreads,
int reservedCores )

Constructs a thread pool with a limited number of threads.

Parameters
minThreadsMinimum number of threads to create.
reservedCoresNumber of logical CPU cores to be considered reserved for other uses and therefore not included in the pool, making the pool smaller.

◆ yield_ThreadPool()

iBool yield_ThreadPool ( iThreadPool * ,
double timeoutSeconds )

Use the calling thread to run another queud thread. Returns immediately after a queued thread has finished executing. Use this to sleep in pooled threads; regular sleeping in a pooled thread would potentially block the pool from doing any work, if all the workers are sleeping.

Parameters
timeoutSecondsMaximum duration to wait until queued threads become available.
Returns
iTrue, if a queued thread was executed. iFalse, if timed out without running anything.