mirrors
/
C-Thread-Pool
mirror of https://github.com/Pithikos/C-Thread-Pool
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleaned up design doc

This commit is contained in:
Gonzalo Diethelm 2020-07-20 18:00:26 +02:00
parent 0e1f9e8f17
commit fe540f09b9
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/Design.md
View File

@ -1,47 +1,47 @@
## High level
Description: Library providing a threading pool where you can add work on the fly. The number
of threads in the pool is adjustable when creating the pool. In most cases
this should equal the number of threads supported by your cpu.
For an example on how to use the threadpool, check the main.c file or just read
the documentation found in the README.md file.
In this header file a detailed overview of the functions and the threadpool's logical
scheme is presented in case you wish to tweak or alter something.
_______________________________________________________
scheme is presented in case you wish to tweak or alter something.
_______________________________________________________
/ \
| JOB QUEUE | job1 | job2 | job3 | job4 | .. |
| JOB QUEUE | job1 | job2 | job3 | job4 | .. |
| |
| threadpool | thread1 | thread2 | .. |
\_______________________________________________________/
Description: Jobs are added to the job queue. Once a thread in the pool
is idle, it is assigned with the first job from the queue(and
erased from the queue). It's each thread's job to read from
the queue serially(using lock) and executing each job
is idle, it is assigned the first job from the queue (and that job is
erased from the queue). It is each thread's job to read from
the queue serially (using lock) and executing each job
until the queue is empty.
Scheme:
thpool______ jobqueue____ ______
thpool______ jobqueue____ ______
| | | | .----------->|_job0_| Newly added job
| | | rear ----------' |_job1_|
| jobqueue----------------->| | |_job2_|
| | | front ----------. |__..__|
| | | front ----------. |__..__|
|___________| |___________| '----------->|_jobn_| Job for thread to take
job0________
job0________
| |
| function---->
| |
| arg------->
| | job1________
| | job1________
| next-------------->| |
|___________| | |..