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

Update README.md

This commit is contained in:
Johan 2015-01-17 23:11:06 +00:00
parent ef70560477
commit 91a193eb2c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -52,8 +52,8 @@ For a deeper look into the documentation check in the `thpool.h` file. Below is
| Function example | Description |
|---------------------------------|---------------------------------------------------------------------|
| ***thpool_init(4)*** | Will return a new threadpool with 4 threads. |
| ***thpool_add_work(thpool, void *(*function_p)(void*), (void*)arg_p)*** | Will add new work to the pool. Work is simply a function. You can pass a single argument to the function if you wish. If not, NULL should be passed. |
| ***thpool_add_work(`thpool`, `void *(*function_p)(void*)`, `(void*)arg_p)`*** | Will add new work to the pool. Work is simply a function. You can pass a single argument to the function if you wish. If not, NULL should be passed. |
| ***thpool_wait(thpool)*** | Will wait for all jobs (both in queue and currently running) to finish. |
| ***thpool_destroy(thpool)*** | This will destroy the threadpool. If jobs are currently being executed, then it will wait for them to finish. |
| ***thpool_pause(thpool)*** | All threads in the threadpool will pause no matter if they are idle or executing work. |
| ***thpool_pause(thpool)*** | If the threadpool is paused, then all threads will resume from where they were. |
| ***thpool_pause(`thpool`)*** | If the threadpool is paused, then all threads will resume from where they were. |