X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_dht_service.h;h=f047bd8f8e874e1f2213ac51fef85bd6a5227ea6;hb=83b19539f4d322b43683f5838b72e9ec2c8e6073;hp=cf09fd6498b61f508d469411ddb3fbe39354862c;hpb=b571e5a4ed7fb2ef6f203c540e82675cf38bfcf8;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index cf09fd649..f047bd8f8 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,184 +40,178 @@ 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; +/** + * Handle to control a get operation. + */ +struct GNUNET_DHT_GetHandle; + +/** + * Handle to control a find peer operation. + */ +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 ******************* */ /** - * 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) * @param cont_cls closure for cont */ void -GNUNET_DHT_put (struct GNUNET_DHT_Handle *h, - const GNUNET_HashCode * key, - uint32_t type, - uint32_t size, - const char *data, - struct GNUNET_TIME_Absolute exp, - struct GNUNET_TIME_Relative timeout, - GNUNET_SCHEDULER_Task cont, - void *cont_cls); - - -/** - * Handle to control a GET operation. - */ -struct GNUNET_DHT_GetHandle; +GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, const GNUNET_HashCode * key, + uint32_t desired_replication_level, + enum GNUNET_DHT_RouteOption options, + enum GNUNET_BLOCK_Type type, size_t size, const char *data, + struct GNUNET_TIME_Absolute exp, + struct GNUNET_TIME_Relative timeout, GNUNET_SCHEDULER_Task cont, + void *cont_cls); /** - * Iterator called on each result obtained for a GET - * operation. + * Iterator called on each result obtained for a DHT + * operation that expects a reply * * @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_Iterator)(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 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 handle handle to the DHT service + * @param timeout how long to wait for transmission of this request to the 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_GetHandle * -GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *h, - uint32_t type, - const GNUNET_HashCode * key, - GNUNET_DHT_Iterator iter, - void *iter_cls); +GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle, + struct GNUNET_TIME_Relative timeout, + enum GNUNET_BLOCK_Type type, const 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. * * @param get_handle GET operation to stop. - */ -void -GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle); - - -/** - * Iterator called on each result obtained from a FIND_PEER - * operation - * - * @param cls closure - * @param peer a peer that was located - * @param reply response generated by the peer (for example, a HELLO); or NULL - */ -typedef void (*GNUNET_DHT_ReplyProcessor)(void *cls, - const struct GNUNET_PeerIdentity *peer, - const struct GNUNET_MessageHeader *reply); - - -/** - * 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 - }; - - -/** - * Perform an asynchronous FIND_PEER operation on the DHT. * - * @param h 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; - * reason will be TIMEOUT on error, - * reason will be PREREQ_DONE on success - * @param cont_cls closure for cont - * @return handle to stop the request + * On return get_handle will no longer be valid, caller + * must not use again!!! */ -struct GNUNET_DHT_FindPeerHandle * -GNUNET_DHT_route_start (struct GNUNET_DHT_Handle *h, - 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, - struct GNUNET_TIME_Relative timeout, - GNUNET_SCHEDULER_Task cont, - void *cont_cls); - void -GNUNET_DHT_route_stop (struct GNUNET_DHT_FindPeerHandle *fph); +GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle); #if 0 /* keep Emacsens' auto-indent happy */ @@ -226,5 +222,5 @@ GNUNET_DHT_route_stop (struct GNUNET_DHT_FindPeerHandle *fph); #endif -#endif +#endif /* gnunet_dht_service.h */