6929b8fb45b8b56faeea0ea03c860891c44d14bd
[asterisk/asterisk.git] / include / asterisk / taskprocessor.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2008, Dwayne M. Hubbard 
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 #include "asterisk.h"
19 #include "asterisk/lock.h"
20 #include "asterisk/linkedlists.h"
21 #include "asterisk/utils.h"
22 #include "asterisk/options.h"
23
24 #ifndef __taskprocessor_h__
25 #define __taskprocessor_h__
26
27 /*!
28  * \file taskprocessor.h
29  * \brief An API for managing task processing threads that can be shared across modules
30  *
31  * \author Dwayne M. Hubbard <dhubbard@digium.com>
32  *
33  * \note A taskprocessor is a named singleton containing a processing thread and
34  * a task queue that serializes tasks pushed into it by [a] module(s) that reference the taskprocessor.  
35  * A taskprocessor is created the first time its name is requested via the ast_taskprocessor_get()
36  * function and destroyed when the taskprocessor reference count reaches zero.
37  *
38  * Modules that obtain a reference to a taskprocessor can queue tasks into the taskprocessor
39  * to be processed by the singleton processing thread when the task is popped off the front 
40  * of the queue.  A task is a wrapper around a task-handling function pointer and a data
41  * pointer.  It is the responsibility of the task handling function to free memory allocated for
42  * the task data pointer.  A task is pushed into a taskprocessor queue using the 
43  * ast_taskprocessor_push(taskprocessor, taskhandler, taskdata) function and freed by the
44  * taskprocessor after the task handling function returns.  A module releases its reference to a
45  * taskprocessor using the ast_taskprocessor_unreference() function which may result in the
46  * destruction of the taskprocessor if the taskprocessor's reference count reaches zero.  Tasks waiting
47  * to be processed in the taskprocessor queue when the taskprocessor reference count reaches zero
48  * will be purged and released from the taskprocessor queue without being processed.
49  */
50 struct ast_taskprocessor;
51
52 /*! \brief ast_tps_options for specification of taskprocessor options
53  *
54  * Specify whether a taskprocessor should be created via ast_taskprocessor_get() if the taskprocessor 
55  * does not already exist.  The default behavior is to create a taskprocessor if it does not already exist 
56  * and provide its reference to the calling function.  To only return a reference to a taskprocessor if 
57  * and only if it exists, use the TPS_REF_IF_EXISTS option in ast_taskprocessor_get(). */
58 enum ast_tps_options {
59         /*! \brief return a reference to a taskprocessor, create one if it does not exist */
60         TPS_REF_DEFAULT = 0,
61         /*! \brief return a reference to a taskprocessor ONLY if it already exists */
62         TPS_REF_IF_EXISTS = (1 << 0),
63 };
64
65 /*! \brief Get a reference to a taskprocessor with the specified name and create the taskprocessor if necessary
66  *
67  * The default behavior of instantiating a taskprocessor if one does not already exist can be
68  * disabled by specifying the TPS_REF_IF_EXISTS ast_tps_options as the second argument to ast_taskprocessor_get().
69  * \param name The name of the taskprocessor
70  * \param create Use 0 by default or specify TPS_REF_IF_EXISTS to return NULL if the taskprocessor does 
71  * not already exist
72  * return A pointer to a reference counted taskprocessor under normal conditions, or NULL if the
73  * TPS_REF_IF_EXISTS reference type is specified and the taskprocessor does not exist
74  * \since 1.6.1
75  */
76 struct ast_taskprocessor *ast_taskprocessor_get(char *name, enum ast_tps_options create);
77
78 /*! \brief Unreference the specified taskprocessor and its reference count will decrement.
79  *
80  * Taskprocessors use astobj2 and will unlink from the taskprocessor singleton container and destroy
81  * themself when the taskprocessor reference count reaches zero.
82  * \param tps taskprocessor to unreference
83  * \return NULL
84  * \since 1.6.1
85  */
86 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps);
87
88 /*! \brief Push a task into the specified taskprocessor queue and signal the taskprocessor thread
89  * \param tps The taskprocessor structure
90  * \param task_exe The task handling function to push into the taskprocessor queue
91  * \param datap The data to be used by the task handling function
92  * \return zero on success, -1 on failure
93  * \since 1.6.1
94  */
95 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap);
96
97 /*! \brief Return the name of the taskprocessor singleton
98  * \since 1.6.1
99  */
100 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps);
101 #endif
102