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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/*
This file is part of GNUnet.
(C) 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/gnunet-service-mesh_tunnel.h
* @brief mesh service; dealing with tunnels and crypto
* @author Bartlomiej Polot
*
* All functions in this file should use the prefix GMT (Gnunet Mesh Tunnel)
*/
#ifndef GNUNET_SERVICE_MESH_TUNNEL_H
#define GNUNET_SERVICE_MESH_TUNNEL_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet-service-mesh_channel.h"
#include "gnunet-service-mesh_connection.h"
/**
* All the states a tunnel can be in.
*/
enum MeshTunnelState
{
/**
* Uninitialized status, should never appear in operation.
*/
MESH_TUNNEL_NEW,
/**
* Path to the peer not known yet
*/
MESH_TUNNEL_SEARCHING,
/**
* Request sent, not yet answered.
*/
MESH_TUNNEL_WAITING,
/**
* Peer connected and ready to accept data
*/
MESH_TUNNEL_READY,
/**
* Peer connected previosly but not responding
*/
MESH_TUNNEL_RECONNECTING
};
/**
* Struct containing all information regarding a given peer
*/
struct MeshTunnel3;
/******************************************************************************/
/******************************** API ***********************************/
/******************************************************************************/
/**
* Initialize tunnel subsystem.
*
* @param c Configuration handle.
* @param id Peer identity.
* @param key ECC private key, to derive all other keys and do crypto.
*/
void
GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
const struct GNUNET_PeerIdentity *id,
const struct GNUNET_CRYPTO_EccPrivateKey *key);
/**
* Shut down the tunnel subsystem.
*/
void
GMT_shutdown (void);
/**
* Tunnel is empty: destroy it.
*
* Notifies all connections about the destruction.
*
* @param t Tunnel to destroy.
*/
void
GMT_destroy_empty (struct MeshTunnel3 *t);
/**
* Destroy tunnel if empty (no more channels).
*
* @param t Tunnel to destroy if empty.
*/
void
GMT_destroy_if_empty (struct MeshTunnel3 *t);
/**
* Destroy the tunnel.
*
* This function does not generate any warning traffic to clients or peers.
*
* Tasks:
* Cancel messages belonging to this tunnel queued to neighbors.
* Free any allocated resources linked to the tunnel.
*
* @param t The tunnel to destroy.
*/
void
GMT_destroy (struct MeshTunnel3 *t);
/**
* Change the tunnel state.
*
* @param t Tunnel whose state to change.
* @param state New state.
*/
void
GMT_change_state (struct MeshTunnel3* t, enum MeshTunnelState state);
/**
* Add a connection to a tunnel.
*
* @param t Tunnel.
* @param c Connection.
*/
void
GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
/**
* Remove a connection from a tunnel.
*
* @param t Tunnel.
* @param c Connection.
*/
void
GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c);
/**
* Cache a message to be sent once tunnel is online.
*
* @param t Tunnel to hold the message.
* @param ch Channel the message is about.
* @param msg Message itself (copy will be made).
* @param fwd Is this fwd?
*/
void
GMT_queue_data (struct MeshTunnel3 *t,
struct MeshChannel *ch,
struct GNUNET_MessageHeader *msg,
int fwd);
/**
* Send all cached messages that we can, tunnel is online.
*
* @param t Tunnel that holds the messages.
* @param fwd Is this fwd?
*/
void
GMT_send_queued_data (struct MeshTunnel3 *t, int fwd);
/**
* Count established (ready) connections of a tunnel.
*
* @param t Tunnel on which to count.
*
* @return Number of connections.
*/
unsigned int
GMT_count_connections (struct MeshTunnel3 *t);
/**
* Count channels of a tunnel.
*
* @param t Tunnel on which to count.
*
* @return Number of channels.
*/
unsigned int
GMT_count_channels (struct MeshTunnel3 *t);
/**
* Get the state of a tunnel.
*
* @param t Tunnel.
*
* @return Tunnel's state.
*/
enum MeshTunnelState
GMT_get_state (struct MeshTunnel3 *t);
/**
* Get the total buffer space for a tunnel.
*
* @param t Tunnel.
* @param fwd Is this for FWD traffic?
*
* @return Buffer space offered by all connections in the tunnel.
*/
unsigned int
GMT_get_buffer (struct MeshTunnel3 *t, int fwd);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_MESH_SERVICE_TUNNEL_H */
#endif
/* end of gnunet-mesh-service_tunnel.h */
|
