/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2010, 2011 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @file dht/gnunet-service-xdht_neighbours.h
* @brief GNUnet DHT routing code
- * @author Christian Grothoff
- * @author Nathan Evans
+ * @author Supriti Singh
*/
+
#ifndef GNUNET_SERVICE_XDHT_NEIGHBOURS_H
#define GNUNET_SERVICE_XDHT_NEIGHBOURS_H
#include "gnunet_block_lib.h"
#include "gnunet_dht_service.h"
+
+#if ENABLE_MALICIOUS
/**
- * FIXME: Change the comment to explain about usage of this in find successor.
- * Field in trail setup message to understand if the message is sent to an
- * intermediate finger, friend or me.
+ * Set the ENABLE_MALICIOUS value to malicious.
+ * @param malicious
*/
-enum current_destination_type /* FIXME: enum GSX_CurrentDestinationType */
-{
- /**
- * Look in friend AND finger tables for a trail to the key.
- */
- /* FIXME: GSX_CDT_ */ FRIEND,
-
- /**
- * Look in the routing table to follow a trail to reach to the
- * destination. It is also allowed (but currently not implemented)
- * to look into friend/finger tables for a better trail to the key
- * and (if one is found) 'abort' the current trail and switch to
- * the better one.
- */
- FINGER,
-
- /**
- * "Returned" if the origin is the closest peer to the destination;
- * Must not be passed to "GDS_NEIGHBOURS_handle_put".
- */
- MY_ID,
-
- /**
- * FIXME.
- */
- VALUE
-};
+int
+GDS_NEIGHBOURS_act_malicious (unsigned int malicious);
+#endif
/**
- * Perform a PUT operation. Forwards the given request to other
- * peers. Does not store the data locally. Does not give the
- * data to local clients. May do nothing if this is the only
- * peer in the network (or if we are the closest peer in the
- * network).
- *
- * @param type type of the block
- * @param options routing options
- * @param desired_replication_level desired replication count
- * @param expiration_time when does the content expire
- * @param hop_count how many hops has this message traversed so far
- * @param key key for the content
- * @param put_path_length number of entries in @a put_path
- * @param put_path peers this request has traversed so far (if tracked)
- * @param data payload to store
- * @param data_size number of bytes in @a data
+ * Handle the put request from the client.
+ * @param key Key for the content
+ * @param block_type Type of the block
+ * @param options Routing options
+ * @param desired_replication_level Desired replication count
+ * @param expiration_time When does the content expire
+ * @param data Content to store
+ * @param data_size Size of content @a data in bytes
*/
void
-GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
+GDS_NEIGHBOURS_handle_put (const struct GNUNET_HashCode *key,
+ enum GNUNET_BLOCK_Type block_type,
enum GNUNET_DHT_RouteOption options,
uint32_t desired_replication_level,
struct GNUNET_TIME_Absolute expiration_time,
- uint32_t hop_count,
- const struct GNUNET_HashCode * key,
- unsigned int put_path_length,
- struct GNUNET_PeerIdentity *put_path,
- const void *data, size_t data_size,
- struct GNUNET_PeerIdentity *current_destination,
- struct GNUNET_PeerIdentity *current_source,
- enum current_destination_type dest_type,
- struct GNUNET_PeerIdentity *target_peer_id);
-
+ const void *data, size_t data_size);
/**
- *
- * @param source_peer
- * @param get_path
- * @param get_path_length
- * @param key
+ * Handle the get request from the client file. If I am destination do
+ * datacache put and return. Else find the target friend and forward message
+ * to it.
+ * @param key Key for the content
+ * @param block_type Type of the block
+ * @param options Routing options
+ * @param desired_replication_level Desired replication count
*/
void
-GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type block_type,
- enum GNUNET_DHT_RouteOption options,
- uint32_t desired_replication_level,
- uint32_t hop_count,
- struct GNUNET_PeerIdentity *get_peer_path,
- unsigned int get_path_length,
- struct GNUNET_HashCode *key,
- struct GNUNET_PeerIdentity *target_peer,
- struct GNUNET_PeerIdentity *current_destination,
- struct GNUNET_PeerIdentity *current_source,
- enum current_destination_type current_dest_type);
-
+GDS_NEIGHBOURS_handle_get(const struct GNUNET_HashCode *key,
+ enum GNUNET_BLOCK_Type block_type,
+ enum GNUNET_DHT_RouteOption options,
+ uint32_t desired_replication_level);
/**
- * FIXME: I am removing source peer as the first element in the trail
- * is source identity.
- * Send get result back to requesting client.
- * @param expiration when will the reply expire
- * @param key the query this reply is for
- * @param get_path_length number of peers in @a get_path
- * @param get_path path the reply took on get
- * @param put_path_length number of peers in @a put_path
- * @param put_path path the reply took on put
- * @param type type of the reply
- * @param data_size number of bytes in @a data
- * @param data application payload data
- * @param get_path
- * @param get_path_length
+ * Send the get result to requesting client.
+ * @param key Key of the requested data.
+ * @param type Block type
+ * @param target_peer Next peer to forward the message to.
+ * @param source_peer Peer which has the data for the key.
+ * @param put_path_length Number of peers in @a put_path
+ * @param put_path Path taken to put the data at its stored location.
+ * @param get_path_length Number of peers in @a get_path
+ * @param get_path Path taken to reach to the location of the key.
+ * @param expiration When will this result expire?
+ * @param data Payload to store
+ * @param data_size Size of the @a data
*/
-void
-GDS_NEIGHBOURS_send_get_result (struct GNUNET_TIME_Absolute expiration,
- const struct GNUNET_HashCode *key,
+void
+GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *key,
+ enum GNUNET_BLOCK_Type type,
+ const struct GNUNET_PeerIdentity *target_peer,
+ const struct GNUNET_PeerIdentity *source_peer,
unsigned int put_path_length,
const struct GNUNET_PeerIdentity *put_path,
- enum GNUNET_BLOCK_Type type, size_t data_size,
- const void *data,
- struct GNUNET_PeerIdentity *get_path,
unsigned int get_path_length,
- unsigned int current_trail_index,
- struct GNUNET_PeerIdentity *next_hop,
- struct GNUNET_PeerIdentity *source_peer);
+ const struct GNUNET_PeerIdentity *get_path,
+ struct GNUNET_TIME_Absolute expiration,
+ const void *data, size_t data_size);
/**
- * FIXME: Here you should update the fields of struct PeerGetResultMessage.
- * At the end of this message you should add the data and get path and send
- * to the original requesting client. and there you should call GDS_CLIENT_handle_reply
- * with correct parameter.
- * @param expiration
- * @param key
- * @param get_path_length
- * @param get_path
- * @param put_path_length
- * @param put_path
- * @param type
- * @param data_size
- * @param data
+ * Construct a trail teardown message and forward it to target friend.
+ * @param trail_id Unique identifier of the trail.
+ * @param trail_direction Direction of trail.
+ * @param target_friend Friend to get this message.
*/
-void
-GDS_NEIGHBOURS_datacache_get (struct GNUNET_TIME_Absolute expiration,
- const struct GNUNET_HashCode *key,
- unsigned int get_path_length,
- const struct GNUNET_PeerIdentity *get_path,
- unsigned int put_path_length,
- const struct GNUNET_PeerIdentity *put_path,
- enum GNUNET_BLOCK_Type type, size_t data_size,
- const void *data);
+void
+GDS_NEIGHBOURS_send_trail_teardown (const struct GNUNET_HashCode *trail_id,
+ unsigned int trail_direction,
+ const struct GNUNET_PeerIdentity *peer);
/**
* Initialize neighbours subsystem.
*
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success,
+ * #GNUNET_SYSERR on error
*/
int
GDS_NEIGHBOURS_init (void);
/**
- * Get the ID of the local node.
+ * Get my identity
*
- * @return identity of the local node
+ * @return my identity
*/
-struct GNUNET_PeerIdentity *
-GDS_NEIGHBOURS_get_id ();
-
+struct GNUNET_PeerIdentity
+GDS_NEIGHBOURS_get_my_id (void);
#endif
projects / oweals / gnunet.git / blobdiff