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 char *tevent_req_default_print(struct tevent_req *req, TALLOC_CTX *mem_ctx)
32 return talloc_asprintf(mem_ctx,
33 "tevent_req[%p/%s]: state[%d] error[%lld (0x%llX)] "
34 " state[%s (%p)] timer[%p]",
35 req, req->internal.create_location,
37 (unsigned long long)req->internal.error,
38 (unsigned long long)req->internal.error,
39 talloc_get_name(req->data),
45 char *tevent_req_print(TALLOC_CTX *mem_ctx, struct tevent_req *req)
47 if (!req->private_print) {
48 return tevent_req_default_print(req, mem_ctx);
51 return req->private_print(req, mem_ctx);
54 struct tevent_req *_tevent_req_create(TALLOC_CTX *mem_ctx,
60 struct tevent_req *req;
61 void **ppdata = (void **)pdata;
64 req = talloc_zero(mem_ctx, struct tevent_req);
68 req->internal.private_type = type;
69 req->internal.create_location = location;
70 req->internal.finish_location = NULL;
71 req->internal.state = TEVENT_REQ_IN_PROGRESS;
72 req->internal.trigger = tevent_create_immediate(req);
73 if (!req->internal.trigger) {
77 req->internal.defer_callback_ev = NULL;
79 data = talloc_zero_size(req, data_size);
84 talloc_set_name_const(data, type);
92 void _tevent_req_notify_callback(struct tevent_req *req, const char *location)
94 req->internal.finish_location = location;
95 if (req->internal.defer_callback_ev) {
96 (void)tevent_req_post(req, req->internal.defer_callback_ev);
97 req->internal.defer_callback_ev = NULL;
100 if (req->async.fn != NULL) {
105 static void tevent_req_finish(struct tevent_req *req,
106 enum tevent_req_state state,
107 const char *location)
109 req->internal.state = state;
110 _tevent_req_notify_callback(req, location);
113 void _tevent_req_done(struct tevent_req *req,
114 const char *location)
116 tevent_req_finish(req, TEVENT_REQ_DONE, location);
119 bool _tevent_req_error(struct tevent_req *req,
121 const char *location)
127 req->internal.error = error;
128 tevent_req_finish(req, TEVENT_REQ_USER_ERROR, location);
132 void _tevent_req_oom(struct tevent_req *req, const char *location)
134 tevent_req_finish(req, TEVENT_REQ_NO_MEMORY, location);
137 bool _tevent_req_nomem(const void *p,
138 struct tevent_req *req,
139 const char *location)
144 _tevent_req_oom(req, location);
151 * @brief Immediate event callback.
153 * @param[in] ev The event context to use.
155 * @param[in] im The immediate event.
157 * @param[in] priv The async request to be finished.
159 static void tevent_req_trigger(struct tevent_context *ev,
160 struct tevent_immediate *im,
163 struct tevent_req *req = talloc_get_type(private_data,
166 tevent_req_finish(req, req->internal.state,
167 req->internal.finish_location);
170 struct tevent_req *tevent_req_post(struct tevent_req *req,
171 struct tevent_context *ev)
173 tevent_schedule_immediate(req->internal.trigger,
174 ev, tevent_req_trigger, req);
178 void tevent_req_defer_callback(struct tevent_req *req,
179 struct tevent_context *ev)
181 req->internal.defer_callback_ev = ev;
184 bool tevent_req_is_in_progress(struct tevent_req *req)
186 if (req->internal.state == TEVENT_REQ_IN_PROGRESS) {
193 void tevent_req_received(struct tevent_req *req)
195 TALLOC_FREE(req->data);
196 req->private_print = NULL;
198 TALLOC_FREE(req->internal.trigger);
199 TALLOC_FREE(req->internal.timer);
201 req->internal.state = TEVENT_REQ_RECEIVED;
204 bool tevent_req_poll(struct tevent_req *req,
205 struct tevent_context *ev)
207 while (tevent_req_is_in_progress(req)) {
210 ret = tevent_loop_once(ev);
219 bool tevent_req_is_error(struct tevent_req *req, enum tevent_req_state *state,
222 if (req->internal.state == TEVENT_REQ_DONE) {
225 if (req->internal.state == TEVENT_REQ_USER_ERROR) {
226 *error = req->internal.error;
228 *state = req->internal.state;
232 static void tevent_req_timedout(struct tevent_context *ev,
233 struct tevent_timer *te,
237 struct tevent_req *req = talloc_get_type(private_data,
240 TALLOC_FREE(req->internal.timer);
242 tevent_req_finish(req, TEVENT_REQ_TIMED_OUT, __FUNCTION__);
245 bool tevent_req_set_endtime(struct tevent_req *req,
246 struct tevent_context *ev,
247 struct timeval endtime)
249 TALLOC_FREE(req->internal.timer);
251 req->internal.timer = tevent_add_timer(ev, req, endtime,
254 if (tevent_req_nomem(req->internal.timer, req)) {
261 void tevent_req_set_callback(struct tevent_req *req, tevent_req_fn fn, void *pvt)
264 req->async.private_data = pvt;
267 void *_tevent_req_callback_data(struct tevent_req *req)
269 return req->async.private_data;
272 void *_tevent_req_data(struct tevent_req *req)
277 void tevent_req_set_print_fn(struct tevent_req *req, tevent_req_print_fn fn)
279 req->private_print = fn;
282 void tevent_req_set_cancel_fn(struct tevent_req *req, tevent_req_cancel_fn fn)
284 req->private_cancel = fn;
287 bool _tevent_req_cancel(struct tevent_req *req, const char *location)
289 if (req->private_cancel == NULL) {
293 return req->private_cancel(req);