X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_dht_service.h;h=0de7551a45633fdc8fb424a114725643821bd648;hb=0c4acf951c74b9a9479cc3cbf3cf45abcdd49451;hp=9e2e5d1636425a8d622166f2b80aca2a18966eaa;hpb=558fa8b012469c0ada0c4fac6d05c01a727ef764;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index 9e2e5d163..0de7551a4 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h @@ -1,10 +1,10 @@ /* This file is part of GNUnet - (C) 2004, 2005, 2006, 2008, 2009 Christian Grothoff (and other contributing authors) + (C) 2004, 2005, 2006, 2008, 2009, 2011 Christian Grothoff (and other contributing authors) 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 2, or (at your + 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 @@ -28,6 +28,8 @@ #define GNUNET_DHT_SERVICE_H #include "gnunet_util_lib.h" +#include "gnunet_block_lib.h" +#include "gnunet_hello_lib.h" #ifdef __cplusplus extern "C" @@ -38,76 +40,154 @@ extern "C" #endif +/** + * Default republication frequency for stored data in the DHT. + */ +#define GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60) + + + /** * Connection to the DHT service. */ struct GNUNET_DHT_Handle; /** - * Iterator called on each result obtained from a generic route - * operation + * Handle to control a get operation. + */ +struct GNUNET_DHT_GetHandle; + +/** + * Handle to control a find peer operation. */ -typedef void (*GNUNET_DHT_MessageCallback)(void *cls, - int code); +struct GNUNET_DHT_FindPeerHandle; + + +/** + * Options for routing. + */ +enum GNUNET_DHT_RouteOption +{ + /** + * Default. Do nothing special. + */ + GNUNET_DHT_RO_NONE = 0, + + /** + * Each peer along the way should look at 'enc' (otherwise + * only the k-peers closest to the key should look at it). + */ + GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1, + + /** + * We should keep track of the route that the message + * took in the P2P network. + */ + GNUNET_DHT_RO_RECORD_ROUTE = 2, + + /** + * This is a 'FIND-PEER' request, so approximate results are fine. + */ + GNUNET_DHT_RO_FIND_PEER = 4, + + /** + * Possible message option for query key randomization. + */ + GNUNET_DHT_RO_BART = 8 +}; + /** * Initialize the connection with the DHT service. - * + * * @param cfg configuration to use - * @param sched scheduler to use * @param ht_len size of the internal hash table to use for * processing multiple GET/FIND requests in parallel * @return NULL on error */ struct GNUNET_DHT_Handle * -GNUNET_DHT_connect (struct GNUNET_SCHEDULER_Handle *sched, - const struct GNUNET_CONFIGURATION_Handle *cfg, - unsigned int ht_len); +GNUNET_DHT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, + unsigned int ht_len); /** * Shutdown connection with the DHT service. * - * @param h connection to shut down + * @param handle connection to shut down */ void -GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *h); +GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle); + + +/* *************** Standard API: get and put ******************* */ + + +/** + * Opaque handle to cancel a PUT operation. + */ +struct GNUNET_DHT_PutHandle; + + +/** + * Type of a PUT continuation. You must not call + * "GNUNET_DHT_disconnect" in this continuation. + * + * @param cls closure + * @param success GNUNET_OK if the PUT was transmitted, + * GNUNET_NO on timeout, + * GNUNET_SYSERR on disconnect from service + * after the PUT message was transmitted + * (so we don't know if it was received or not) + */ +typedef void (*GNUNET_DHT_PutContinuation)(void *cls, + int success); /** - * Perform a PUT operation on the DHT identified by 'table' storing - * a binding of 'key' to 'value'. The peer does not have to be part - * of the table (if so, we will attempt to locate a peer that is!) + * Perform a PUT operation storing data in the DHT. * - * @param h handle to DHT service + * @param handle handle to DHT service * @param key the key to store under + * @param desired_replication_level estimate of how many + * nearest peers this request should reach + * @param options routing options for this message * @param type type of the value * @param size number of bytes in data; must be less than 64k * @param data the data to store * @param exp desired expiration time for the value - * @param timeout when to abort with an error if we fail to get - * a confirmation for the PUT from the local DHT service - * @param cont continuation to call when done; - * reason will be TIMEOUT on error, - * reason will be PREREQ_DONE on success + * @param timeout how long to wait for transmission of this request + * @param cont continuation to call when done (transmitting request to service) + * You must not call "GNUNET_DHT_disconnect" in this continuation * @param cont_cls closure for cont + * @return handle to cancel the "PUT" operation, NULL on error + * (size too big) */ -void -GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, - const GNUNET_HashCode * key, - uint32_t type, - uint32_t size, - const char *data, - struct GNUNET_TIME_Absolute exp, - struct GNUNET_TIME_Relative timeout, - GNUNET_DHT_MessageCallback cont, - void *cont_cls); +struct GNUNET_DHT_PutHandle * +GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, + const struct GNUNET_HashCode * key, + uint32_t desired_replication_level, + enum GNUNET_DHT_RouteOption options, + enum GNUNET_BLOCK_Type type, + size_t size, const void *data, + struct GNUNET_TIME_Absolute exp, + struct GNUNET_TIME_Relative timeout, + GNUNET_DHT_PutContinuation cont, + void *cont_cls); /** - * Handle to control a GET operation. + * Cancels a DHT PUT operation. Note that the PUT request may still + * go out over the network (we can't stop that); However, if the PUT + * has not yet been sent to the service, cancelling the PUT will stop + * this from happening (but there is no way for the user of this API + * to tell if that is the case). The only use for this API is to + * prevent a later call to 'cont' from "GNUNET_DHT_put" (i.e. because + * the system is shutting down). + * + * @param ph put operation to cancel ('cont' will no longer be called) */ -struct GNUNET_DHT_GetHandle; +void +GNUNET_DHT_put_cancel (struct GNUNET_DHT_PutHandle *ph); /** @@ -117,123 +197,194 @@ struct GNUNET_DHT_GetHandle; * @param cls closure * @param exp when will this value expire * @param key key of the result + * @param get_path peers on reply path (or NULL if not recorded) + * @param get_path_length number of entries in get_path + * @param put_path peers on the PUT path (or NULL if not recorded) + * @param put_path_length number of entries in get_path * @param type type of the result * @param size number of bytes in data * @param data pointer to the result data */ -typedef void (*GNUNET_DHT_GetIterator)(void *cls, - struct GNUNET_TIME_Absolute exp, - const GNUNET_HashCode * key, - uint32_t type, - uint32_t size, - const void *data); - +typedef void (*GNUNET_DHT_GetIterator) (void *cls, + struct GNUNET_TIME_Absolute exp, + const struct GNUNET_HashCode * key, + const struct GNUNET_PeerIdentity * + get_path, unsigned int get_path_length, + const struct GNUNET_PeerIdentity * + put_path, unsigned int put_path_length, + enum GNUNET_BLOCK_Type type, + size_t size, const void *data); + /** - * Perform an asynchronous GET operation on the DHT identified. + * Perform an asynchronous GET operation on the DHT identified. See + * also "GNUNET_BLOCK_evaluate". * - * @param h handle to the DHT service - * @param timeout timeout for this request to be sent to the - * service + * @param handle handle to the DHT service * @param type expected type of the response object * @param key the key to look up + * @param desired_replication_level estimate of how many + nearest peers this request should reach + * @param options routing options for this message + * @param xquery extended query data (can be NULL, depending on type) + * @param xquery_size number of bytes in xquery * @param iter function to call on each result * @param iter_cls closure for iter - * @return handle to stop the async get, NULL on error + * + * @return handle to stop the async get */ -struct GNUNET_DHT_RouteHandle * -GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *h, - struct GNUNET_TIME_Relative timeout, - uint32_t type, - const GNUNET_HashCode * key, - GNUNET_DHT_GetIterator iter, - void *iter_cls); +struct GNUNET_DHT_GetHandle * +GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle, + enum GNUNET_BLOCK_Type type, + const struct GNUNET_HashCode *key, + uint32_t desired_replication_level, + enum GNUNET_DHT_RouteOption options, + const void *xquery, size_t xquery_size, + GNUNET_DHT_GetIterator iter, void *iter_cls); + /** - * Stop async DHT-get. Frees associated resources. + * Tell the DHT not to return any of the following known results + * to this client. * - * @param get_handle GET operation to stop. + * @param get_handle get operation for which results should be filtered + * @param num_results number of results to be blocked that are + * provided in this call (size of the 'results' array) + * @param results array of hash codes over the 'data' of the results + * to be blocked */ void -GNUNET_DHT_get_stop (struct GNUNET_DHT_RouteHandle *get_handle); - +GNUNET_DHT_get_filter_known_results (struct GNUNET_DHT_GetHandle *get_handle, + unsigned int num_results, + const struct GNUNET_HashCode *results); /** - * Iterator called on each result obtained from a find peer - * operation + * Stop async DHT-get. Frees associated resources. * - * @param cls closure - * @param reply response + * @param get_handle GET operation to stop. + * + * On return get_handle will no longer be valid, caller + * must not use again!!! */ -typedef void (*GNUNET_DHT_FindPeerProcessor)(void *cls, - const struct GNUNET_PeerIdentity *peer, - const struct GNUNET_MessageHeader *reply); +void +GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle); + +/* *************** Extended API: monitor ******************* */ /** - * Iterator called on each result obtained from a generic route - * operation + * Handle to monitor requests */ -typedef void (*GNUNET_DHT_ReplyProcessor)(void *cls, - const struct GNUNET_MessageHeader *reply); - +struct GNUNET_DHT_MonitorHandle; /** - * Options for routing. + * Callback called on each GET request going through the DHT. + * + * @param cls Closure. + * @param options Options, for instance RecordRoute, DemultiplexEverywhere. + * @param type The type of data in the request. + * @param hop_count Hop count so far. + * @param path_length number of entries in path (or 0 if not recorded). + * @param path peers on the GET path (or NULL if not recorded). + * @param desired_replication_level Desired replication level. + * @param key Key of the requested data. */ -enum GNUNET_DHT_RouteOption - { - /** - * Default. Do nothing special. - */ - GNUNET_DHT_RO_NONE = 0, +typedef void (*GNUNET_DHT_MonitorGetCB) (void *cls, + enum GNUNET_DHT_RouteOption options, + enum GNUNET_BLOCK_Type type, + uint32_t hop_count, + uint32_t desired_replication_level, + unsigned int path_length, + const struct GNUNET_PeerIdentity *path, + const struct GNUNET_HashCode * key); - /** - * Each peer along the way should look at 'enc' (otherwise - * only the k-peers closest to the key should look at it). - */ - GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1 - }; +/** + * Callback called on each GET reply going through the DHT. + * + * @param cls Closure. + * @param type The type of data in the result. + * @param get_path Peers on GET path (or NULL if not recorded). + * @param get_path_length number of entries in get_path. + * @param put_path peers on the PUT path (or NULL if not recorded). + * @param put_path_length number of entries in get_path. + * @param exp Expiration time of the data. + * @param key Key of the data. + * @param data Pointer to the result data. + * @param size Number of bytes in data. + */ +typedef void (*GNUNET_DHT_MonitorGetRespCB) (void *cls, + enum GNUNET_BLOCK_Type type, + const struct GNUNET_PeerIdentity + *get_path, + unsigned int get_path_length, + const struct GNUNET_PeerIdentity + * put_path, + unsigned int put_path_length, + struct GNUNET_TIME_Absolute exp, + const struct GNUNET_HashCode * key, + const void *data, + size_t size); /** - * Handle to control a route operation. + * Callback called on each PUT request going through the DHT. + * + * @param cls Closure. + * @param options Options, for instance RecordRoute, DemultiplexEverywhere. + * @param type The type of data in the request. + * @param hop_count Hop count so far. + * @param path_length number of entries in path (or 0 if not recorded). + * @param path peers on the PUT path (or NULL if not recorded). + * @param desired_replication_level Desired replication level. + * @param exp Expiration time of the data. + * @param key Key under which data is to be stored. + * @param data Pointer to the data carried. + * @param size Number of bytes in data. */ -struct GNUNET_DHT_RouteHandle; +typedef void (*GNUNET_DHT_MonitorPutCB) (void *cls, + enum GNUNET_DHT_RouteOption options, + enum GNUNET_BLOCK_Type type, + uint32_t hop_count, + uint32_t desired_replication_level, + unsigned int path_length, + const struct GNUNET_PeerIdentity *path, + struct GNUNET_TIME_Absolute exp, + const struct GNUNET_HashCode * key, + const void *data, + size_t size); /** - * Perform an asynchronous FIND_PEER operation on the DHT. + * Start monitoring the local DHT service. * - * @param handle handle to the DHT service - * @param key the key to look up - * @param desired_replication_level how many peers should ultimately receive - * this message (advisory only, target may be too high for the - * given DHT or not hit exactly). - * @param options options for routing - * @param enc send the encapsulated message to a peer close to the key - * @param iter function to call on each result, NULL if no replies are expected - * @param iter_cls closure for iter - * @param timeout when to abort with an error if we fail to get - * a confirmation for the PUT from the local DHT service - * @param cont continuation to call when done, GNUNET_SYSERR if failed - * GNUNET_OK otherwise - * @param cont_cls closure for cont - * @return handle to stop the request - */ -struct GNUNET_DHT_RouteHandle * -GNUNET_DHT_route_start (struct GNUNET_DHT_Handle *handle, - const GNUNET_HashCode *key, - unsigned int desired_replication_level, - enum GNUNET_DHT_RouteOption options, - const struct GNUNET_MessageHeader *enc, - struct GNUNET_TIME_Relative timeout, - GNUNET_DHT_ReplyProcessor iter, - void *iter_cls, - GNUNET_DHT_MessageCallback cont, - void *cont_cls); + * @param handle Handle to the DHT service. + * @param type Type of blocks that are of interest. + * @param key Key of data of interest, NULL for all. + * @param get_cb Callback to process monitored get messages. + * @param get_resp_cb Callback to process monitored get response messages. + * @param put_cb Callback to process monitored put messages. + * @param cb_cls Closure for cb. + * + * @return Handle to stop monitoring. + */ +struct GNUNET_DHT_MonitorHandle * +GNUNET_DHT_monitor_start (struct GNUNET_DHT_Handle *handle, + enum GNUNET_BLOCK_Type type, + const struct GNUNET_HashCode *key, + GNUNET_DHT_MonitorGetCB get_cb, + GNUNET_DHT_MonitorGetRespCB get_resp_cb, + GNUNET_DHT_MonitorPutCB put_cb, + void *cb_cls); + +/** + * Stop monitoring. + * + * @param handle The handle to the monitor request returned by monitor_start. + * + * On return handle will no longer be valid, caller must not use again!!! + */ void -GNUNET_DHT_route_stop (struct GNUNET_DHT_RouteHandle *fph); +GNUNET_DHT_monitor_stop (struct GNUNET_DHT_MonitorHandle *handle); #if 0 /* keep Emacsens' auto-indent happy */ @@ -244,5 +395,5 @@ GNUNET_DHT_route_stop (struct GNUNET_DHT_RouteHandle *fph); #endif -#endif +#endif /* gnunet_dht_service.h */