2 This file is part of GNUnet.
3 (C) 2001 - 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file mesh/mesh_path.h
23 * @brief Path handling functions
24 * @author Bartlomiej Polot
33 #if 0 /* keep Emacsens' auto-indent happy */
38 /******************************************************************************/
39 /************************ DATA STRUCTURES ****************************/
40 /******************************************************************************/
43 * Information regarding a possible path to reach a single peer
51 struct MeshPeerPath *next;
52 struct MeshPeerPath *prev;
55 * List of all the peers that form the path from origin to target.
57 GNUNET_PEER_Id *peers;
60 * Number of peers (hops) in the path
65 * Path's score, how reliable is the path.
70 * Task to delete the path.
71 * We tried it, it didn't work, don't try again in a while.
73 GNUNET_SCHEDULER_TaskIdentifier path_delete;
77 /******************************************************************************/
78 /************************* FUNCTIONS *****************************/
79 /******************************************************************************/
84 * @param length How many hops will the path have.
86 * @return A newly allocated path with a peer array of the specified length.
89 path_new (unsigned int length);
95 * @param path The path to invert.
98 path_invert (struct MeshPeerPath *path);
102 * Duplicate a path, incrementing short peer's rc.
104 * @param path The path to duplicate.
106 struct MeshPeerPath *
107 path_duplicate (const struct MeshPeerPath *path);
111 * Get the length of a path.
113 * @param path The path to measure, with the local peer at any point of it.
115 * @return Number of hops to reach destination.
116 * UINT_MAX in case the peer is not in the path.
119 path_get_length (struct MeshPeerPath *path);
122 * Mark path as invalid: keep it aroud for a while to avoid trying it in a loop.
124 * DHT_get sometimes returns bad cached results, for instance, on a locally
125 * cached result where the PUT followed a path that is no longer current.
127 * @param p Path to invalidate.
130 path_invalidate (struct MeshPeerPath *p);
133 * Test if a path is valid (or at least not known to be invalid).
135 * @param path Path to test.
137 * @return #GNUNET_YES If the path is valid or unknown,
138 * #GNUNET_NO If the path is known to be invalid.
141 path_is_valid (const struct MeshPeerPath *path);
144 * Destroy the path and free any allocated resources linked to it
146 * @param p the path to destroy
148 * @return GNUNET_OK on success
151 path_destroy (struct MeshPeerPath *p);
155 * Print info about the path for debug.
157 * @param p Path to debug.
160 path_debug (struct MeshPeerPath *p);
162 #if 0 /* keep Emacsens' auto-indent happy */
170 /* ifndef MESH_PATH_H */