aboutsummaryrefslogtreecommitdiff
path: root/src/mesh/mesh_path.h
diff options
context:
space:
mode:
authorBart Polot <bart@net.in.tum.de>2013-05-14 11:59:48 +0000
committerBart Polot <bart@net.in.tum.de>2013-05-14 11:59:48 +0000
commit99c532018cf95dcd4d6319313b4718f7bb2c8297 (patch)
treeb8efcdebe4d9fe5a16bc717d532f549d70584f7a /src/mesh/mesh_path.h
parente7dfce99924513c5b8f4aff7fcfddde376fb41a5 (diff)
downloadgnunet-99c532018cf95dcd4d6319313b4718f7bb2c8297.tar.gz
gnunet-99c532018cf95dcd4d6319313b4718f7bb2c8297.zip
- Remove old tree lib
Diffstat (limited to 'src/mesh/mesh_path.h')
-rw-r--r--src/mesh/mesh_path.h133
1 files changed, 133 insertions, 0 deletions
diff --git a/src/mesh/mesh_path.h b/src/mesh/mesh_path.h
new file mode 100644
index 000000000..c3f3264b0
--- /dev/null
+++ b/src/mesh/mesh_path.h
@@ -0,0 +1,133 @@
1/*
2 This file is part of GNUnet.
3 (C) 2001 - 2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19*/
20
21/**
22 * @file mesh/mesh_path.h
23 * @brief Path handling functions
24 * @author Bartlomiej Polot
25 */
26
27#ifndef MESH_PATH_H
28#define MESH_PATH_H
29
30#ifdef __cplusplus
31extern "C"
32{
33 #if 0 /* keep Emacsens' auto-indent happy */
34}
35#endif
36#endif
37
38#include "mesh2.h"
39
40/******************************************************************************/
41/************************ DATA STRUCTURES ****************************/
42/******************************************************************************/
43
44/**
45 * Information regarding a possible path to reach a single peer
46 */
47struct MeshPeerPath
48{
49
50 /**
51 * Linked list
52 */
53 struct MeshPeerPath *next;
54 struct MeshPeerPath *prev;
55
56 /**
57 * List of all the peers that form the path from origin to target.
58 */
59 GNUNET_PEER_Id *peers;
60
61 /**
62 * Number of peers (hops) in the path
63 */
64 unsigned int length;
65
66};
67
68/******************************************************************************/
69/************************* FUNCTIONS *****************************/
70/******************************************************************************/
71
72/**
73 * Create a new path.
74 *
75 * @param length How many hops will the path have.
76 *
77 * @return A newly allocated path with a peer array of the specified length.
78 */
79struct MeshPeerPath *
80path_new (unsigned int length);
81
82
83/**
84 * Invert the path.
85 *
86 * @param path The path to invert.
87 */
88void
89path_invert (struct MeshPeerPath *path);
90
91
92/**
93 * Duplicate a path, incrementing short peer's rc.
94 *
95 * @param path The path to duplicate.
96 */
97struct MeshPeerPath *
98path_duplicate (struct MeshPeerPath *path);
99
100
101/**
102 * Get the length of a path.
103 *
104 * @param path The path to measure, with the local peer at any point of it.
105 *
106 * @return Number of hops to reach destination.
107 * UINT_MAX in case the peer is not in the path.
108 */
109unsigned int
110path_get_length (struct MeshPeerPath *path);
111
112
113/**
114 * Destroy the path and free any allocated resources linked to it
115 *
116 * @param p the path to destroy
117 *
118 * @return GNUNET_OK on success
119 */
120int
121path_destroy (struct MeshPeerPath *p);
122
123
124#if 0 /* keep Emacsens' auto-indent happy */
125{
126 #endif
127 #ifdef __cplusplus
128}
129#endif
130
131
132/* ifndef MESH_PATH_H */
133#endif \ No newline at end of file