Remove zombie state from threadpool altogether.
[asterisk/asterisk.git] / include / asterisk / threadpool.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Mark Michelson <mmmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19
20 #ifndef _ASTERISK_THREADPOOL_H
21 #define _ASTERISK_THREADPOOL_H
22
23 struct ast_threadpool;
24 struct ast_taskprocessor;
25 struct ast_threadpool_listener;
26
27 struct ast_threadpool_listener_callbacks {
28         /*!
29          * \brief Indicates that the state of threads in the pool has changed
30          *
31          * \param listener The threadpool listener
32          * \param active_threads The number of active threads in the pool
33          * \param idle_threads The number of idle threads in the pool
34          */
35         void (*state_changed)(struct ast_threadpool_listener *listener,
36                         int active_threads,
37                         int idle_threads);
38         /*!
39          * \brief Indicates that a task was pushed to the threadpool's taskprocessor
40          *
41          * \param listener The threadpool listener
42          * \param was_empty Indicates whether the taskprocessor was empty prior to adding the task
43          */
44         void (*tps_task_pushed)(struct ast_threadpool_listener *listener,
45                         int was_empty);
46         /*!
47          * \brief Indicates the threadpoo's taskprocessor has become empty
48          * 
49          * \param listener The threadpool's listener
50          */
51         void (*emptied)(struct ast_threadpool_listener *listener);
52 };
53
54 /*!
55  * \brief listener for a threadpool
56  *
57  * The listener is notified of changes in a threadpool. It can
58  * react by doing things like increasing the number of threads
59  * in the pool
60  */
61 struct ast_threadpool_listener {
62         /*! Callbacks called by the threadpool */
63         struct ast_threadpool_listener_callbacks *callbacks;
64         /*! Handle to the threadpool */
65         struct ast_threadpool *threadpool;
66         /*! User data for the listener */
67         void *private_data;
68 };
69
70 /*!
71  * \brief Create a new threadpool
72  *
73  * This function creates a threadpool. Tasks may be pushed onto this thread pool
74  * in and will be automatically acted upon by threads within the pool.
75  *
76  * \param listener The listener the threadpool will notify of changes
77  * \param initial_size The number of threads for the pool to start with
78  * \retval NULL Failed to create the threadpool
79  * \retval non-NULL The newly-created threadpool
80  */
81 struct ast_threadpool *ast_threadpool_create(struct ast_threadpool_listener *listener, int initial_size);
82
83 /*!
84  * \brief Set the number of threads for the thread pool
85  *
86  * This number may be more or less than the current number of
87  * threads in the threadpool.
88  * 
89  * \param threadpool The threadpool to adjust
90  * \param size The new desired size of the threadpool
91  */
92 void ast_threadpool_set_size(struct ast_threadpool *threadpool, unsigned int size);
93
94 /*!
95  * \brief Push a task to the threadpool
96  *
97  * Tasks pushed into the threadpool will be automatically taken by
98  * one of the threads within
99  * \param pool The threadpool to add the task to
100  * \param task The task to add
101  * \param data The parameter for the task
102  * \retval 0 success
103  * \retval -1 failure
104  */
105 int ast_threadpool_push(struct ast_threadpool *pool, int (*task)(void *data), void *data);
106
107 /*!
108  * \brief Shut down a threadpool and destroy it
109  *
110  * \param pool The pool to shut down
111  */
112 void ast_threadpool_shutdown(struct ast_threadpool *pool);
113 #endif /* ASTERISK_THREADPOOL_H */