/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2009 Christian Grothoff (and other contributing authors)
+ (C) 2001, 2002, 2003, 2004, 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
* @file dht/dht.h
*/
-#ifndef DHT_H_
-#define DHT_H_
+#ifndef DHT_H
+#define DHT_H
-#define DEBUG_DHT GNUNET_NO
-typedef void (*GNUNET_DHT_MessageReceivedHandler) (void *cls,
- const struct GNUNET_MessageHeader
- * msg);
+/**
+ * Size of the bloom filter the DHT uses to filter peers.
+ */
+#define DHT_BLOOM_SIZE 128
+
/**
- * FIXME.
+ * Message which indicates the DHT should cancel outstanding
+ * requests and discard any state.
*/
-struct GNUNET_DHT_StopMessage
+struct GNUNET_DHT_ClientGetStopMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_MESSAGE
+ * Type: GNUNET_MESSAGE_TYPE_DHT_GET_STOP
*/
struct GNUNET_MessageHeader header;
*/
uint64_t unique_id GNUNET_PACKED;
+ /**
+ * Key of this request
+ */
+ GNUNET_HashCode key;
+
};
/**
- * Generic DHT message, wrapper for other message types
+ * DHT GET message sent from clients to service. Indicates that a GET
+ * request should be issued.
*/
-struct GNUNET_DHT_RouteMessage
+struct GNUNET_DHT_ClientGetMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_ROUTE
+ * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET
*/
struct GNUNET_MessageHeader header;
/**
- * Message options
+ * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
*/
uint32_t options GNUNET_PACKED;
/**
- * The key to search for
+ * Replication level for this message
*/
- GNUNET_HashCode key;
+ uint32_t desired_replication_level GNUNET_PACKED;
/**
- * Unique ID identifying this request
+ * The type for the data for the GET request; actually an 'enum
+ * GNUNET_BLOCK_Type'.
*/
- uint64_t unique_id GNUNET_PACKED;
+ uint32_t type;
/**
- * Replication level for this message
+ * The key to search for
*/
- uint32_t desired_replication_level GNUNET_PACKED;
+ GNUNET_HashCode key;
/**
- * Is this message uniquely identified? If so it will
- * be fire and forget, if not we will wait for a receipt
- * from the service.
+ * Unique ID identifying this request, if 0 then
+ * the client will not expect a response
*/
- uint32_t unique GNUNET_PACKED;
+ uint64_t unique_id GNUNET_PACKED;
- /* GNUNET_MessageHeader *enc actual DHT message, copied to end of this dealy do */
+ /* Possibly followed by xquery, copied to end of this dealy do */
};
-struct GNUNET_DHT_RouteResultMessage
+
+/**
+ * Reply to a GET send from the service to a client.
+ */
+struct GNUNET_DHT_ClientResultMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_ROUTE_RESULT
+ * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT
*/
struct GNUNET_MessageHeader header;
/**
- * Message options
+ * The type for the data.
*/
- uint32_t options GNUNET_PACKED;
+ uint32_t type;
/**
- * The key that was searched for
+ * Number of peers recorded in the outgoing path from source to the
+ * storgage location of this message.
*/
- GNUNET_HashCode key;
+ uint32_t put_path_length GNUNET_PACKED;
/**
- * Unique ID identifying this request
+ * The number of peer identities recorded from the storage location
+ * to this peer.
*/
- uint64_t unique_id GNUNET_PACKED;
-
- /* GNUNET_MessageHeader *enc actual DHT message, copied to end of this dealy do */
-};
-
-/**
- * Message to insert data into the DHT
- */
-struct GNUNET_DHT_PutMessage
-{
- /**
- * Type: GNUNET_MESSAGE_TYPE_DHT_PUT
- */
- struct GNUNET_MessageHeader header;
+ uint32_t get_path_length GNUNET_PACKED;
/**
- * The type of data to insert.
+ * Unique ID of the matching GET request.
*/
- size_t type GNUNET_PACKED;
+ uint64_t unique_id GNUNET_PACKED;
/**
- * How long should this data persist?
+ * When does this entry expire?
*/
struct GNUNET_TIME_AbsoluteNBO expiration;
/**
- * The size of the data, appended to the end of this message.
+ * The key that was searched for
*/
- size_t data_size GNUNET_PACKED;
+ GNUNET_HashCode key;
+
+ /* put path, get path and actual data are copied to end of this dealy do */
};
/**
- * Message to request data from the DHT
+ * Message to insert data into the DHT, sent from clients to DHT service.
*/
-struct GNUNET_DHT_GetMessage
+struct GNUNET_DHT_ClientPutMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_GET
+ * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT
*/
struct GNUNET_MessageHeader header;
/**
- * The type for the data for the GET request
+ * The type of data to insert.
*/
- uint32_t type;
-
-};
+ uint32_t type GNUNET_PACKED;
-/**
- * Message to return data from the DHT
- */
-struct GNUNET_DHT_GetResultMessage
-{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_GET_RESULT
+ * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
*/
- struct GNUNET_MessageHeader header;
+ uint32_t options GNUNET_PACKED;
/**
- * The type for the data for the GET request
+ * Replication level for this message
*/
- uint32_t type;
+ uint32_t desired_replication_level GNUNET_PACKED;
/**
- * The key to search for
+ * How long should this data persist?
*/
- GNUNET_HashCode key;
+ struct GNUNET_TIME_AbsoluteNBO expiration;
/**
- * When does this entry expire?
+ * The key to store the value under.
*/
- struct GNUNET_TIME_Absolute expiration;
+ GNUNET_HashCode key;
+
+ /* DATA copied to end of this message */
};
-#endif /* DHT_H_ */
+#endif