blob: f12c7f10e53225661bbc50b63d6fa5f9754a2b62 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/**
* @file processor.h
*
* @brief Interface of processor_t.
*
*/
/*
* Copyright (C) 2005-2007 Martin Willi
* Copyright (C) 2005 Jan Hutter
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef PROCESSOR_H_
#define PROCESSOR_H_
typedef struct processor_t processor_t;
#include <stdlib.h>
#include <library.h>
#include <processing/jobs/job.h>
/**
* @brief The processor uses threads to process queued jobs.
*
* @b Constructors:
* - processor_create()
*
* @ingroup processing
*/
struct processor_t {
/**
* @brief Get the total number of threads used by the processor.
*
* @param this calling object
* @return size of thread pool
*/
u_int (*get_total_threads) (processor_t *this);
/**
* @brief Get the number of threads currently waiting.
*
* @param this calling object
* @return number of idle threads
*/
u_int (*get_idle_threads) (processor_t *this);
/**
* @brief Get the number of queued jobs.
*
* @param this calling object
* @returns number of items in queue
*/
u_int (*get_job_load) (processor_t *this);
/**
* @brief Adds a job to the queue.
*
* This function is non blocking and adds a job_t to the queue.
*
* @param this calling object
* @param job job to add to the queue
*/
void (*queue_job) (processor_t *this, job_t *job);
/**
* @brief Set the number of threads to use in the processor.
*
* If the number of threads is smaller than number of currently running
* threads, thread count is decreased. Use 0 to disable the processor.
* This call blocks if it decreases thread count until threads have
* terminated, so make sure there are not too many blocking jobs.
*
* @param this calling object
* @param count number of threads to allocate
*/
void (*set_threads)(processor_t *this, u_int count);
/**
* @brief Destroy a processor object.
*
* @param processor calling object
*/
void (*destroy) (processor_t *processor);
};
/**
* @brief Create the thread pool without any threads.
*
* Use the set_threads method to start processing jobs.
*
* @return processor_t object
*
* @ingroup processing
*/
processor_t *processor_create();
#endif /*PROCESSOR_H_*/
|
