diff options
Diffstat (limited to 'src/include/gnunet_mesh_service_enc.h')
-rw-r--r-- | src/include/gnunet_mesh_service_enc.h | 457 |
1 files changed, 0 insertions, 457 deletions
diff --git a/src/include/gnunet_mesh_service_enc.h b/src/include/gnunet_mesh_service_enc.h deleted file mode 100644 index 6819af655..000000000 --- a/src/include/gnunet_mesh_service_enc.h +++ /dev/null | |||
@@ -1,457 +0,0 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | (C) 2009 - 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 include/gnunet_mesh_service_enc.h | ||
23 | * @brief mesh service; establish channels to distant peers | ||
24 | * @author Christian Grothoff | ||
25 | */ | ||
26 | |||
27 | #ifndef GNUNET_MESH_SERVICE_H | ||
28 | #define GNUNET_MESH_SERVICE_H | ||
29 | |||
30 | #ifdef __cplusplus | ||
31 | extern "C" | ||
32 | { | ||
33 | #if 0 /* keep Emacsens' auto-indent happy */ | ||
34 | } | ||
35 | #endif | ||
36 | #endif | ||
37 | |||
38 | #include "gnunet_util_lib.h" | ||
39 | #include "gnunet_transport_service.h" | ||
40 | |||
41 | /** | ||
42 | * Version number of GNUnet-mesh API. | ||
43 | */ | ||
44 | #define GNUNET_MESH_VERSION 0x00000003 | ||
45 | |||
46 | |||
47 | /** | ||
48 | * Opaque handle to the service. | ||
49 | */ | ||
50 | struct GNUNET_MESH_Handle; | ||
51 | |||
52 | /** | ||
53 | * Opaque handle to a channel. | ||
54 | */ | ||
55 | struct GNUNET_MESH_Channel; | ||
56 | |||
57 | |||
58 | /** | ||
59 | * Channel options. | ||
60 | * Second line indicates filed in the MeshChannelInfo union carrying the answer. | ||
61 | */ | ||
62 | enum MeshOption | ||
63 | { | ||
64 | /** | ||
65 | * Disable buffering on intermediate nodes (for minimum latency). | ||
66 | * Yes/No. | ||
67 | */ | ||
68 | GNUNET_MESH_OPTION_NOBUFFER = 0x1, | ||
69 | |||
70 | /** | ||
71 | * Enable channel reliability, lost messages will be retransmitted. | ||
72 | * Yes/No. | ||
73 | */ | ||
74 | GNUNET_MESH_OPTION_RELIABLE = 0x2, | ||
75 | |||
76 | /** | ||
77 | * Enable out of order delivery of messages. | ||
78 | * Yes/No. | ||
79 | */ | ||
80 | GNUNET_MESH_OPTION_OOORDER = 0x4, | ||
81 | |||
82 | /** | ||
83 | * Who is the peer at the other end of the channel. | ||
84 | * struct GNUNET_PeerIdentity *peer | ||
85 | */ | ||
86 | GNUNET_MESH_OPTION_PEER = 0x8 | ||
87 | |||
88 | }; | ||
89 | |||
90 | |||
91 | /** | ||
92 | * Functions with this signature are called whenever a message is | ||
93 | * received. | ||
94 | * | ||
95 | * Each time the function must call #GNUNET_MESH_receive_done on the channel | ||
96 | * in order to receive the next message. This doesn't need to be immediate: | ||
97 | * can be delayed if some processing is done on the message. | ||
98 | * | ||
99 | * @param cls Closure (set from #GNUNET_MESH_connect). | ||
100 | * @param channel Connection to the other end. | ||
101 | * @param channel_ctx Place to store local state associated with the channel. | ||
102 | * @param message The actual message. | ||
103 | * @return #GNUNET_OK to keep the channel open, | ||
104 | * #GNUNET_SYSERR to close it (signal serious error). | ||
105 | */ | ||
106 | typedef int (*GNUNET_MESH_MessageCallback) (void *cls, | ||
107 | struct GNUNET_MESH_Channel *channel, | ||
108 | void **channel_ctx, | ||
109 | const struct GNUNET_MessageHeader *message); | ||
110 | |||
111 | |||
112 | /** | ||
113 | * Message handler. Each struct specifies how to handle on particular | ||
114 | * type of message received. | ||
115 | */ | ||
116 | struct GNUNET_MESH_MessageHandler | ||
117 | { | ||
118 | /** | ||
119 | * Function to call for messages of "type". | ||
120 | */ | ||
121 | GNUNET_MESH_MessageCallback callback; | ||
122 | |||
123 | /** | ||
124 | * Type of the message this handler covers. | ||
125 | */ | ||
126 | uint16_t type; | ||
127 | |||
128 | /** | ||
129 | * Expected size of messages of this type. Use 0 for variable-size. | ||
130 | * If non-zero, messages of the given type will be discarded if they | ||
131 | * do not have the right size. | ||
132 | */ | ||
133 | uint16_t expected_size; | ||
134 | }; | ||
135 | |||
136 | |||
137 | /** | ||
138 | * Method called whenever another peer has added us to a channel | ||
139 | * the other peer initiated. | ||
140 | * Only called (once) upon reception of data with a message type which was | ||
141 | * subscribed to in #GNUNET_MESH_connect. A call to #GNUNET_MESH_channel_destroy | ||
142 | * causes te channel to be ignored and no further notifications are sent about | ||
143 | * the same channel. | ||
144 | * | ||
145 | * @param cls closure | ||
146 | * @param channel new handle to the channel | ||
147 | * @param initiator peer that started the channel | ||
148 | * @param port Port this channel is for. | ||
149 | * @return initial channel context for the channel | ||
150 | * (can be NULL -- that's not an error) | ||
151 | */ | ||
152 | typedef void *(GNUNET_MESH_InboundChannelNotificationHandler) (void *cls, | ||
153 | struct | ||
154 | GNUNET_MESH_Channel | ||
155 | * channel, | ||
156 | const struct | ||
157 | GNUNET_PeerIdentity | ||
158 | * initiator, | ||
159 | uint32_t port); | ||
160 | |||
161 | |||
162 | /** | ||
163 | * Function called whenever a channel is destroyed. Should clean up | ||
164 | * any associated state. | ||
165 | * | ||
166 | * It must NOT call #GNUNET_MESH_channel_destroy on the channel. | ||
167 | * | ||
168 | * @param cls closure (set from #GNUNET_MESH_connect) | ||
169 | * @param channel connection to the other end (henceforth invalid) | ||
170 | * @param channel_ctx place where local state associated | ||
171 | * with the channel is stored | ||
172 | */ | ||
173 | typedef void (GNUNET_MESH_ChannelEndHandler) (void *cls, | ||
174 | const struct GNUNET_MESH_Channel * | ||
175 | channel, | ||
176 | void *channel_ctx); | ||
177 | |||
178 | |||
179 | /** | ||
180 | * Connect to the mesh service. | ||
181 | * | ||
182 | * @param cfg Configuration to use. | ||
183 | * @param cls Closure for the various callbacks that follow (including | ||
184 | * handlers in the handlers array). | ||
185 | * @param new_channel Function called when an *incoming* channel is created. | ||
186 | * Can be NULL if no inbound channels are desired. | ||
187 | * See @a ports. | ||
188 | * @param cleaner Function called when a channel is destroyed by the remote peer. | ||
189 | * It is NOT called if #GNUNET_MESH_channel_destroy is called on | ||
190 | * the channel. | ||
191 | * @param handlers Callbacks for messages we care about, NULL-terminated. Each | ||
192 | * one must call #GNUNET_MESH_receive_done on the channel to | ||
193 | * receive the next message. Messages of a type that is not | ||
194 | * in the handlers array are ignored if received. | ||
195 | * @param ports NULL or 0-terminated array of port numbers for incoming channels. | ||
196 | * See @a new_channel. | ||
197 | * | ||
198 | * @return handle to the mesh service NULL on error | ||
199 | * (in this case, init is never called) | ||
200 | */ | ||
201 | struct GNUNET_MESH_Handle * | ||
202 | GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls, | ||
203 | GNUNET_MESH_InboundChannelNotificationHandler new_channel, | ||
204 | GNUNET_MESH_ChannelEndHandler cleaner, | ||
205 | const struct GNUNET_MESH_MessageHandler *handlers, | ||
206 | const uint32_t *ports); | ||
207 | |||
208 | |||
209 | /** | ||
210 | * Disconnect from the mesh service. All channels will be destroyed. All channel | ||
211 | * disconnect callbacks will be called on any still connected peers, notifying | ||
212 | * about their disconnection. The registered inbound channel cleaner will be | ||
213 | * called should any inbound channels still exist. | ||
214 | * | ||
215 | * @param handle connection to mesh to disconnect | ||
216 | */ | ||
217 | void | ||
218 | GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle); | ||
219 | |||
220 | |||
221 | /** | ||
222 | * Create a new channel towards a remote peer. | ||
223 | * | ||
224 | * If the destination port is not open by any peer or the destination peer | ||
225 | * does not accept the channel, #GNUNET_MESH_ChannelEndHandler will be called | ||
226 | * for this channel. | ||
227 | * | ||
228 | * @param h mesh handle | ||
229 | * @param channel_ctx client's channel context to associate with the channel | ||
230 | * @param peer peer identity the channel should go to | ||
231 | * @param port Port number. | ||
232 | * @param nobuffer Flag for disabling buffering on relay nodes. | ||
233 | * @param reliable Flag for end-to-end reliability. | ||
234 | * @return handle to the channel | ||
235 | */ | ||
236 | struct GNUNET_MESH_Channel * | ||
237 | GNUNET_MESH_channel_create (struct GNUNET_MESH_Handle *h, | ||
238 | void *channel_ctx, | ||
239 | const struct GNUNET_PeerIdentity *peer, | ||
240 | uint32_t port, | ||
241 | int nobuffer, | ||
242 | int reliable); | ||
243 | |||
244 | |||
245 | /** | ||
246 | * Destroy an existing channel. | ||
247 | * | ||
248 | * The existing end callback for the channel will be called immediately. | ||
249 | * Any pending outgoing messages will be sent but no incoming messages will be | ||
250 | * accepted and no data callbacks will be called. | ||
251 | * | ||
252 | * @param channel Channel handle, becomes invalid after this call. | ||
253 | */ | ||
254 | void | ||
255 | GNUNET_MESH_channel_destroy (struct GNUNET_MESH_Channel *channel); | ||
256 | |||
257 | |||
258 | /** | ||
259 | * Struct to retrieve info about a channel. | ||
260 | */ | ||
261 | union GNUNET_MESH_ChannelInfo | ||
262 | { | ||
263 | |||
264 | /** | ||
265 | * #GNUNET_YES / #GNUNET_NO, for binary flags. | ||
266 | */ | ||
267 | int yes_no; | ||
268 | |||
269 | /** | ||
270 | * Peer on the other side of the channel | ||
271 | */ | ||
272 | const struct GNUNET_PeerIdentity *peer; | ||
273 | }; | ||
274 | |||
275 | |||
276 | /** | ||
277 | * Get information about a channel. | ||
278 | * | ||
279 | * @param channel Channel handle. | ||
280 | * @param option Query type GNUNET_MESH_OPTION_* | ||
281 | * @param ... dependant on option, currently not used | ||
282 | * @return Union with an answer to the query. | ||
283 | */ | ||
284 | const union GNUNET_MESH_ChannelInfo * | ||
285 | GNUNET_MESH_channel_get_info (struct GNUNET_MESH_Channel *channel, | ||
286 | enum MeshOption option, ...); | ||
287 | |||
288 | |||
289 | /** | ||
290 | * Handle for a transmission request. | ||
291 | */ | ||
292 | struct GNUNET_MESH_TransmitHandle; | ||
293 | |||
294 | |||
295 | /** | ||
296 | * Ask the mesh to call @a notify once it is ready to transmit the | ||
297 | * given number of bytes to the specified channel. | ||
298 | * Only one call can be active at any time, to issue another request, | ||
299 | * wait for the callback or cancel the current request. | ||
300 | * | ||
301 | * @param channel channel to use for transmission | ||
302 | * @param cork is corking allowed for this transmission? | ||
303 | * @param maxdelay how long can the message wait? | ||
304 | * @param notify_size how many bytes of buffer space does notify want? | ||
305 | * @param notify function to call when buffer space is available; | ||
306 | * will be called with NULL on timeout or if the overall queue | ||
307 | * for this peer is larger than queue_size and this is currently | ||
308 | * the message with the lowest priority | ||
309 | * @param notify_cls closure for @a notify | ||
310 | * @return non-NULL if the notify callback was queued, | ||
311 | * NULL if we can not even queue the request (insufficient | ||
312 | * memory); if NULL is returned, @a notify will NOT be called. | ||
313 | */ | ||
314 | struct GNUNET_MESH_TransmitHandle * | ||
315 | GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Channel *channel, | ||
316 | int cork, | ||
317 | struct GNUNET_TIME_Relative maxdelay, | ||
318 | size_t notify_size, | ||
319 | GNUNET_CONNECTION_TransmitReadyNotify notify, | ||
320 | void *notify_cls); | ||
321 | |||
322 | |||
323 | /** | ||
324 | * Cancel the specified transmission-ready notification. | ||
325 | * | ||
326 | * @param th handle that was returned by "notify_transmit_ready". | ||
327 | */ | ||
328 | void | ||
329 | GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle | ||
330 | *th); | ||
331 | |||
332 | |||
333 | /** | ||
334 | * Indicate readiness to receive the next message on a channel. | ||
335 | * | ||
336 | * Should only be called once per handler called. | ||
337 | * | ||
338 | * @param channel Channel that will be allowed to call another handler. | ||
339 | */ | ||
340 | void | ||
341 | GNUNET_MESH_receive_done (struct GNUNET_MESH_Channel *channel); | ||
342 | |||
343 | |||
344 | |||
345 | /******************************************************************************/ | ||
346 | /******************** MONITORING /DEBUG API *************************/ | ||
347 | /******************************************************************************/ | ||
348 | /* The following calls are not useful for normal MESH operation, but for */ | ||
349 | /* debug and monitoring of the mesh state. They can be safely ignored. */ | ||
350 | /* The API can change at any point without notice. */ | ||
351 | /* Please contact the developer if you consider any of this calls useful for */ | ||
352 | /* normal mesh applications. */ | ||
353 | /******************************************************************************/ | ||
354 | |||
355 | /** | ||
356 | * Method called to retrieve information about each channel the mesh peer | ||
357 | * is aware of. | ||
358 | * | ||
359 | * @param cls Closure. | ||
360 | * @param channel_number Channel number. | ||
361 | * @param origin that started the channel (owner). | ||
362 | * @param target other endpoint of the channel | ||
363 | */ | ||
364 | typedef void (*GNUNET_MESH_ChannelsCB) (void *cls, | ||
365 | uint32_t channel_number, | ||
366 | const struct GNUNET_PeerIdentity *origin, | ||
367 | const struct GNUNET_PeerIdentity *target); | ||
368 | |||
369 | |||
370 | /** | ||
371 | * Method called to retrieve information about a specific channel the mesh peer | ||
372 | * is aware of, including all transit nodes. | ||
373 | * | ||
374 | * @param cls Closure. | ||
375 | * @param peer Peer in the channel's tree. | ||
376 | * @param parent Parent of the current peer. All 0 when peer is root. | ||
377 | */ | ||
378 | typedef void (*GNUNET_MESH_ChannelCB) (void *cls, | ||
379 | const struct GNUNET_PeerIdentity *peer, | ||
380 | const struct GNUNET_PeerIdentity *parent); | ||
381 | |||
382 | |||
383 | /** | ||
384 | * Request information about the running mesh peer. | ||
385 | * The callback will be called for every channel known to the service, | ||
386 | * listing all active peers that belong to the channel. | ||
387 | * | ||
388 | * If called again on the same handle, it will overwrite the previous | ||
389 | * callback and cls. To retrieve the cls, monitor_cancel must be | ||
390 | * called first. | ||
391 | * | ||
392 | * WARNING: unstable API, likely to change in the future! | ||
393 | * | ||
394 | * @param h Handle to the mesh peer. | ||
395 | * @param callback Function to call with the requested data. | ||
396 | * @param callback_cls Closure for @c callback. | ||
397 | */ | ||
398 | void | ||
399 | GNUNET_MESH_get_channels (struct GNUNET_MESH_Handle *h, | ||
400 | GNUNET_MESH_ChannelsCB callback, | ||
401 | void *callback_cls); | ||
402 | |||
403 | |||
404 | /** | ||
405 | * Request information about a specific channel of the running mesh peer. | ||
406 | * | ||
407 | * WARNING: unstable API, likely to change in the future! | ||
408 | * | ||
409 | * @param h Handle to the mesh peer. | ||
410 | * @param initiator ID of the owner of the channel. | ||
411 | * @param channel_number Channel number. | ||
412 | * @param callback Function to call with the requested data. | ||
413 | * @param callback_cls Closure for @c callback. | ||
414 | */ | ||
415 | void | ||
416 | GNUNET_MESH_show_channel (struct GNUNET_MESH_Handle *h, | ||
417 | struct GNUNET_PeerIdentity *initiator, | ||
418 | uint32_t channel_number, | ||
419 | GNUNET_MESH_ChannelCB callback, | ||
420 | void *callback_cls); | ||
421 | |||
422 | |||
423 | /** | ||
424 | * Cancel a monitor request. The monitor callback will not be called. | ||
425 | * | ||
426 | * WARNING: unstable API, likely to change in the future! | ||
427 | * | ||
428 | * @param h Mesh handle. | ||
429 | * | ||
430 | * @return Closure given to GNUNET_MESH_monitor, if any. | ||
431 | */ | ||
432 | void * | ||
433 | GNUNET_MESH_get_channels_cancel (struct GNUNET_MESH_Handle *h); | ||
434 | |||
435 | |||
436 | /** | ||
437 | * Create a message queue for a mesh channel. | ||
438 | * The message queue can only be used to transmit messages, | ||
439 | * not to receive them. | ||
440 | * | ||
441 | * @param channel the channel to create the message qeue for | ||
442 | * @return a message queue to messages over the channel | ||
443 | */ | ||
444 | struct GNUNET_MQ_Handle * | ||
445 | GNUNET_MESH_mq_create (struct GNUNET_MESH_Channel *channel); | ||
446 | |||
447 | |||
448 | #if 0 /* keep Emacsens' auto-indent happy */ | ||
449 | { | ||
450 | #endif | ||
451 | #ifdef __cplusplus | ||
452 | } | ||
453 | #endif | ||
454 | |||
455 | /* ifndef GNUNET_MESH_SERVICE_H */ | ||
456 | #endif | ||
457 | /* end of gnunet_mesh_service.h */ | ||