README

   1
   2
   3 Build
   4 ========
   5
   6 Release mode:
   7
   8 cmake .
   9 make
  10 make install
  11
  12 Debug mode:
  13
  14 cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-DDEBUG .
  15 make
  16 make install
  17
  18 api
  19 ======
  20
  21 Declare the pointer for the pools data, memory is malloc'd when you create the pool:
  22
  23 thread_pool_t *pool_id;
  24
  25 Create the pool, returns 0 if the pool is created or POOL_CREATE_ERR otherwise.  Mode is either CTP_PRIORITY,
  26  CTP_FIFO (first in, first out) or FILO (first in, last out):
  27
  28 ctp_create_pool(&pool_id, min_threads, max_threads, mode);
  29
  30 Add a job to the pool, priority is 1 first, 99 last (ignored if mode is CTP_PRIORITY), *data must be a
  31 pointer to already malloc'd memory, returns 0 if the job is added, JOB_CREATE_ERR otherwise.  *data must be free'd before the function end:
  32
  33 ctp_add_job(pool_id, priority, *function, *data);
  34
  35 Kill the pool, destorys all jobs & threads, after already running jobs finish, returns 0 when the pool is killed:
  36
  37 ctp_kill_pool(&pool_id);
  38
  39 Pause/start the pool, already running jobs continue, no new jobs are started:
  40
  41 ctp_pause_pool(pool_id);
  42 ctp_start_pool(pool_id);
  43
  44 Change max/min threads:
  45
  46 ctp_max_threads(pool_id, max_threads);
  47 ctp_min_threads(pool_id, min_threads);
  48
  49 POOL_DEAD is returned by ctp_add_job, ctp_kill_pool, ctp_pause_pool, ctp_start_pool, ctp_max_threads &
  50  ctp_min_threads if a null pointer is passed to them
  51
  52 example.c contains sample code