a26cf4341533327c7a0dad7aa3e8598a40d94a82
[asterisk/asterisk.git] / include / asterisk / taskprocessor.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2013, 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 object 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 The taskprocessor has started completely
79          *
80          * This indicates that the taskprocessor is fully set up and the listener
81          * can now start interacting with it.
82          *
83          * \param listener The listener to start
84          */
85         int (*start)(struct ast_taskprocessor_listener *listener);
86         /*!
87          * \brief Indicates a task was pushed to the processor
88          *
89          * \param listener The listener
90          * \param was_empty If non-zero, the taskprocessor was empty prior to the task being pushed
91          */
92         void (*task_pushed)(struct ast_taskprocessor_listener *listener, int was_empty);
93         /*!
94          * \brief Indicates the task processor has become empty
95          *
96          * \param listener The listener
97          */
98         void (*emptied)(struct ast_taskprocessor_listener *listener);
99         /*!
100          * \brief Indicates the taskprocessor wishes to die.
101          *
102          * All operations on the task processor must to be stopped in
103          * this callback. This is an opportune time to free the listener's
104          * user data if it is not going to be used anywhere else.
105          *
106          * After this callback returns, it is NOT safe to operate on the
107          * listener's reference to the taskprocessor.
108          *
109          * \param listener The listener
110          */
111         void (*shutdown)(struct ast_taskprocessor_listener *listener);
112 };
113
114 struct ast_taskprocessor *ast_taskprocessor_listener_get_tps(const struct ast_taskprocessor_listener *listener);
115 void *ast_taskprocessor_listener_get_user_data(const struct ast_taskprocessor_listener *listener);
116
117 /*!
118  * \brief Allocate a taskprocessor listener
119  *
120  * \since 12.0.0
121  *
122  * This will result in the listener being allocated with the specified
123  * callbacks.
124  *
125  * \param callbacks The callbacks to assign to the listener
126  * \param user_data The user data for the listener
127  * \retval NULL Failure
128  * \retval non-NULL The newly allocated taskprocessor listener
129  */
130 struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct ast_taskprocessor_listener_callbacks *callbacks, void *user_data);
131
132 /*!
133  * \brief Get a reference to a taskprocessor with the specified name and create the taskprocessor if necessary
134  *
135  * The default behavior of instantiating a taskprocessor if one does not already exist can be
136  * disabled by specifying the TPS_REF_IF_EXISTS ast_tps_options as the second argument to ast_taskprocessor_get().
137  * \param name The name of the taskprocessor
138  * \param create Use 0 by default or specify TPS_REF_IF_EXISTS to return NULL if the taskprocessor does
139  * not already exist
140  * return A pointer to a reference counted taskprocessor under normal conditions, or NULL if the
141  * TPS_REF_IF_EXISTS reference type is specified and the taskprocessor does not exist
142  * \since 1.6.1
143  */
144 struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_options create);
145
146 /*!
147  * \brief Create a taskprocessor with a custom listener
148  *
149  * \since 12.0.0
150  *
151  * The listener's alloc() and start() callbacks will be called during this function.
152  *
153  * \param name The name of the taskprocessor to create
154  * \param listener The listener for operations on this taskprocessor
155  * \retval NULL Failure
156  * \reval non-NULL success
157  */
158 struct ast_taskprocessor *ast_taskprocessor_create_with_listener(const char *name, struct ast_taskprocessor_listener *listener);
159
160 /*!
161  * \brief Unreference the specified taskprocessor and its reference count will decrement.
162  *
163  * Taskprocessors use astobj2 and will unlink from the taskprocessor singleton container and destroy
164  * themself when the taskprocessor reference count reaches zero.
165  * \param tps taskprocessor to unreference
166  * \return NULL
167  * \since 1.6.1
168  */
169 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps);
170
171 /*!
172  * \brief Push a task into the specified taskprocessor queue and signal the taskprocessor thread
173  * \param tps The taskprocessor structure
174  * \param task_exe The task handling function to push into the taskprocessor queue
175  * \param datap The data to be used by the task handling function
176  * \retval 0 success
177  * \retval -1 failure
178  * \since 1.6.1
179  */
180 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap);
181
182 /*!
183  * \brief Pop a task off the taskprocessor and execute it.
184  *
185  * \since 12.0.0
186  *
187  * \param tps The taskprocessor from which to execute.
188  * \retval 0 There is no further work to be done.
189  * \retval 1 Tasks still remain in the taskprocessor queue.
190  */
191 int ast_taskprocessor_execute(struct ast_taskprocessor *tps);
192
193 /*!
194  * \brief Return the name of the taskprocessor singleton
195  * \since 1.6.1
196  */
197 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps);
198
199 #endif /* __AST_TASKPROCESSOR_H__ */