28a14b847318fc0a1c47700e1a58a15fb5dd60c5
[asterisk/asterisk.git] / include / asterisk / sched.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 /*! \file
20  * \brief Scheduler Routines (derived from cheops)
21  */
22
23 #ifndef _ASTERISK_SCHED_H
24 #define _ASTERISK_SCHED_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 /*! \brief Max num of schedule structs
31  * \note The max number of schedule structs to keep around
32  * for use.  Undefine to disable schedule structure
33  * caching. (Only disable this on very low memory
34  * machines)
35  */
36 #define SCHED_MAX_CACHE 128
37
38 #define AST_SCHED_DEL(sched, id) \
39         do { \
40                 int _count = 0; \
41                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
42                         usleep(1); \
43                 } \
44                 if (_count == 10) \
45                         ast_log(LOG_DEBUG, "Unable to cancel schedule ID %d.  This is probably a bug (%s: %s, line %d).\n", id, __FILE__, __PRETTY_FUNCTION__, __LINE__); \
46                 id = -1; \
47         } while (0);
48
49 #define AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, variable) \
50         do { \
51                 int _count = 0; \
52                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
53                         usleep(1); \
54                 } \
55                 if (_count == 10) \
56                         ast_log(LOG_WARNING, "Unable to cancel schedule ID %d.  This is probably a bug (%s: %s, line %d).\n", id, __FILE__, __PRETTY_FUNCTION__, __LINE__); \
57                 id = ast_sched_add_variable(sched, when, callback, data, variable); \
58         } while (0);
59
60 #define AST_SCHED_REPLACE(id, sched, when, callback, data) \
61                 AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, 0)
62
63 struct sched_context;
64
65 /*! \brief New schedule context
66  * \note Create a scheduling context
67  * \return Returns a malloc'd sched_context structure, NULL on failure
68  */
69 struct sched_context *sched_context_create(void);
70
71 /*! \brief destroys a schedule context
72  * Destroys (free's) the given sched_context structure
73  * \param c Context to free
74  * \return Returns 0 on success, -1 on failure
75  */
76 void sched_context_destroy(struct sched_context *c);
77
78 /*! \brief callback for a cheops scheduler
79  * A cheops scheduler callback takes a pointer with callback data and
80  * \return returns a 0 if it should not be run again, or non-zero if it should be
81  * rescheduled to run again
82  */
83 typedef int (*ast_sched_cb)(const void *data);
84 #define AST_SCHED_CB(a) ((ast_sched_cb)(a))
85
86 /*! \brief Adds a scheduled event
87  * Schedule an event to take place at some point in the future.  callback
88  * will be called with data as the argument, when milliseconds into the
89  * future (approximately)
90  * If callback returns 0, no further events will be re-scheduled
91  * \param con Scheduler context to add
92  * \param when how many milliseconds to wait for event to occur
93  * \param callback function to call when the amount of time expires
94  * \param data data to pass to the callback
95  * \return Returns a schedule item ID on success, -1 on failure
96  */
97 int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, const void *data);
98
99 /*!
100  * \brief replace a scheduler entry
101  * \deprecated You should use the AST_SCHED_REPLACE() macro instead.
102  *
103  * This deletes the scheduler entry for old_id if it exists, and then
104  * calls ast_sched_add to create a new entry.  A negative old_id will
105  * be ignored.
106  *
107  * \retval -1 failure
108  * \retval otherwise, returns scheduled item ID
109  */
110 int ast_sched_replace(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data);
111
112 /*!Adds a scheduled event with rescheduling support
113  * \param con Scheduler context to add
114  * \param when how many milliseconds to wait for event to occur
115  * \param callback function to call when the amount of time expires
116  * \param data data to pass to the callback
117  * \param variable If true, the result value of callback function will be
118  *       used for rescheduling
119  * Schedule an event to take place at some point in the future.  Callback
120  * will be called with data as the argument, when milliseconds into the
121  * future (approximately)
122  * If callback returns 0, no further events will be re-scheduled
123  * \return Returns a schedule item ID on success, -1 on failure
124  */
125 int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable);
126
127 /*!
128  * \brief replace a scheduler entry
129  * \deprecated You should use the AST_SCHED_REPLACE_VARIABLE() macro instead.
130  *
131  * This deletes the scheduler entry for old_id if it exists, and then
132  * calls ast_sched_add to create a new entry.  A negative old_id will
133  * be ignored.
134  *
135  * \retval -1 failure
136  * \retval otherwise, returns scheduled item ID
137  */
138 int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable);
139
140 /*! \brief Deletes a scheduled event
141  * Remove this event from being run.  A procedure should not remove its own
142  * event, but return 0 instead.  In most cases, you should not call this
143  * routine directly, but use the AST_SCHED_DEL() macro instead (especially if
144  * you don't intend to do something different when it returns failure).
145  * \param con scheduling context to delete item from
146  * \param id ID of the scheduled item to delete
147  * \return Returns 0 on success, -1 on failure
148  */
149 int ast_sched_del(struct sched_context *con, int id);
150
151 /*! \brief Determines number of seconds until the next outstanding event to take place
152  * Determine the number of seconds until the next outstanding event
153  * should take place, and return the number of milliseconds until
154  * it needs to be run.  This value is perfect for passing to the poll
155  * call.
156  * \param con context to act upon
157  * \return Returns "-1" if there is nothing there are no scheduled events
158  * (and thus the poll should not timeout)
159  */
160 int ast_sched_wait(struct sched_context *con);
161
162 /*! \brief Runs the queue
163  * \param con Scheduling context to run
164  * Run the queue, executing all callbacks which need to be performed
165  * at this time.
166  * \param con context to act upon
167  * \return Returns the number of events processed.
168  */
169 int ast_sched_runq(struct sched_context *con);
170
171 /*! \brief Dumps the scheduler contents
172  * Debugging: Dump the contents of the scheduler to stderr
173  * \param con Context to dump
174  */
175 void ast_sched_dump(const struct sched_context *con);
176
177 /*! \brief Returns the number of seconds before an event takes place
178  * \param con Context to use
179  * \param id Id to dump
180  */
181 long ast_sched_when(struct sched_context *con,int id);
182
183 /*!
184  * \brief Convenience macro for objects and reference (add)
185  *
186  */
187 #define ast_sched_add_object(obj,con,when,callback) ast_sched_add((con),(when),(callback), ASTOBJ_REF((obj)))
188
189 /*!
190  * \brief Convenience macro for objects and reference (del)
191  *
192  */
193 #define ast_sched_del_object(obj,destructor,con,id) do { \
194         if ((id) > -1) { \
195                 ast_sched_del((con),(id)); \
196                 (id) = -1; \
197                 ASTOBJ_UNREF((obj),(destructor)); \
198         } \
199 } while(0)
200
201 #if defined(__cplusplus) || defined(c_plusplus)
202 }
203 #endif
204
205 #endif /* _ASTERISK_SCHED_H */