aboutsummaryrefslogtreecommitdiff
path: root/src/mesh/mesh_tunnel_tree.h
diff options
context:
space:
mode:
authorBart Polot <bart@net.in.tum.de>2011-11-24 14:44:07 +0000
committerBart Polot <bart@net.in.tum.de>2011-11-24 14:44:07 +0000
commit4649d3d4a4190e27a42d571c7d7ee7e17792dc51 (patch)
treed3352c245933f4d1477890d90c59a4e2be01762e /src/mesh/mesh_tunnel_tree.h
parent13a6d7c63e51d5a98b05a308786b08dd59709afb (diff)
downloadgnunet-4649d3d4a4190e27a42d571c7d7ee7e17792dc51.tar.gz
gnunet-4649d3d4a4190e27a42d571c7d7ee7e17792dc51.zip
- Updated doxygen
Diffstat (limited to 'src/mesh/mesh_tunnel_tree.h')
-rw-r--r--src/mesh/mesh_tunnel_tree.h32
1 files changed, 17 insertions, 15 deletions
diff --git a/src/mesh/mesh_tunnel_tree.h b/src/mesh/mesh_tunnel_tree.h
index dd31661ac..615a5a8d0 100644
--- a/src/mesh/mesh_tunnel_tree.h
+++ b/src/mesh/mesh_tunnel_tree.h
@@ -19,7 +19,7 @@
19*/ 19*/
20 20
21/** 21/**
22 * @file mesh/mesh_tree_tree.h 22 * @file mesh/mesh_tunnel_tree.h
23 * @brief Tunnel tree handling functions 23 * @brief Tunnel tree handling functions
24 * @author Bartlomiej Polot 24 * @author Bartlomiej Polot
25 */ 25 */
@@ -72,9 +72,9 @@ struct MeshTunnelTree;
72/******************************************************************************/ 72/******************************************************************************/
73 73
74/** 74/**
75 * Create a new path 75 * Create a new path.
76 * 76 *
77 * @param lenght How many hops will the path have. 77 * @param length How many hops will the path have.
78 * 78 *
79 * @return A newly allocated path with a peer array of the specified length. 79 * @return A newly allocated path with a peer array of the specified length.
80 */ 80 */
@@ -83,33 +83,33 @@ path_new (unsigned int length);
83 83
84 84
85/** 85/**
86 * Invert the path 86 * Invert the path.
87 * 87 *
88 * @param p the path to invert 88 * @param path The path to invert.
89 */ 89 */
90void 90void
91path_invert (struct MeshPeerPath *p); 91path_invert (struct MeshPeerPath *path);
92 92
93 93
94/** 94/**
95 * Duplicate a path, incrementing short peer's rc. 95 * Duplicate a path, incrementing short peer's rc.
96 * 96 *
97 * @param p The path to duplicate. 97 * @param path The path to duplicate.
98 */ 98 */
99struct MeshPeerPath * 99struct MeshPeerPath *
100path_duplicate (struct MeshPeerPath *path); 100path_duplicate (struct MeshPeerPath *path);
101 101
102 102
103/** 103/**
104 * Get the length of a path 104 * Get the length of a path.
105 * 105 *
106 * @param p The path to measure, with the local peer at any point of it 106 * @param path The path to measure, with the local peer at any point of it.
107 * 107 *
108 * @return Number of hops to reach destination 108 * @return Number of hops to reach destination.
109 * UINT_MAX in case the peer is not in the path 109 * UINT_MAX in case the peer is not in the path.
110 */ 110 */
111unsigned int 111unsigned int
112path_get_length (struct MeshPeerPath *p); 112path_get_length (struct MeshPeerPath *path);
113 113
114 114
115/** 115/**
@@ -149,7 +149,8 @@ tree_new (GNUNET_PEER_Id peer);
149 * Set the status of a node. 149 * Set the status of a node.
150 * 150 *
151 * @param tree Tree. 151 * @param tree Tree.
152 * @param peer A short peer id of local peer. 152 * @param peer A short peer id of the node.
153 * @param status New status to set.
153 */ 154 */
154void 155void
155tree_set_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer, 156tree_set_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer,
@@ -160,6 +161,7 @@ tree_set_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer,
160 * Get the status of a node. 161 * Get the status of a node.
161 * 162 *
162 * @param tree Tree whose local id we want to now. 163 * @param tree Tree whose local id we want to now.
164 * @param peer A short peer id of the node.
163 * 165 *
164 * @return Short peer id of local peer. 166 * @return Short peer id of local peer.
165 */ 167 */
@@ -233,7 +235,7 @@ tree_update_first_hops (struct MeshTunnelTree *tree, GNUNET_PEER_Id parent_id,
233 * a new path to it or destroy it explicitly, taking care of it's child nodes. 235 * a new path to it or destroy it explicitly, taking care of it's child nodes.
234 * 236 *
235 * @param t Tunnel tree where to delete the path from. 237 * @param t Tunnel tree where to delete the path from.
236 * @param peer Destination peer whose path we want to remove. 238 * @param peer_id Short ID of the destination peer whose path we want to remove.
237 * @param cb Callback to use to notify about which peers are going to be 239 * @param cb Callback to use to notify about which peers are going to be
238 * disconnected. 240 * disconnected.
239 * @param cbcls Closure for cb. 241 * @param cbcls Closure for cb.
@@ -242,7 +244,7 @@ tree_update_first_hops (struct MeshTunnelTree *tree, GNUNET_PEER_Id parent_id,
242 * NULL when not found 244 * NULL when not found
243 */ 245 */
244struct MeshTunnelTreeNode * 246struct MeshTunnelTreeNode *
245tree_del_path (struct MeshTunnelTree *t, GNUNET_PEER_Id peer, 247tree_del_path (struct MeshTunnelTree *t, GNUNET_PEER_Id peer_id,
246 MeshTreeCallback cb, void *cbcls); 248 MeshTreeCallback cb, void *cbcls);
247 249
248 250