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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
This file is part of GNUnet.
Copyright (C) 2013, 2014 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.
*/
/**
* @author Christian M. Fuchs
* @author Gaurav Kukreja
*
* @file
* API to the scalarproduct service
*
* @defgroup scalarproduct Scalar Product service
*
* @{
*/
#ifndef GNUNET_SCALARPRODUCT_SERVICE_H
#define GNUNET_SCALARPRODUCT_SERVICE_H
#define GCRYPT_NO_DEPRECATED
#include <gcrypt.h>
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Version of the scalarproduct API.
*/
#define GNUNET_SCALARPRODUCT_VERSION 0x00000044
/**
* Result status values for the computation.
*/
enum GNUNET_SCALARPRODUCT_ResponseStatus
{
/**
* Operation is still active (never returned, used internally).
*/
GNUNET_SCALARPRODUCT_STATUS_INIT = 0,
/**
* Operation is still active (never returned, used internally).
*/
GNUNET_SCALARPRODUCT_STATUS_ACTIVE = 1,
/**
* The computation was successful.
*/
GNUNET_SCALARPRODUCT_STATUS_SUCCESS,
/**
* We encountered some error.
*/
GNUNET_SCALARPRODUCT_STATUS_FAILURE,
/**
* We got an invalid response.
*/
GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE,
/**
* We got disconnected from the SCALARPRODUCT service.
*/
GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED
};
/**
* Opaque declaration of the SP-Handle
*/
struct GNUNET_SCALARPRODUCT_Handle;
GNUNET_NETWORK_STRUCT_BEGIN
/**
* An element key-value pair for scalarproduct
*/
struct GNUNET_SCALARPRODUCT_Element
{
/**
* Key used to identify matching pairs of values to multiply.
*/
struct GNUNET_HashCode key;
/**
* Value to multiply in scalar product, in NBO.
*/
int64_t value GNUNET_PACKED;
};
GNUNET_NETWORK_STRUCT_END
/**
* Continuation called to notify client about result of the
* operation.
*
* @param cls closure
* @param status Status of the request
*/
typedef void
(*GNUNET_SCALARPRODUCT_ContinuationWithStatus) (void *cls,
enum GNUNET_SCALARPRODUCT_ResponseStatus status);
/**
* Process a datum that was stored in the scalarproduct.
*
* @param cls closure
* @param status Status of the request
* @param result result of the computation
*/
typedef void
(*GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls,
enum GNUNET_SCALARPRODUCT_ResponseStatus status,
gcry_mpi_t result);
/**
* Entry in the request queue per client
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle;
/**
* Request by Alice's client for computing a scalar product
*
* @param cfg the gnunet configuration handle
* @param session_key Session key should be unique to the requesting client
* @param peer PeerID of the other peer
* @param elements Array of elements of the vector
* @param element_count Number of elements in the @a elements vector
* @param cont Callback function
* @param cont_cls Closure for the @a cont callback function
* @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_start_computation (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_HashCode *session_key,
const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_SCALARPRODUCT_Element *elements,
uint32_t element_count,
GNUNET_SCALARPRODUCT_DatumProcessor cont,
void *cont_cls);
/**
* Used by Bob's client to cooperate with Alice,
*
* @param cfg the gnunet configuration handle
* @param session_key Session key unique to the requesting client
* @param elements Array of elements of the vector
* @param element_count Number of elements in the @a elements vector
* @param cont Callback function
* @param cont_cls Closure for the @a cont callback function
* @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_accept_computation (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_HashCode *key,
const struct GNUNET_SCALARPRODUCT_Element *elements,
uint32_t element_count,
GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
void *cont_cls);
/**
* Cancel an ongoing computation or revoke our collaboration offer.
* Closes the connection to the service
*
* @param h computation handle to terminate
*/
void
GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
|
