blob: 98ee8cf471e1b498f80f921c8cbc597def015ec8 (
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
112
113
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2012, Digium, Inc.
*
* Mark Michelson <mmmichelson@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
#ifndef _ASTERISK_THREADPOOL_H
#define _ASTERISK_THREADPOOL_H
struct ast_threadpool;
struct ast_taskprocessor;
struct ast_threadpool_listener;
struct ast_threadpool_listener_callbacks {
/*!
* \brief Indicates that the state of threads in the pool has changed
*
* \param listener The threadpool listener
* \param active_threads The number of active threads in the pool
* \param idle_threads The number of idle threads in the pool
*/
void (*state_changed)(struct ast_threadpool_listener *listener,
int active_threads,
int idle_threads);
/*!
* \brief Indicates that a task was pushed to the threadpool's taskprocessor
*
* \param listener The threadpool listener
* \param was_empty Indicates whether the taskprocessor was empty prior to adding the task
*/
void (*tps_task_pushed)(struct ast_threadpool_listener *listener,
int was_empty);
/*!
* \brief Indicates the threadpoo's taskprocessor has become empty
*
* \param listener The threadpool's listener
*/
void (*emptied)(struct ast_threadpool_listener *listener);
};
/*!
* \brief listener for a threadpool
*
* The listener is notified of changes in a threadpool. It can
* react by doing things like increasing the number of threads
* in the pool
*/
struct ast_threadpool_listener {
/*! Callbacks called by the threadpool */
struct ast_threadpool_listener_callbacks *callbacks;
/*! Handle to the threadpool */
struct ast_threadpool *threadpool;
/*! User data for the listener */
void *private_data;
};
/*!
* \brief Create a new threadpool
*
* This function creates a threadpool. Tasks may be pushed onto this thread pool
* in and will be automatically acted upon by threads within the pool.
*
* \param listener The listener the threadpool will notify of changes
* \param initial_size The number of threads for the pool to start with
* \retval NULL Failed to create the threadpool
* \retval non-NULL The newly-created threadpool
*/
struct ast_threadpool *ast_threadpool_create(struct ast_threadpool_listener *listener, int initial_size);
/*!
* \brief Set the number of threads for the thread pool
*
* This number may be more or less than the current number of
* threads in the threadpool.
*
* \param threadpool The threadpool to adjust
* \param size The new desired size of the threadpool
*/
void ast_threadpool_set_size(struct ast_threadpool *threadpool, unsigned int size);
/*!
* \brief Push a task to the threadpool
*
* Tasks pushed into the threadpool will be automatically taken by
* one of the threads within
* \param pool The threadpool to add the task to
* \param task The task to add
* \param data The parameter for the task
* \retval 0 success
* \retval -1 failure
*/
int ast_threadpool_push(struct ast_threadpool *pool, int (*task)(void *data), void *data);
/*!
* \brief Shut down a threadpool and destroy it
*
* \param pool The pool to shut down
*/
void ast_threadpool_shutdown(struct ast_threadpool *pool);
#endif /* ASTERISK_THREADPOOL_H */
|
