4f61939f873188ebd08c8363b10d251ff1923d39
[asterisk/asterisk.git] / include / asterisk / taskprocessor.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2008, Digium, Inc.
5  *
6  * Dwayne M. Hubbard <dhubbard@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  * \file taskprocessor.h
21  * \brief An API for managing task processing threads that can be shared across modules
22  *
23  * \author Dwayne M. Hubbard <dhubbard@digium.com>
24  *
25  * \note A taskprocessor is a named singleton containing a task queue that
26  * serializes tasks pushed into it by [a] module(s) that reference the taskprocessor.
27  * A taskprocessor is created the first time its name is requested via the
28  * ast_taskprocessor_get() function or the ast_taskprocessor_create_with_listener()
29  * function and destroyed when the taskprocessor reference count reaches zero. A
30  * taskprocessor also contains an accompanying listener that is notified when changes
31  * in the task queue occur.
32  *
33  * A task is a wrapper around a task-handling function pointer and a data
34  * pointer.  A task is pushed into a taskprocessor queue using the
35  * ast_taskprocessor_push(taskprocessor, taskhandler, taskdata) function and freed by the
36  * taskprocessor after the task handling function returns.  A module releases its
37  * reference to a taskprocessor using the ast_taskprocessor_unreference() function which
38  * may result in the destruction of the taskprocessor if the taskprocessor's reference
39  * count reaches zero. When the taskprocessor's reference count reaches zero, its
40  * listener's shutdown() callback will be called. Any further attempts to execute tasks
41  * will be denied.
42  *
43  * The taskprocessor listener has the flexibility of doling out tasks to best fit the
44  * module's needs. For instance, a taskprocessor listener may have a single dispatch
45  * thread that handles all tasks, or it may dispatch tasks to a thread pool.
46  *
47  * There is a default taskprocessor listener that will be used if a taskprocessor is
48  * created without any explicit listener. This default listener runs tasks sequentially
49  * in a single thread. The listener will execute tasks as long as there are tasks to be
50  * processed. When the taskprocessor is shut down, the default listener will stop
51  * processing tasks and join its execution thread.
52  */
53
54 #ifndef __AST_TASKPROCESSOR_H__
55 #define __AST_TASKPROCESSOR_H__
56
57 struct ast_taskprocessor;
58
59 /*!
60  * \brief ast_tps_options for specification of taskprocessor options
61  *
62  * Specify whether a taskprocessor should be created via ast_taskprocessor_get() if the taskprocessor
63  * does not already exist.  The default behavior is to create a taskprocessor if it does not already exist
64  * and provide its reference to the calling function.  To only return a reference to a taskprocessor if
65  * and only if it exists, use the TPS_REF_IF_EXISTS option in ast_taskprocessor_get().
66  */
67 enum ast_tps_options {
68         /*! \brief return a reference to a taskprocessor, create one if it does not exist */
69         TPS_REF_DEFAULT = 0,
70         /*! \brief return a reference to a taskprocessor ONLY if it already exists */
71         TPS_REF_IF_EXISTS = (1 << 0),
72 };
73
74 struct ast_taskprocessor_listener;
75
76 struct ast_taskprocessor_listener_callbacks {
77         /*!
78          * \brief Allocate the listener's private data
79          *
80          * It is not necessary to assign the private data to the listener.
81          *
82          * \param listener The listener to which the private data belongs
83          * \retval NULL Error while attempting to initialize private data
84          * \retval non-NULL Allocated private data
85          */
86         void *(*alloc)(struct ast_taskprocessor_listener *listener);
87         /*!
88          * \brief The taskprocessor has started completely
89          *
90          * This indicates that the taskprocessor is fully set up and the listener
91          * can now start interacting with it.
92          *
93          * \param listener The listener to start
94          */
95         int (*start)(struct ast_taskprocessor_listener *listener);
96         /*!
97          * \brief Indicates a task was pushed to the processor
98          *
99          * \param listener The listener
100          * \param was_empty If non-zero, the taskprocessor was empty prior to the task being pushed
101          */
102         void (*task_pushed)(struct ast_taskprocessor_listener *listener, int was_empty);
103         /*!
104          * \brief Indicates the task processor has become empty
105          *
106          * \param listener The listener
107          */
108         void (*emptied)(struct ast_taskprocessor_listener *listener);
109         /*!
110          * \brief Indicates the taskprocessor wishes to die.
111          *
112          * All operations on the task processor must to be stopped in
113          * this callback.
114          *
115          * After this callback returns, it is NOT safe to operate on the
116          * listener's reference to the taskprocessor.
117          *
118          * \param listener The listener
119          */
120         void (*shutdown)(struct ast_taskprocessor_listener *listener);
121         /*!
122          * \brief Destroy the listener's private data
123          *
124          * It is required that you free the private data in this callback
125          * in addition to the private data's individual fields.
126          *
127          * \param private_data The listener's private data
128          */
129         void (*destroy)(void *private_data);
130 };
131
132 /*!
133  * \brief A listener for taskprocessors
134  *
135  * When a taskprocessor's state changes, the listener
136  * is notified of the change. This allows for tasks
137  * to be addressed in whatever way is appropriate for
138  * the module using the taskprocessor.
139  */
140 struct ast_taskprocessor_listener {
141         /*! The callbacks the taskprocessor calls into to notify of state changes */
142         const struct ast_taskprocessor_listener_callbacks *callbacks;
143         /*! The taskprocessor that the listener is listening to */
144         struct ast_taskprocessor *tps;
145         /*! Data private to the listener */
146         void *private_data;
147 };
148
149 /*!
150  * Allocate a taskprocessor listener
151  *
152  * This will result in the listener being allocated with the specified
153  * callbacks. The listener's alloc() callback will be called to allocate
154  * private data for the listener. The private data will be assigned to the
155  * listener when the listener's alloc() function returns.
156  *
157  * \param callbacks The callbacks to assign to the listener
158  * \retval NULL Failure
159  * \retval non-NULL The newly allocated taskprocessor listener
160  */
161 struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct ast_taskprocessor_listener_callbacks *callbacks);
162
163 /*!
164  * \brief Get a reference to a taskprocessor with the specified name and create the taskprocessor if necessary
165  *
166  * The default behavior of instantiating a taskprocessor if one does not already exist can be
167  * disabled by specifying the TPS_REF_IF_EXISTS ast_tps_options as the second argument to ast_taskprocessor_get().
168  * \param name The name of the taskprocessor
169  * \param create Use 0 by default or specify TPS_REF_IF_EXISTS to return NULL if the taskprocessor does
170  * not already exist
171  * return A pointer to a reference counted taskprocessor under normal conditions, or NULL if the
172  * TPS_REF_IF_EXISTS reference type is specified and the taskprocessor does not exist
173  * \since 1.6.1
174  */
175 struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_options create);
176
177 /*!
178  * \brief Create a taskprocessor with a custom listener
179  *
180  * \param name The name of the taskprocessor to create
181  * \param listener The listener for operations on this taskprocessor
182  * \retval NULL Failure
183  * \reval non-NULL success
184  */
185 struct ast_taskprocessor *ast_taskprocessor_create_with_listener(const char *name, struct ast_taskprocessor_listener *listener);
186
187 /*!
188  * \brief Unreference the specified taskprocessor and its reference count will decrement.
189  *
190  * Taskprocessors use astobj2 and will unlink from the taskprocessor singleton container and destroy
191  * themself when the taskprocessor reference count reaches zero.
192  * \param tps taskprocessor to unreference
193  * \return NULL
194  * \since 1.6.1
195  */
196 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps);
197
198 /*!
199  * \brief Push a task into the specified taskprocessor queue and signal the taskprocessor thread
200  * \param tps The taskprocessor structure
201  * \param task_exe The task handling function to push into the taskprocessor queue
202  * \param datap The data to be used by the task handling function
203  * \retval 0 success
204  * \retval -1 failure
205  * \since 1.6.1
206  */
207 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap);
208
209 /*!
210  * \brief Pop a task off the taskprocessor and execute it.
211  * \param tps The taskprocessor from which to execute.
212  * \retval 0 There is no further work to be done.
213  * \retval 1 Tasks still remain in the taskprocessor queue.
214  */
215 int ast_taskprocessor_execute(struct ast_taskprocessor *tps);
216
217 /*!
218  * \brief Return the name of the taskprocessor singleton
219  * \since 1.6.1
220  */
221 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps);
222
223 #endif /* __AST_TASKPROCESSOR_H__ */