2 Unix SMB/CIFS implementation.
3 Infrastructure for async requests
4 Copyright (C) Volker Lendecke 2008
5 Copyright (C) Stefan Metzmacher 2009
7 ** NOTE! The following LGPL license applies to the tevent
8 ** library. This does NOT imply that all of Samba is released
11 This library is free software; you can redistribute it and/or
12 modify it under the terms of the GNU Lesser General Public
13 License as published by the Free Software Foundation; either
14 version 3 of the License, or (at your option) any later version.
16 This library is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public
22 License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 #include "tevent_internal.h"
28 #include "tevent_util.h"
30 struct tevent_queue_entry {
31 struct tevent_queue_entry *prev, *next;
32 struct tevent_queue *queue;
36 struct tevent_req *req;
37 struct tevent_context *ev;
39 tevent_queue_trigger_fn_t trigger;
48 struct tevent_immediate *immediate;
51 struct tevent_queue_entry *list;
54 static void tevent_queue_immediate_trigger(struct tevent_context *ev,
55 struct tevent_immediate *im,
58 static int tevent_queue_entry_destructor(struct tevent_queue_entry *e)
60 struct tevent_queue *q = e->queue;
66 DLIST_REMOVE(q->list, e);
77 if (q->list->triggered) {
81 tevent_schedule_immediate(q->immediate,
83 tevent_queue_immediate_trigger,
89 static int tevent_queue_destructor(struct tevent_queue *q)
94 struct tevent_queue_entry *e = q->list;
101 struct tevent_queue *_tevent_queue_create(TALLOC_CTX *mem_ctx,
103 const char *location)
105 struct tevent_queue *queue;
107 queue = talloc_zero(mem_ctx, struct tevent_queue);
112 queue->name = talloc_strdup(queue, name);
117 queue->immediate = tevent_create_immediate(queue);
118 if (!queue->immediate) {
123 queue->location = location;
125 /* queue is running by default */
126 queue->running = true;
128 talloc_set_destructor(queue, tevent_queue_destructor);
132 static void tevent_queue_immediate_trigger(struct tevent_context *ev,
133 struct tevent_immediate *im,
136 struct tevent_queue *q = talloc_get_type(private_data,
137 struct tevent_queue);
143 q->list->triggered = true;
144 q->list->trigger(q->list->req, q->list->private_data);
147 static struct tevent_queue_entry *tevent_queue_add_internal(
148 struct tevent_queue *queue,
149 struct tevent_context *ev,
150 struct tevent_req *req,
151 tevent_queue_trigger_fn_t trigger,
155 struct tevent_queue_entry *e;
157 e = talloc_zero(req, struct tevent_queue_entry);
165 e->trigger = trigger;
166 e->private_data = private_data;
169 * if there is no trigger, it is just a blocker
171 if (trigger == NULL) {
175 if (queue->length > 0) {
177 * if there are already entries in the
178 * queue do not optimize.
180 allow_direct = false;
183 if (req->async.fn != NULL) {
185 * If the callers wants to optimize for the
186 * empty queue case, call the trigger only
187 * if there is no callback defined for the
190 allow_direct = false;
193 DLIST_ADD_END(queue->list, e, struct tevent_queue_entry *);
195 talloc_set_destructor(e, tevent_queue_entry_destructor);
197 if (!queue->running) {
201 if (queue->list->triggered) {
206 * If allowed we directly call the trigger
207 * avoiding possible delays caused by
208 * an immediate event.
211 queue->list->triggered = true;
212 queue->list->trigger(queue->list->req,
213 queue->list->private_data);
217 tevent_schedule_immediate(queue->immediate,
219 tevent_queue_immediate_trigger,
225 bool tevent_queue_add(struct tevent_queue *queue,
226 struct tevent_context *ev,
227 struct tevent_req *req,
228 tevent_queue_trigger_fn_t trigger,
231 struct tevent_queue_entry *e;
233 e = tevent_queue_add_internal(queue, ev, req,
234 trigger, private_data, false);
242 struct tevent_queue_entry *tevent_queue_add_entry(
243 struct tevent_queue *queue,
244 struct tevent_context *ev,
245 struct tevent_req *req,
246 tevent_queue_trigger_fn_t trigger,
249 return tevent_queue_add_internal(queue, ev, req,
250 trigger, private_data, false);
253 struct tevent_queue_entry *tevent_queue_add_optimize_empty(
254 struct tevent_queue *queue,
255 struct tevent_context *ev,
256 struct tevent_req *req,
257 tevent_queue_trigger_fn_t trigger,
260 return tevent_queue_add_internal(queue, ev, req,
261 trigger, private_data, true);
264 void tevent_queue_start(struct tevent_queue *queue)
266 if (queue->running) {
267 /* already started */
271 queue->running = true;
277 if (queue->list->triggered) {
281 tevent_schedule_immediate(queue->immediate,
283 tevent_queue_immediate_trigger,
287 void tevent_queue_stop(struct tevent_queue *queue)
289 queue->running = false;
292 size_t tevent_queue_length(struct tevent_queue *queue)
294 return queue->length;
297 bool tevent_queue_running(struct tevent_queue *queue)
299 return queue->running;