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
|
/*
This file is part of GNUnet.
Copyright (C) 2009, 2010, 2011, 2022 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @file dht/gnunet-service-dht_datacache.h
* @brief GNUnet DHT service's datacache integration
* @author Christian Grothoff
* @author Nathan Evans
*/
#ifndef GNUNET_SERVICE_DHT_DATACACHE_H
#define GNUNET_SERVICE_DHT_DATACACHE_H
#include "gnunet_util_lib.h"
#include "gnunet_block_lib.h"
#include "gnunet_dht_service.h"
/**
* Information about a block stored in the datacache.
*/
struct GDS_DATACACHE_BlockData
{
/**
* Key of the block.
*/
struct GNUNET_HashCode key;
/**
* When does the block expire?
*/
struct GNUNET_TIME_Absolute expiration_time;
/**
* PUT path taken by the block, array of peer identities.
*/
const struct GNUNET_DHT_PathElement *put_path;
/**
* Actual block data.
*/
const void *data;
/**
* Number of bytes in @a data.
*/
size_t data_size;
/**
* Length of the @e put_path array.
*/
unsigned int put_path_length;
/**
* Type of the block.
*/
enum GNUNET_BLOCK_Type type;
};
/**
* Handle a datum we've received from another peer. Cache if
* possible.
*
* @param bd block data to cache
*/
void
GDS_DATACACHE_handle_put (const struct GDS_DATACACHE_BlockData *bd);
/**
* Handle a result for a GET operation.
*
* @param cls closure
* @param bd block details
*/
typedef void
(*GDS_DATACACHE_GetCallback)(void *cls,
const struct GDS_DATACACHE_BlockData *bd);
/**
* Handle a GET request we've received from another peer.
*
* @param key the query
* @param type requested data type
* @param xquery extended query
* @param xquery_size number of bytes in xquery
* @param bg block group to use for evaluation of replies
* @param gc function to call on the results
* @param gc_cls closure for @a gc
* @return evaluation result for the local replies
*/
enum GNUNET_BLOCK_ReplyEvaluationResult
GDS_DATACACHE_handle_get (const struct GNUNET_HashCode *key,
enum GNUNET_BLOCK_Type type,
const void *xquery,
size_t xquery_size,
struct GNUNET_BLOCK_Group *bg,
GDS_DATACACHE_GetCallback gc,
void *gc_cls);
/**
* Handle a request for data close to a key that we have received from
* another peer.
*
* @param key the location at which the peer is looking for data that is close
* @param type requested data type
* @param xquery extended query
* @param xquery_size number of bytes in xquery
* @param bg block group to use for evaluation of replies
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return evaluation result for the local replies
*/
enum GNUNET_BLOCK_ReplyEvaluationResult
GDS_DATACACHE_get_closest (const struct GNUNET_HashCode *key,
enum GNUNET_BLOCK_Type type,
const void *xquery,
size_t xquery_size,
struct GNUNET_BLOCK_Group *bg,
GDS_DATACACHE_GetCallback cb,
void *cb_cls);
/**
* Initialize datacache subsystem.
*/
void
GDS_DATACACHE_init (void);
/**
* Shutdown datacache subsystem.
*/
void
GDS_DATACACHE_done (void);
#endif
|
