1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
Unix SMB/CIFS implementation.
Infrastructure for async requests
Copyright (C) Volker Lendecke 2008
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __ASYNC_REQ_H__
#define __ASYNC_REQ_H__
#include "includes.h"
/*
* An async request moves between the following 4 states.
*/
enum async_req_state {
ASYNC_REQ_INIT, /* we are creating the request */
ASYNC_REQ_IN_PROGRESS, /* we are waiting the request to complete */
ASYNC_REQ_DONE, /* the request is finished */
ASYNC_REQ_ERROR }; /* an error has occured */
struct async_req {
/* the external state - will be queried by the caller */
enum async_req_state state;
/* a private pointer for use by the async function implementation */
void *private_data;
/* print yourself, for debugging purposes */
char *(*print)(TALLOC_CTX *mem_ctx, struct async_req *);
/* status code when finished */
NTSTATUS status;
/* the event context we are using */
struct event_context *event_ctx;
/* information on what to do on completion */
struct {
void (*fn)(struct async_req *);
void *priv;
} async;
};
/*
* Print an async_req structure for debugging purposes
*/
char *async_req_print(TALLOC_CTX *mem_ctx, struct async_req *req);
/*
* Create an async request
*/
struct async_req *async_req_new(TALLOC_CTX *mem_ctx, struct event_context *ev);
/*
* An async request has successfully finished, invoke the callback
*/
void async_req_done(struct async_req *req);
/*
* An async request has seen an error, invoke the callback
*/
void async_req_error(struct async_req *req, NTSTATUS status);
/*
* Convenience helper to easily check alloc failure within a callback.
*
* Call pattern would be
* p = talloc(mem_ctx, bla);
* if (async_req_nomem(p, req)) {
* return;
* }
*
*/
bool async_req_nomem(const void *p, struct async_req *req);
#endif
|