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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*
This file is part of GNUnet.
Copyright (C) 2016 GNUnet e.V.
GNUnet 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, or (at your
option) any later version.
GNUnet 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 GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file
* Asynchronous operations; register callbacks for operations and call them when a response arrives.
*
* @author Gabor X Toth
*/
#ifndef GNUNET_OP_H
#define GNUNET_OP_H
#include "gnunet_util_lib.h"
/**
* Operations handle.
*/
struct GNUNET_OP_Handle;
/**
* Create new operations handle.
*/
struct GNUNET_OP_Handle *
GNUNET_OP_create ();
/**
* Destroy operations handle.
*/
void
GNUNET_OP_destroy (struct GNUNET_OP_Handle *h);
/**
* Get a unique operation ID to distinguish between asynchronous requests.
*
* @param h
* Operations handle.
*
* @return Operation ID to use.
*/
uint64_t
GNUNET_OP_get_next_id (struct GNUNET_OP_Handle *h);
/**
* Find operation by ID.
*
* @param h
* Operations handle.
* @param op_id
* Operation ID to look up.
* @param[out] result_cb
* If an operation was found, its result callback is returned here.
* @param[out] cls
* If an operation was found, its closure is returned here.
* @param[out] ctx
* User context.
*
* @return #GNUNET_YES if an operation was found,
* #GNUNET_NO if not found.
*/
int
GNUNET_OP_get (struct GNUNET_OP_Handle *h,
uint64_t op_id,
GNUNET_ResultCallback *result_cb,
void **cls,
void **ctx);
/**
* Add a new operation.
*
* @param h
* Operations handle.
* @param result_cb
* Function to call with the result of the operation.
* @param cls
* Closure for @a result_cb.
* @param ctx
* User context.
*
* @return ID of the new operation.
*/
uint64_t
GNUNET_OP_add (struct GNUNET_OP_Handle *h,
GNUNET_ResultCallback result_cb,
void *cls,
void *ctx);
/**
* Call the result callback of an operation and remove it.
*
* @param h
* Operations handle.
* @param op_id
* Operation ID.
* @param result_code
* Result of the operation.
* @param data
* Data result of the operation.
* @param data_size
* Size of @a data.
* @param[out] ctx
* User context.
*
* @return #GNUNET_YES if the operation was found and removed,
* #GNUNET_NO if the operation was not found.
*/
int
GNUNET_OP_result (struct GNUNET_OP_Handle *h,
uint64_t op_id,
int64_t result_code,
const void *data,
uint16_t data_size,
void **ctx);
/**
* Remove / cancel an operation.
*
* @param h
* Operations handle.
* @param op_id
* Operation ID.
*
* @return #GNUNET_YES if the operation was found and removed,
* #GNUNET_NO if the operation was not found.
*/
int
GNUNET_OP_remove (struct GNUNET_OP_Handle *h,
uint64_t op_id);
#endif // GNUNET_OP_H
|
