blob: c3f3264b00d48ec53d852566128dbbff272f930c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
This file is part of GNUnet.
(C) 2001 - 2013 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 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
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.
*/
/**
* @file mesh/mesh_path.h
* @brief Path handling functions
* @author Bartlomiej Polot
*/
#ifndef MESH_PATH_H
#define MESH_PATH_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "mesh2.h"
/******************************************************************************/
/************************ DATA STRUCTURES ****************************/
/******************************************************************************/
/**
* Information regarding a possible path to reach a single peer
*/
struct MeshPeerPath
{
/**
* Linked list
*/
struct MeshPeerPath *next;
struct MeshPeerPath *prev;
/**
* List of all the peers that form the path from origin to target.
*/
GNUNET_PEER_Id *peers;
/**
* Number of peers (hops) in the path
*/
unsigned int length;
};
/******************************************************************************/
/************************* FUNCTIONS *****************************/
/******************************************************************************/
/**
* Create a new path.
*
* @param length How many hops will the path have.
*
* @return A newly allocated path with a peer array of the specified length.
*/
struct MeshPeerPath *
path_new (unsigned int length);
/**
* Invert the path.
*
* @param path The path to invert.
*/
void
path_invert (struct MeshPeerPath *path);
/**
* Duplicate a path, incrementing short peer's rc.
*
* @param path The path to duplicate.
*/
struct MeshPeerPath *
path_duplicate (struct MeshPeerPath *path);
/**
* Get the length of a path.
*
* @param path The path to measure, with the local peer at any point of it.
*
* @return Number of hops to reach destination.
* UINT_MAX in case the peer is not in the path.
*/
unsigned int
path_get_length (struct MeshPeerPath *path);
/**
* Destroy the path and free any allocated resources linked to it
*
* @param p the path to destroy
*
* @return GNUNET_OK on success
*/
int
path_destroy (struct MeshPeerPath *p);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef MESH_PATH_H */
#endif
|
