Added new test for multiple clients on one peer
[oweals/gnunet.git] / src / mesh / mesh_api_new.c
1 /*
2      This file is part of GNUnet.
3      (C) 2011 Christian Grothoff (and other contributing authors)
4      GNUnet is free software; you can redistribute it and/or modify
5      it under the terms of the GNU General Public License as published
6      by the Free Software Foundation; either version 3, or (at your
7      option) any later version.
8      GNUnet is distributed in the hope that it will be useful, but
9      WITHOUT ANY WARRANTY; without even the implied warranty of
10      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11      General Public License for more details.
12      You should have received a copy of the GNU General Public License
13      along with GNUnet; see the file COPYING.  If not, write to the
14      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
15      Boston, MA 02111-1307, USA.
16 */
17
18 /**
19  * @file mesh/mesh_api_new.c
20  * @brief mesh api: client implementation of mesh service
21  * @author Bartlomiej Polot
22  *
23  * STRUCTURE:
24  * - CONSTANTS
25  * - DATA STRUCTURES
26  * - AUXILIARY FUNCTIONS
27  * - RECEIVE HANDLERS
28  * - SEND FUNCTIONS
29  * - API CALL DEFINITIONS
30  */
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #if 0                           /* keep Emacsens' auto-indent happy */
35 }
36 #endif
37 #endif
38
39 #include "platform.h"
40 #include "gnunet_common.h"
41 #include "gnunet_client_lib.h"
42 #include "gnunet_util_lib.h"
43 #include "gnunet_peer_lib.h"
44 #include "gnunet_mesh_service_new.h"
45 #include "mesh.h"
46 #include "mesh_protocol.h"
47
48 #define DEBUG GNUNET_YES
49
50 /******************************************************************************/
51 /************************      DATA STRUCTURES     ****************************/
52 /******************************************************************************/
53
54 /**
55  * Transmission queue to the service
56  */
57 struct GNUNET_MESH_TransmitHandle
58 {
59
60     /**
61      * Double Linked list
62      */
63   struct GNUNET_MESH_TransmitHandle *next;
64
65     /**
66      * Double Linked list
67      */
68   struct GNUNET_MESH_TransmitHandle *prev;
69
70     /**
71      * Tunnel this message is sent over (may be NULL for control messages).
72      */
73   struct GNUNET_MESH_Tunnel *tunnel;
74
75     /**
76      * Callback to obtain the message to transmit, or NULL if we
77      * got the message in 'data'.  Notice that messages built
78      * by 'notify' need to be encapsulated with information about
79      * the 'target'.
80      */
81   GNUNET_CONNECTION_TransmitReadyNotify notify;
82
83     /**
84      * Closure for 'notify'
85      */
86   void *notify_cls;
87
88     /**
89      * How long is this message valid.  Once the timeout has been
90      * reached, the message must no longer be sent.  If this
91      * is a message with a 'notify' callback set, the 'notify'
92      * function should be called with 'buf' NULL and size 0.
93      */
94   struct GNUNET_TIME_Absolute timeout;
95
96     /**
97      * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
98      */
99   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
100
101     /**
102      * Priority of the message.  The queue is sorted by priority,
103      * control messages have the maximum priority (UINT32_MAX).
104      */
105   uint32_t priority;
106
107     /**
108      * Target of the message, 0 for broadcast.  This field
109      * is only valid if 'notify' is non-NULL.
110      */
111   GNUNET_PEER_Id target;
112
113     /**
114      * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
115      */
116   size_t size;
117 };
118
119
120 /**
121  * Opaque handle to the service.
122  */
123 struct GNUNET_MESH_Handle
124 {
125
126     /**
127      * Handle to the server connection, to send messages later
128      */
129   struct GNUNET_CLIENT_Connection *client;
130
131     /**
132      * Set of handlers used for processing incoming messages in the tunnels
133      */
134   const struct GNUNET_MESH_MessageHandler *message_handlers;
135
136     /**
137      * Set of applications that should be claimed to be offered at this node.
138      * Note that this is just informative, the appropiate handlers must be
139      * registered independently and the mapping is up to the developer of the
140      * client application.
141      */
142   const GNUNET_MESH_ApplicationType *applications;
143
144     /**
145      * Double linked list of the tunnels this client is connected to.
146      */
147   struct GNUNET_MESH_Tunnel *tunnels_head;
148   struct GNUNET_MESH_Tunnel *tunnels_tail;
149
150     /**
151      * Callback for inbound tunnel creation
152      */
153   GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
154
155     /**
156      * Callback for inbound tunnel disconnection
157      */
158   GNUNET_MESH_TunnelEndHandler *cleaner;
159
160     /**
161      * Handle to cancel pending transmissions in case of disconnection
162      */
163   struct GNUNET_CLIENT_TransmitHandle *th;
164
165     /**
166      * Closure for all the handlers given by the client
167      */
168   void *cls;
169
170     /**
171      * Messages to send to the service
172      */
173   struct GNUNET_MESH_TransmitHandle *th_head;
174   struct GNUNET_MESH_TransmitHandle *th_tail;
175
176     /**
177      * tid of the next tunnel to create (to avoid reusing IDs often)
178      */
179   MESH_TunnelNumber next_tid;
180   unsigned int n_handlers;
181   unsigned int n_applications;
182   unsigned int max_queue_size;
183
184     /**
185      * Have we started the task to receive messages from the service
186      * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
187      */
188   int in_receive;
189
190     /**
191      * Number of packets queued
192      */
193   unsigned int npackets;
194
195   /**
196    * Configuration given by the client, in case of reconnection
197    */
198   const struct GNUNET_CONFIGURATION_Handle *cfg;
199
200   /**
201    * Time to the next reconnect in case one reconnect fails
202    */
203   struct GNUNET_TIME_Relative reconnect_time;
204 };
205
206
207 /**
208  * Description of a peer
209  */
210 struct GNUNET_MESH_Peer
211 {
212     /**
213      * ID of the peer in short form
214      */
215   GNUNET_PEER_Id id;
216
217   /**
218    * Tunnel this peer belongs to
219    */
220   struct GNUNET_MESH_Tunnel *t;
221
222   /**
223    * Flag indicating whether service has informed about its connection
224    */
225   int connected;
226
227 };
228
229
230 /**
231  * Opaque handle to a tunnel.
232  */
233 struct GNUNET_MESH_Tunnel
234 {
235
236     /**
237      * DLL
238      */
239   struct GNUNET_MESH_Tunnel *next;
240   struct GNUNET_MESH_Tunnel *prev;
241
242     /**
243      * Callback to execute when peers connect to the tunnel
244      */
245   GNUNET_MESH_TunnelConnectHandler connect_handler;
246
247     /**
248      * Callback to execute when peers disconnect from the tunnel
249      */
250   GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
251
252     /**
253      * Closure for the connect/disconnect handlers
254      */
255   void *cls;
256
257     /**
258      * Handle to the mesh this tunnel belongs to
259      */
260   struct GNUNET_MESH_Handle *mesh;
261
262     /**
263      * Local ID of the tunnel
264      */
265   MESH_TunnelNumber tid;
266
267     /**
268      * Owner of the tunnel
269      */
270   GNUNET_PEER_Id owner;
271
272     /**
273      * All peers added to the tunnel
274      */
275   struct GNUNET_MESH_Peer **peers;
276
277   /**
278    * List of application types that have been requested for this tunnel
279    */
280   GNUNET_MESH_ApplicationType *apps;
281
282   /**
283    * Any data the caller wants to put in here
284    */
285   void *ctx;
286
287   /**
288      * Number of peers added to the tunnel
289      */
290   unsigned int npeers;
291
292     /**
293      * Number of packets queued in this tunnel
294      */
295   unsigned int npackets;
296
297     /**
298      * Number of applications requested this tunnel
299      */
300   unsigned int napps;
301
302 };
303
304
305 /******************************************************************************/
306 /***********************     AUXILIARY FUNCTIONS      *************************/
307 /******************************************************************************/
308
309 /**
310  * Get the tunnel handler for the tunnel specified by id from the given handle
311  * @param h Mesh handle
312  * @param tid ID of the wanted tunnel
313  * @return handle to the required tunnel or NULL if not found
314  */
315 static struct GNUNET_MESH_Tunnel *
316 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
317 {
318   struct GNUNET_MESH_Tunnel *t;
319
320   t = h->tunnels_head;
321   while (t != NULL)
322   {
323     if (t->tid == tid)
324       return t;
325     t = t->next;
326   }
327   return NULL;
328 }
329
330
331 /**
332  * Create a new tunnel and insert it in the tunnel list of the mesh handle
333  * @param h Mesh handle
334  * @param tid desired tid of the tunnel, 0 to assign one automatically
335  * @return handle to the created tunnel
336  */
337 static struct GNUNET_MESH_Tunnel *
338 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
339 {
340   struct GNUNET_MESH_Tunnel *t;
341
342   t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
343   GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
344   t->mesh = h;
345   if (0 == tid)
346   {
347     t->tid = h->next_tid;
348     while (NULL != retrieve_tunnel (h, h->next_tid))
349     {
350       h->next_tid++;
351       h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
352       h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
353     }
354   }
355   else
356   {
357     t->tid = tid;
358   }
359   return t;
360 }
361
362
363 /**
364  * Destroy the specified tunnel.
365  * - Destroys all peers, calling the disconnect callback on each if needed
366  * - Cancels all outgoing traffic for that tunnel, calling respective notifys
367  * - Calls cleaner if tunnel was inbound
368  * - Frees all memory used
369  * @param tid ID of the wanted tunnel
370  * @return handle to the required tunnel or NULL if not found
371  */
372 static void
373 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
374 {
375   struct GNUNET_MESH_Handle *h;
376   struct GNUNET_PeerIdentity pi;
377   struct GNUNET_MESH_TransmitHandle *th;
378   struct GNUNET_MESH_TransmitHandle *aux;
379   unsigned int i;
380
381   if (NULL == t)
382   {
383     GNUNET_break(0);
384     return;
385   }
386   h = t->mesh;
387   th = h->th_head;
388   while (NULL != th)
389   {
390     if (th->tunnel == t)
391     {
392       aux = th->next;
393       GNUNET_CONTAINER_DLL_remove(h->th_head, h->th_tail, th);
394       if (NULL == h->th_head && NULL != h->th)
395       {
396         GNUNET_CLIENT_notify_transmit_ready_cancel(h->th);
397         h->th = NULL;
398       }
399       if (NULL != th->notify)
400           th->notify(th->notify_cls, 0, NULL);
401       if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
402           GNUNET_SCHEDULER_cancel(th->timeout_task);
403       GNUNET_free (th);
404       th = aux;
405     }
406     else
407     {
408       th = th->next;
409     }
410   }
411   GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
412   for (i = 0; i < t->npeers; i++)
413   {
414     if (NULL != t->disconnect_handler && t->peers[i]->connected)
415     {
416       GNUNET_PEER_resolve (t->peers[i]->id, &pi);
417       t->disconnect_handler (t->cls, &pi);
418     }
419     GNUNET_PEER_change_rc (t->peers[i]->id, -1);
420     GNUNET_free (t->peers[i]);
421   }
422   if (t->npeers > 0)
423       GNUNET_free (t->peers);
424   if (NULL != h->cleaner && 0 != t->owner)
425     h->cleaner (h->cls, t, t->ctx);
426   if (0 != t->owner)
427     GNUNET_PEER_change_rc (t->owner, -1);
428   if (0 != t->napps && t->apps)
429     GNUNET_free (t->apps);
430   GNUNET_free (t);
431   return;
432 }
433
434
435 /**
436  * Get the peer descriptor for the peer with id from the given tunnel
437  * @param t Tunnel handle
438  * @param id Short form ID of the wanted peer
439  * @return handle to the requested peer or NULL if not found
440  */
441 static struct GNUNET_MESH_Peer *
442 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
443 {
444   unsigned int i;
445
446   for (i = 0; i < t->npeers; i++)
447     if (t->peers[i]->id == id)
448       return t->peers[i];
449   return NULL;
450 }
451
452
453 /**
454  * Add a peer into a tunnel
455  * @param t Tunnel handle
456  * @param pi Full ID of the new peer
457  * @return handle to the newly created peer
458  */
459 static struct GNUNET_MESH_Peer *
460 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
461                     const struct GNUNET_PeerIdentity *pi)
462 {
463   struct GNUNET_MESH_Peer *p;
464   GNUNET_PEER_Id id;
465
466   if (0 != t->owner)
467   {
468     GNUNET_break (0);
469     return NULL;
470   }
471   id = GNUNET_PEER_intern (pi);
472
473   p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
474   p->id = id;
475   p->t = t;
476   GNUNET_array_append (t->peers, t->npeers, p);
477   return p;
478 }
479
480
481 /**
482  * Remove a peer from a tunnel
483  * @param t Tunnel handle
484  * @param p Peer handle
485  */
486 static void
487 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
488 {
489   unsigned int i;
490
491   for (i = 0; i < p->t->npeers; i++)
492   {
493     if (p->t->peers[i] == p)
494       break;
495   }
496   if (i == p->t->npeers)
497   {
498     GNUNET_break (0);
499     return;
500   }
501   p->t->peers[i] = p->t->peers[p->t->npeers - 1];
502   GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
503 }
504
505
506 /**
507  * Notify client that the transmission has timed out
508  * @param cls closure
509  * @param tc task context
510  */
511 static void
512 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
513 {
514   struct GNUNET_MESH_TransmitHandle *th = cls;
515   struct GNUNET_MESH_Handle *mesh;
516
517   mesh = th->tunnel->mesh;
518   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
519   if (th->notify != NULL)
520     th->notify (th->notify_cls, 0, NULL);
521   GNUNET_free (th);
522   if ((NULL == mesh->th_head) && (NULL != mesh->th))
523   {
524     /* queue empty, no point in asking for transmission */
525     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
526     mesh->th = NULL;
527   }
528 }
529
530
531 /**
532  * Add a transmit handle to the transmission queue by priority and set the
533  * timeout if needed.
534  *
535  * @param h mesh handle with the queue head and tail
536  * @param q handle to the packet to be transmitted
537  */
538 static void
539 add_to_queue (struct GNUNET_MESH_Handle *h,
540               struct GNUNET_MESH_TransmitHandle *th)
541 {
542   struct GNUNET_MESH_TransmitHandle *p;
543
544   p = h->th_head;
545   while ((NULL != p) && (th->priority <= p->priority))
546     p = p->next;
547   if (NULL == p)
548     p = h->th_tail;
549   else
550     p = p->prev;
551   GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
552   if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
553     return;
554   th->timeout_task =
555       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
556                                     (th->timeout), &timeout_transmission, th);
557 }
558
559
560 /**
561  * Auxiliary function to send an already constructed packet to the service.
562  * Takes care of creating a new queue element, copying the message and
563  * calling the tmt_rdy function if necessary.
564  * @param h mesh handle
565  * @param msg message to transmit
566  */
567 static void
568 send_packet (struct GNUNET_MESH_Handle *h,
569              const struct GNUNET_MessageHeader *msg);
570
571
572 /**
573  * Reconnect callback: tries to reconnect again after a failer previous
574  * reconnecttion
575  * @param cls closure (mesh handle)
576  * @param tc task context
577  */
578 static void
579 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
580
581
582 /**
583  * Reconnect to the service, retransmit all infomation to try to restore the
584  * original state.
585  *
586  * @param h handle to the mesh
587  *
588  * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
589  */
590 static int
591 reconnect (struct GNUNET_MESH_Handle *h)
592 {
593   struct GNUNET_MESH_Tunnel *t;
594   unsigned int i;
595
596   h->in_receive = GNUNET_NO;
597   /* disconnect */
598   if (NULL != h->th)
599   {
600     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
601   }
602   if (NULL != h->client)
603   {
604     GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
605   }
606
607   /* connect again */
608   h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
609   if (h->client == NULL)
610   {
611     GNUNET_SCHEDULER_add_delayed(h->reconnect_time, &reconnect_cbk, h);
612     h->reconnect_time = GNUNET_TIME_relative_min(GNUNET_TIME_UNIT_HOURS,
613         GNUNET_TIME_relative_multiply(h->reconnect_time, 2));
614     GNUNET_break (0);
615     return GNUNET_NO;
616   }
617   else
618   {
619     h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
620   }
621   /* Rebuild all tunnels */
622   for (t = h->tunnels_head; NULL != t; t = t->next)
623   {
624     struct GNUNET_MESH_TunnelMessage tmsg;
625     struct GNUNET_MESH_PeerControl pmsg;
626
627     tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
628     tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
629     tmsg.tunnel_id = htonl (t->tid);
630     send_packet (h, &tmsg.header);
631
632     pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
633     pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
634     pmsg.tunnel_id = htonl (t->tid);
635
636     /* Reconnect all peers */
637     for (i = 0; i < t->npeers; i++)
638     {
639       GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
640       if (NULL != t->disconnect_handler && t->peers[i]->connected)
641         t->disconnect_handler (t->cls, &pmsg.peer);
642       /* If the tunnel was "by type", dont connect individual peers */
643       if (0 == t->napps)
644         send_packet (t->mesh, &pmsg.header);
645     }
646     /* Reconnect all types, if any  */
647     for (i = 0; i < t->napps; i++)
648     {
649       struct GNUNET_MESH_ConnectPeerByType msg;
650
651       msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
652       msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
653       msg.tunnel_id = htonl (t->tid);
654       msg.type = htonl (t->apps[i]);
655       send_packet (t->mesh, &msg.header);
656     }
657   }
658   return GNUNET_YES;
659 }
660
661 /**
662  * Reconnect callback: tries to reconnect again after a failer previous
663  * reconnecttion
664  * @param cls closure (mesh handle)
665  * @param tc task context
666  */
667 static void
668 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
669 {
670   struct GNUNET_MESH_Handle *h = cls;
671   if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
672     return;
673   reconnect(h);
674 }
675
676
677 /******************************************************************************/
678 /***********************      RECEIVE HANDLERS     ****************************/
679 /******************************************************************************/
680
681 /**
682  * Process the new tunnel notification and add it to the tunnels in the handle
683  *
684  * @param h     The mesh handle
685  * @param msg   A message with the details of the new incoming tunnel
686  */
687 static void
688 process_tunnel_created (struct GNUNET_MESH_Handle *h,
689                        const struct GNUNET_MESH_TunnelNotification *msg)
690 {
691   struct GNUNET_MESH_Tunnel *t;
692   struct GNUNET_TRANSPORT_ATS_Information atsi;
693   MESH_TunnelNumber tid;
694
695   tid = ntohl (msg->tunnel_id);
696   if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
697   {
698     GNUNET_break (0);
699     return;
700   }
701   t = create_tunnel (h, tid);
702   t->owner = GNUNET_PEER_intern (&msg->peer);
703   t->npeers = 1;
704   t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
705   t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
706   t->peers[0]->t = t;
707   t->peers[0]->connected = 1;
708   t->peers[0]->id = t->owner;
709   t->mesh = h;
710   t->tid = tid;
711   if (NULL != h->new_tunnel)
712   {
713     atsi.type = 0;
714     atsi.value = 0;
715     t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
716   }
717   GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
718   return;
719 }
720
721
722 /**
723  * Process the tunnel destroy notification and free associated resources
724  *
725  * @param h     The mesh handle
726  * @param msg   A message with the details of the tunnel being destroyed
727  */
728 static void
729 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
730                         const struct GNUNET_MESH_TunnelMessage *msg)
731 {
732   struct GNUNET_MESH_Tunnel *t;
733   MESH_TunnelNumber tid;
734
735   tid = ntohl (msg->tunnel_id);
736   t = retrieve_tunnel (h, tid);
737
738   if (NULL == t)
739   {
740     GNUNET_break(0);
741     return;
742   }
743   if (0 == t->owner)
744   {
745     GNUNET_break(0);
746   }
747
748   destroy_tunnel(t);
749   return;
750 }
751
752
753 /**
754  * Process the new peer event and notify the upper level of it
755  *
756  * @param h     The mesh handle
757  * @param msg   A message with the details of the peer event
758  */
759 static void
760 process_peer_event (struct GNUNET_MESH_Handle *h,
761                     const struct GNUNET_MESH_PeerControl *msg)
762 {
763   struct GNUNET_MESH_Tunnel *t;
764   struct GNUNET_MESH_Peer *p;
765   struct GNUNET_TRANSPORT_ATS_Information atsi;
766   GNUNET_PEER_Id id;
767   uint16_t size;
768
769   size = ntohs (msg->header.size);
770   if (size != sizeof (struct GNUNET_MESH_PeerControl))
771   {
772     GNUNET_break (0);
773     return;
774   }
775   t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
776   if (NULL == t)
777   {
778     GNUNET_break(0);
779     return;
780   }
781   id = GNUNET_PEER_search (&msg->peer);
782   if ((p = retrieve_peer (t, id)) == NULL)
783     p = add_peer_to_tunnel (t, &msg->peer);
784   if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
785   {
786     if (NULL != t->connect_handler)
787     {
788       atsi.type = 0;
789       atsi.value = 0;
790       t->connect_handler (t->cls, &msg->peer, &atsi);
791     }
792     p->connected = 1;
793   }
794   else
795   {
796     if (NULL != t->disconnect_handler && p->connected)
797     {
798       t->disconnect_handler (t->cls, &msg->peer);
799     }
800     remove_peer_from_tunnel (p);
801     GNUNET_free (p);
802   }
803 }
804
805
806 /**
807  * Process the incoming data packets
808  *
809  * @param h     The mesh handle
810  * @param msh   A message encapsulating the data
811  */
812 static void
813 process_incoming_data (struct GNUNET_MESH_Handle *h,
814                        const struct GNUNET_MessageHeader *message)
815 {
816   const struct GNUNET_MessageHeader *payload;
817   const struct GNUNET_MESH_MessageHandler *handler;
818   const struct GNUNET_PeerIdentity *peer;
819   struct GNUNET_MESH_Unicast *ucast;
820   struct GNUNET_MESH_Multicast *mcast;
821   struct GNUNET_MESH_ToOrigin *to_orig;
822   struct GNUNET_MESH_Tunnel *t;
823   unsigned int i;
824   uint16_t type;
825
826
827   type = ntohs (message->type);
828   switch (type)
829   {
830   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
831     ucast = (struct GNUNET_MESH_Unicast *) message;
832     t = retrieve_tunnel (h, ntohl (ucast->tid));
833     payload = (struct GNUNET_MessageHeader *) &ucast[1];
834     peer = &ucast->oid;
835     break;
836   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
837     mcast = (struct GNUNET_MESH_Multicast *) message;
838     t = retrieve_tunnel (h, ntohl (mcast->tid));
839     payload = (struct GNUNET_MessageHeader *) &mcast[1];
840     peer = &mcast->oid;
841     break;
842   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
843     to_orig = (struct GNUNET_MESH_ToOrigin *) message;
844     t = retrieve_tunnel (h, ntohl (to_orig->tid));
845     payload = (struct GNUNET_MessageHeader *) &to_orig[1];
846     peer = &to_orig->sender;
847     break;
848   default:
849     GNUNET_break (0);
850     return;
851   }
852   if (NULL == t)
853   {
854     GNUNET_break (0);
855     return;
856   }
857   type = ntohs(payload->type);
858   for (i = 0; i < h->n_handlers; i++)
859   {
860     handler = &h->message_handlers[i];
861     if (handler->type == type)
862     {
863       struct GNUNET_TRANSPORT_ATS_Information atsi;
864
865       atsi.type = 0;
866       atsi.value = 0;
867       if (GNUNET_OK !=
868           handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
869       {
870         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
871                     "MESH: callback caused disconnection\n");
872         GNUNET_MESH_disconnect (h);
873       }
874 #if DEBUG
875       else
876       {
877         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
878                     "MESH: callback completed successfully\n");
879
880       }
881 #endif
882     }
883   }
884 }
885
886
887 /**
888  * Function to process all messages received from the service
889  *
890  * @param cls closure
891  * @param msg message received, NULL on timeout or fatal error
892  */
893 static void
894 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
895 {
896   struct GNUNET_MESH_Handle *h = cls;
897
898   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
899   if (msg == NULL)
900   {
901     reconnect (h);
902     return;
903   }
904   switch (ntohs (msg->type))
905   {
906     /* Notify of a new incoming tunnel */
907   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
908     process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
909     break;
910     /* Notify of a tunnel disconnection */
911   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
912     process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
913     break;
914     /* Notify of a new peer or a peer disconnect in the tunnel */
915   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
916   case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
917     process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
918     break;
919     /* Notify of a new data packet in the tunnel */
920   case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
921   case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
922   case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
923     process_incoming_data (h, msg);
924     break;
925     /* We shouldn't get any other packages, log and ignore */
926   default:
927     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
928                 "MESH: unsolicited message form service (type %d)\n",
929                 ntohs (msg->type));
930   }
931   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
932   GNUNET_CLIENT_receive (h->client, &msg_received, h,
933                          GNUNET_TIME_UNIT_FOREVER_REL);
934 }
935
936
937 /******************************************************************************/
938 /************************       SEND FUNCTIONS     ****************************/
939 /******************************************************************************/
940
941 /**
942  * Function called to send a message to the service.
943  * "buf" will be NULL and "size" zero if the socket was closed for writing in
944  * the meantime.
945  *
946  * @param cls closure, the mesh handle
947  * @param size number of bytes available in buf
948  * @param buf where the callee should write the connect message
949  * @return number of bytes written to buf
950  */
951 static size_t
952 send_callback (void *cls, size_t size, void *buf)
953 {
954   struct GNUNET_MESH_Handle *h = cls;
955   struct GNUNET_MESH_TransmitHandle *th;
956   char *cbuf = buf;
957   size_t tsize;
958   size_t psize;
959
960   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
961   h->th = NULL;
962   if ((0 == size) || (NULL == buf))
963   {
964     reconnect (h);
965     return 0;
966   }
967   tsize = 0;
968   while ((NULL != (th = h->th_head)) && (size >= th->size))
969   {
970 #if DEBUG
971     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     type: %u\n",
972                 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
973     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:     size: %u\n",
974                 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
975 #endif
976     if (NULL != th->notify)
977     {
978       if (th->target == 0)
979       {
980         /* multicast */
981         struct GNUNET_MESH_Multicast mc;
982
983         GNUNET_assert (size >= sizeof (mc) + th->size);
984         psize =
985             th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
986         if (psize > 0)
987         {
988           mc.header.size = htons (sizeof (mc) + th->size);
989           mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
990           mc.tid = htonl (th->tunnel->tid);
991           memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
992           memcpy (cbuf, &mc, sizeof (mc));
993           psize = th->size + sizeof (mc);
994         }
995       }
996       else
997       {
998         /* unicast */
999         struct GNUNET_MESH_Unicast uc;
1000
1001         GNUNET_assert (size >= sizeof (uc) + th->size);
1002         psize =
1003             th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
1004         if (psize > 0)
1005         {
1006           uc.header.size = htons (sizeof (uc) + th->size);
1007           uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1008           uc.tid = htonl (th->tunnel->tid);
1009           memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));     /* myself */
1010           GNUNET_PEER_resolve (th->target, &uc.destination);
1011           memcpy (cbuf, &uc, sizeof (uc));
1012           psize = th->size + sizeof (uc);
1013         }
1014       }
1015     }
1016     else
1017     {
1018       memcpy (cbuf, &th[1], th->size);
1019       psize = th->size;
1020     }
1021     if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1022       GNUNET_SCHEDULER_cancel (th->timeout_task);
1023     GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1024     GNUNET_free (th);
1025     cbuf += psize;
1026     size -= psize;
1027     tsize += psize;
1028   }
1029   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   total size: %u\n", tsize);
1030   if (NULL != (th = h->th_head))
1031   {
1032     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh:   next size: %u\n", th->size);
1033     h->th =
1034         GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1035                                              GNUNET_TIME_UNIT_FOREVER_REL,
1036                                              GNUNET_YES, &send_callback, h);
1037   }
1038   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1039   if (GNUNET_NO == h->in_receive)
1040   {
1041     h->in_receive = GNUNET_YES;
1042     GNUNET_CLIENT_receive (h->client, &msg_received, h,
1043                            GNUNET_TIME_UNIT_FOREVER_REL);
1044   }
1045   return tsize;
1046 }
1047
1048
1049 /**
1050  * Auxiliary function to send an already constructed packet to the service.
1051  * Takes care of creating a new queue element, copying the message and
1052  * calling the tmt_rdy function if necessary.
1053  * @param h mesh handle
1054  * @param msg message to transmit
1055  */
1056 static void
1057 send_packet (struct GNUNET_MESH_Handle *h,
1058              const struct GNUNET_MessageHeader *msg)
1059 {
1060   struct GNUNET_MESH_TransmitHandle *th;
1061   size_t msize;
1062
1063   msize = ntohs (msg->size);
1064   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1065   th->priority = UINT32_MAX;
1066   th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1067   th->size = msize;
1068   memcpy (&th[1], msg, msize);
1069   add_to_queue (h, th);
1070   if (NULL != h->th)
1071     return;
1072   h->th =
1073       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1074                                            GNUNET_TIME_UNIT_FOREVER_REL,
1075                                            GNUNET_YES, &send_callback, h);
1076 }
1077
1078
1079 /******************************************************************************/
1080 /**********************      API CALL DEFINITIONS     *************************/
1081 /******************************************************************************/
1082
1083 /**
1084  * Connect to the mesh service.
1085  *
1086  * @param cfg configuration to use
1087  * @param queue_size size of the data message queue, shared among all tunnels
1088  *                   (each tunnel is guaranteed to accept at least one message,
1089  *                    no matter what is the status of other tunnels)
1090  * @param cls closure for the various callbacks that follow
1091  *            (including handlers in the handlers array)
1092  * @param new_tunnel function called when an *inbound* tunnel is created
1093  * @param cleaner function called when an *inbound* tunnel is destroyed
1094  * @param handlers callbacks for messages we care about, NULL-terminated
1095  *                note that the mesh is allowed to drop notifications about
1096  *                inbound messages if the client does not process them fast
1097  *                enough (for this notification type, a bounded queue is used)
1098  * @param stypes list of the applications that this client claims to provide
1099  * @return handle to the mesh service NULL on error
1100  *         (in this case, init is never called)
1101  */
1102 struct GNUNET_MESH_Handle *
1103 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1104                      unsigned int queue_size, void *cls,
1105                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1106                      GNUNET_MESH_TunnelEndHandler cleaner,
1107                      const struct GNUNET_MESH_MessageHandler *handlers,
1108                      const GNUNET_MESH_ApplicationType *stypes)
1109 {
1110   struct GNUNET_MESH_Handle *h;
1111   struct GNUNET_MESH_ClientConnect *msg;
1112   GNUNET_MESH_ApplicationType *apps;
1113   uint16_t napps;
1114   uint16_t *types;
1115   uint16_t ntypes;
1116   size_t size;
1117
1118   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1119   h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1120   h->cfg = cfg;
1121   h->max_queue_size = queue_size;
1122   h->new_tunnel = new_tunnel;
1123   h->cleaner = cleaner;
1124   h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1125   if (h->client == NULL)
1126   {
1127     GNUNET_break (0);
1128     GNUNET_free (h);
1129     return NULL;
1130   }
1131   h->cls = cls;
1132   h->message_handlers = handlers;
1133   h->applications = stypes;
1134   h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1135   h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1136
1137   /* count handlers and apps, calculate size */
1138   for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1139   for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1140   size = sizeof (struct GNUNET_MESH_ClientConnect);
1141   size += h->n_handlers * sizeof (uint16_t);
1142   size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1143
1144   {
1145     char buf[size];
1146
1147     /* build connection packet */
1148     msg = (struct GNUNET_MESH_ClientConnect *) buf;
1149     msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1150     msg->header.size = htons (size);
1151     types = (uint16_t *) & msg[1];
1152     for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1153       types[ntypes] = h->message_handlers[ntypes].type;
1154     apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1155     for (napps = 0; napps < h->n_applications; napps++)
1156       apps[napps] = h->applications[napps];
1157     msg->applications = htons (napps);
1158     msg->types = htons (ntypes);
1159 #if DEBUG
1160     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1161                 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1162                 ntohs (msg->header.size), ntypes, napps);
1163 #endif
1164     send_packet (h, &msg->header);
1165   }
1166   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1167   return h;
1168 }
1169
1170
1171 /**
1172  * Disconnect from the mesh service.
1173  *
1174  * @param handle connection to mesh to disconnect
1175  */
1176 void
1177 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1178 {
1179   struct GNUNET_MESH_Tunnel *t;
1180   struct GNUNET_MESH_Tunnel *aux;
1181
1182   t = handle->tunnels_head;
1183   while (NULL != t)
1184   {
1185     aux = t->next;
1186     destroy_tunnel (t);
1187     t = aux;
1188   }
1189   if (NULL != handle->th)
1190   {
1191     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1192   }
1193   if (NULL != handle->client)
1194   {
1195     GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1196   }
1197   GNUNET_free (handle);
1198 }
1199
1200
1201 /**
1202  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1203  * and to broadcast).
1204  *
1205  * @param h mesh handle
1206  * @param tunnel_ctx client's tunnel context to associate with the tunnel
1207  * @param connect_handler function to call when peers are actually connected
1208  * @param disconnect_handler function to call when peers are disconnected
1209  * @param handler_cls closure for connect/disconnect handlers
1210  */
1211 struct GNUNET_MESH_Tunnel *
1212 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1213                            GNUNET_MESH_TunnelConnectHandler connect_handler,
1214                            GNUNET_MESH_TunnelDisconnectHandler
1215                            disconnect_handler, void *handler_cls)
1216 {
1217   struct GNUNET_MESH_Tunnel *t;
1218   struct GNUNET_MESH_TunnelMessage msg;
1219
1220   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1221   t = create_tunnel (h, 0);
1222   t->connect_handler = connect_handler;
1223   t->disconnect_handler = disconnect_handler;
1224   t->cls = handler_cls;
1225   t->ctx = tunnel_ctx;
1226   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1227   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1228   msg.tunnel_id = htonl (t->tid);
1229   send_packet (h, &msg.header);
1230   return t;
1231 }
1232
1233
1234 /**
1235  * Destroy an existing tunnel.
1236  *
1237  * @param tun tunnel handle
1238  */
1239 void
1240 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1241 {
1242   struct GNUNET_MESH_Handle *h;
1243   struct GNUNET_MESH_TunnelMessage msg;
1244
1245   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1246   h = t->mesh;
1247
1248   if (0 != t->owner)
1249     GNUNET_PEER_change_rc (t->owner, -1);
1250
1251   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1252   msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1253   msg.tunnel_id = htonl (t->tid);
1254   destroy_tunnel (t);
1255   send_packet (h, &msg.header);
1256 }
1257
1258
1259 /**
1260  * Request that a peer should be added to the tunnel.  The existing
1261  * connect handler will be called ONCE with either success or failure.
1262  * This function should NOT be called again with the same peer before the
1263  * connect handler is called.
1264  *
1265  * @param tunnel handle to existing tunnel
1266  * @param timeout how long to try to establish a connection
1267  * @param peer peer to add
1268  */
1269 void
1270 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1271                                       const struct GNUNET_PeerIdentity *peer)
1272 {
1273   struct GNUNET_MESH_PeerControl msg;
1274   GNUNET_PEER_Id peer_id;
1275   unsigned int i;
1276
1277   peer_id = GNUNET_PEER_intern (peer);
1278   for (i = 0; i < tunnel->npeers; i++)
1279   {
1280     if (tunnel->peers[i]->id == peer_id)
1281     {
1282       GNUNET_PEER_change_rc (peer_id, -1);
1283       GNUNET_break (0);
1284       return;
1285     }
1286   }
1287   if (NULL == add_peer_to_tunnel (tunnel, peer))
1288     return;
1289
1290   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1291   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1292   msg.tunnel_id = htonl (tunnel->tid);
1293   msg.peer = *peer;
1294   send_packet (tunnel->mesh, &msg.header);
1295
1296   return;
1297 }
1298
1299
1300 /**
1301  * Request that a peer should be removed from the tunnel.  The existing
1302  * disconnect handler will be called ONCE if we were connected.
1303  *
1304  * @param tunnel handle to existing tunnel
1305  * @param peer peer to remove
1306  */
1307 void
1308 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1309                                       const struct GNUNET_PeerIdentity *peer)
1310 {
1311   struct GNUNET_MESH_PeerControl msg;
1312   GNUNET_PEER_Id peer_id;
1313   unsigned int i;
1314
1315   peer_id = GNUNET_PEER_search (peer);
1316   if (0 == peer_id)
1317   {
1318     GNUNET_break (0);
1319     return;
1320   }
1321   for (i = 0; i < tunnel->npeers; i++)
1322     if (tunnel->peers[i]->id == peer_id)
1323       break;
1324   if (i == tunnel->npeers)
1325   {
1326     GNUNET_break (0);
1327     return;
1328   }
1329   if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1330     tunnel->disconnect_handler (tunnel->cls, peer);
1331   GNUNET_PEER_change_rc (peer_id, -1);
1332   GNUNET_free (tunnel->peers[i]);
1333   tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1334   GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1335
1336   msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1337   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1338   msg.tunnel_id = htonl (tunnel->tid);
1339   memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1340   send_packet (tunnel->mesh, &msg.header);
1341 }
1342
1343
1344 /**
1345  * Request that the mesh should try to connect to a peer supporting the given
1346  * message type.
1347  *
1348  * @param tunnel handle to existing tunnel
1349  * @param app_type application type that must be supported by the peer (MESH
1350  *                 should discover peer in proximity handling this type)
1351  */
1352 void
1353 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1354                                           GNUNET_MESH_ApplicationType app_type)
1355 {
1356   struct GNUNET_MESH_ConnectPeerByType msg;
1357
1358   GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1359
1360   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1361   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1362   msg.tunnel_id = htonl (tunnel->tid);
1363   msg.type = htonl (app_type);
1364   send_packet (tunnel->mesh, &msg.header);
1365 }
1366
1367
1368 /**
1369  * Ask the mesh to call "notify" once it is ready to transmit the
1370  * given number of bytes to the specified "target".  If we are not yet
1371  * connected to the specified peer, a call to this function will cause
1372  * us to try to establish a connection.
1373  *
1374  * @param tunnel tunnel to use for transmission
1375  * @param cork is corking allowed for this transmission?
1376  * @param priority how important is the message?
1377  * @param maxdelay how long can the message wait?
1378  * @param target destination for the message,
1379  *               NULL for multicast to all tunnel targets
1380  * @param notify_size how many bytes of buffer space does notify want?
1381  * @param notify function to call when buffer space is available;
1382  *        will be called with NULL on timeout or if the overall queue
1383  *        for this peer is larger than queue_size and this is currently
1384  *        the message with the lowest priority
1385  * @param notify_cls closure for notify
1386  * @return non-NULL if the notify callback was queued,
1387  *         NULL if we can not even queue the request (insufficient
1388  *         memory); if NULL is returned, "notify" will NOT be called.
1389  */
1390 struct GNUNET_MESH_TransmitHandle *
1391 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1392                                    uint32_t priority,
1393                                    struct GNUNET_TIME_Relative maxdelay,
1394                                    const struct GNUNET_PeerIdentity *target,
1395                                    size_t notify_size,
1396                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1397                                    void *notify_cls)
1398 {
1399   struct GNUNET_MESH_TransmitHandle *th;
1400   struct GNUNET_MESH_TransmitHandle *least_priority_th;
1401   uint32_t least_priority;
1402   size_t overhead;
1403
1404   GNUNET_assert(NULL != notify);
1405   if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1406       tunnel->npackets > 0)
1407   {
1408     /* queue full */
1409     if (0 == priority)
1410       return NULL;
1411     th = tunnel->mesh->th_tail;
1412     least_priority = priority;
1413     least_priority_th = NULL;
1414     while (NULL != th)
1415     {
1416       if (th->priority < least_priority && th->tunnel->npackets > 1)
1417       {
1418         least_priority_th = th;
1419         least_priority = th->priority;
1420       }
1421       th = th->prev;
1422     }
1423     if (NULL == least_priority_th)
1424       return NULL;
1425     GNUNET_assert(NULL != least_priority_th->notify); /* Cant be a cntrl msg */
1426     least_priority_th->notify(notify_cls, 0, NULL);
1427     least_priority_th->tunnel->npackets--;
1428     tunnel->mesh->npackets--;
1429     GNUNET_CONTAINER_DLL_remove(tunnel->mesh->th_head,
1430                                 tunnel->mesh->th_tail,
1431                                 least_priority_th);
1432     if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1433       GNUNET_SCHEDULER_cancel(least_priority_th->timeout_task);
1434     GNUNET_free(least_priority_th);
1435   }
1436   tunnel->npackets++;
1437   tunnel->mesh->npackets++;
1438   th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1439   th->tunnel = tunnel;
1440   th->priority = priority;
1441   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1442   th->target = GNUNET_PEER_intern (target);
1443   overhead =
1444       (NULL ==
1445        target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1446                                                                  GNUNET_MESH_Unicast);
1447   th->size = notify_size + overhead;
1448   th->notify = notify;
1449   th->notify_cls = notify_cls;
1450   add_to_queue (tunnel->mesh, th);
1451   return th;
1452 }
1453
1454
1455 /**
1456  * Cancel the specified transmission-ready notification.
1457  *
1458  * @param th handle that was returned by "notify_transmit_ready".
1459  */
1460 void
1461 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1462 {
1463   struct GNUNET_MESH_Handle *mesh;
1464
1465   mesh = th->tunnel->mesh;
1466   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1467     GNUNET_SCHEDULER_cancel (th->timeout_task);
1468   GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1469   GNUNET_free (th);
1470   if ((NULL == mesh->th_head) && (NULL != mesh->th))
1471   {
1472     /* queue empty, no point in asking for transmission */
1473     GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1474     mesh->th = NULL;
1475   }
1476 }
1477
1478
1479 #if 0                           /* keep Emacsens' auto-indent happy */
1480 {
1481 #endif
1482 #ifdef __cplusplus
1483 }
1484 #endif