2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/gnunet-service-fs_indexing.h
23 * @brief indexing for the file-sharing service
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_INDEXING_H
27 #define GNUNET_SERVICE_FS_INDEXING_H
29 #include "gnunet_block_lib.h"
30 #include "gnunet_core_service.h"
31 #include "gnunet_datastore_service.h"
32 #include "gnunet_peer_lib.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_signatures.h"
35 #include "gnunet_util_lib.h"
39 * We've received an on-demand encoded block from the datastore.
40 * Attempt to do on-demand encoding and (if successful), call the
41 * continuation with the resulting block. On error, clean up and ask
42 * the datastore for more results.
44 * @param key key for the content
45 * @param size number of bytes in data
46 * @param data content stored
47 * @param type type of the content
48 * @param priority priority of the content
49 * @param anonymity anonymity-level for the content
50 * @param expiration expiration time for the content
51 * @param uid unique identifier for the datum;
52 * maybe 0 if no unique identifier is available
53 * @param cont function to call with the actual block (at most once, on success)
54 * @param cont_cls closure for cont
55 * @return GNUNET_OK on success
58 GNUNET_FS_handle_on_demand_block (const GNUNET_HashCode * key,
61 enum GNUNET_BLOCK_Type type,
64 struct GNUNET_TIME_Absolute
65 expiration, uint64_t uid,
66 GNUNET_DATASTORE_DatumProcessor cont,
70 * Handle INDEX_START-message.
73 * @param client identification of the client
74 * @param message the actual message
77 GNUNET_FS_handle_index_start (void *cls,
78 struct GNUNET_SERVER_Client *client,
79 const struct GNUNET_MessageHeader *message);
83 * Handle INDEX_LIST_GET-message.
86 * @param client identification of the client
87 * @param message the actual message
90 GNUNET_FS_handle_index_list_get (void *cls,
91 struct GNUNET_SERVER_Client *client,
92 const struct GNUNET_MessageHeader *message);
96 * Handle UNINDEX-message.
99 * @param client identification of the client
100 * @param message the actual message
103 GNUNET_FS_handle_unindex (void *cls,
104 struct GNUNET_SERVER_Client *client,
105 const struct GNUNET_MessageHeader *message);
109 * Initialize the indexing submodule.
111 * @param c configuration to use
112 * @param d datastore to use
113 * @return GNUNET_OK on success
116 GNUNET_FS_indexing_init (const struct GNUNET_CONFIGURATION_Handle *c,
117 struct GNUNET_DATASTORE_Handle *d);
121 * Shutdown the module.
124 GNUNET_FS_indexing_done (void);