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.
19 * @file mesh/mesh_api.c
20 * @brief mesh api: client implementation of mesh service
21 * @author Bartlomiej Polot
26 * - AUXILIARY FUNCTIONS
29 * - API CALL DEFINITIONS
31 * TODO: add regex to reconnect
34 #include "gnunet_common.h"
35 #include "gnunet_client_lib.h"
36 #include "gnunet_util_lib.h"
37 #include "gnunet_peer_lib.h"
38 #include "gnunet_mesh_service.h"
40 #include "mesh_protocol.h"
42 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
45 /******************************************************************************/
46 /************************ CONSTANTS ****************************/
47 /******************************************************************************/
49 #define HIGH_PID 0xFFFF0000
50 #define LOW_PID 0x0000FFFF
52 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
54 /******************************************************************************/
55 /************************ DATA STRUCTURES ****************************/
56 /******************************************************************************/
59 * Transmission queue to the service
61 struct GNUNET_MESH_TransmitHandle
67 struct GNUNET_MESH_TransmitHandle *next;
72 struct GNUNET_MESH_TransmitHandle *prev;
75 * Tunnel this message is sent on / for (may be NULL for control messages).
77 struct GNUNET_MESH_Tunnel *tunnel;
80 * Callback to obtain the message to transmit, or NULL if we
81 * got the message in 'data'. Notice that messages built
82 * by 'notify' need to be encapsulated with information about
85 GNUNET_CONNECTION_TransmitReadyNotify notify;
88 * Closure for 'notify'
93 * How long is this message valid. Once the timeout has been
94 * reached, the message must no longer be sent. If this
95 * is a message with a 'notify' callback set, the 'notify'
96 * function should be called with 'buf' NULL and size 0.
98 struct GNUNET_TIME_Absolute timeout;
101 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
103 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
106 * Target of the message, 0 for multicast. This field
107 * is only valid if 'notify' is non-NULL.
109 GNUNET_PEER_Id target;
112 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
119 * Opaque handle to the service.
121 struct GNUNET_MESH_Handle
125 * Handle to the server connection, to send messages later
127 struct GNUNET_CLIENT_Connection *client;
130 * Set of handlers used for processing incoming messages in the tunnels
132 const struct GNUNET_MESH_MessageHandler *message_handlers;
135 * Set of applications that should be claimed to be offered at this node.
136 * Note that this is just informative, the appropiate handlers must be
137 * registered independently and the mapping is up to the developer of the
138 * client application.
140 const GNUNET_MESH_ApplicationType *applications;
143 * Double linked list of the tunnels this client is connected to, head.
145 struct GNUNET_MESH_Tunnel *tunnels_head;
148 * Double linked list of the tunnels this client is connected to, tail.
150 struct GNUNET_MESH_Tunnel *tunnels_tail;
153 * Callback for inbound tunnel creation
155 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
158 * Callback for inbound tunnel disconnection
160 GNUNET_MESH_TunnelEndHandler *cleaner;
163 * Handle to cancel pending transmissions in case of disconnection
165 struct GNUNET_CLIENT_TransmitHandle *th;
168 * Closure for all the handlers given by the client
173 * Messages to send to the service, head.
175 struct GNUNET_MESH_TransmitHandle *th_head;
178 * Messages to send to the service, tail.
180 struct GNUNET_MESH_TransmitHandle *th_tail;
183 * tid of the next tunnel to create (to avoid reusing IDs often)
185 MESH_TunnelNumber next_tid;
188 * Number of handlers in the handlers array.
190 unsigned int n_handlers;
193 * Number of applications in the applications array.
195 unsigned int n_applications;
198 * Have we started the task to receive messages from the service
199 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
204 * Configuration given by the client, in case of reconnection
206 const struct GNUNET_CONFIGURATION_Handle *cfg;
209 * Time to the next reconnect in case one reconnect fails
211 struct GNUNET_TIME_Relative reconnect_time;
214 * Task for trying to reconnect.
216 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
221 * Description of a peer
223 struct GNUNET_MESH_Peer
226 * ID of the peer in short form
231 * Tunnel this peer belongs to
233 struct GNUNET_MESH_Tunnel *t;
236 * Flag indicating whether service has informed about its connection
244 * Opaque handle to a tunnel.
246 struct GNUNET_MESH_Tunnel
252 struct GNUNET_MESH_Tunnel *next;
257 struct GNUNET_MESH_Tunnel *prev;
260 * Callback to execute when peers connect to the tunnel
262 GNUNET_MESH_PeerConnectHandler connect_handler;
265 * Callback to execute when peers disconnect from the tunnel
267 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
270 * Closure for the connect/disconnect handlers
275 * Handle to the mesh this tunnel belongs to
277 struct GNUNET_MESH_Handle *mesh;
280 * Local ID of the tunnel
282 MESH_TunnelNumber tid;
285 * Owner of the tunnel. 0 if the tunnel is the local client.
287 GNUNET_PEER_Id owner;
290 * All peers added to the tunnel
292 struct GNUNET_MESH_Peer **peers;
295 * List of application types that have been requested for this tunnel
297 GNUNET_MESH_ApplicationType *apps;
300 * Any data the caller wants to put in here
305 * Number of peers added to the tunnel
310 * Number of packets queued in this tunnel
312 unsigned int npackets;
315 * Number of applications requested this tunnel
320 * Is the tunnel throttled to the slowest peer?
325 * Is the tunnel allowed to buffer?
335 * Maximum allowed PID.
343 /******************************************************************************/
344 /*********************** AUXILIARY FUNCTIONS *************************/
345 /******************************************************************************/
348 * Get the tunnel handler for the tunnel specified by id from the given handle
349 * @param h Mesh handle
350 * @param tid ID of the wanted tunnel
351 * @return handle to the required tunnel or NULL if not found
353 static struct GNUNET_MESH_Tunnel *
354 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
356 struct GNUNET_MESH_Tunnel *t;
370 * Create a new tunnel and insert it in the tunnel list of the mesh handle
371 * @param h Mesh handle
372 * @param tid desired tid of the tunnel, 0 to assign one automatically
373 * @return handle to the created tunnel
375 static struct GNUNET_MESH_Tunnel *
376 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
378 struct GNUNET_MESH_Tunnel *t;
380 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
381 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
385 t->tid = h->next_tid;
386 while (NULL != retrieve_tunnel (h, h->next_tid))
389 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
390 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
402 * Destroy the specified tunnel.
403 * - Destroys all peers, calling the disconnect callback on each if needed
404 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
405 * - Calls cleaner if tunnel was inbound
406 * - Frees all memory used
408 * @param t Pointer to the tunnel.
409 * @param call_cleaner Whether to call the cleaner handler.
411 * @return Handle to the required tunnel or NULL if not found.
414 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
416 struct GNUNET_MESH_Handle *h;
417 struct GNUNET_PeerIdentity pi;
418 struct GNUNET_MESH_TransmitHandle *th;
419 struct GNUNET_MESH_TransmitHandle *next;
422 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
431 /* disconnect all peers */
432 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
433 for (i = 0; i < t->npeers; i++)
435 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
437 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
438 t->disconnect_handler (t->cls, &pi);
440 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
441 GNUNET_free (t->peers[i]);
444 /* signal tunnel destruction */
445 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
446 h->cleaner (h->cls, t, t->ctx);
448 /* check that clients did not leave messages behind in the queue */
449 for (th = h->th_head; NULL != th; th = next)
454 /* Clients should have aborted their requests already.
455 * Management traffic should be ok, as clients can't cancel that */
456 GNUNET_break (NULL == th->notify);
457 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
459 /* clean up request */
460 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
461 GNUNET_SCHEDULER_cancel (th->timeout_task);
465 /* if there are no more pending requests with mesh service, cancel active request */
466 /* Note: this should be unnecessary... */
467 if ( (NULL == h->th_head) && (NULL != h->th))
469 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
475 GNUNET_free (t->peers);
477 GNUNET_PEER_change_rc (t->owner, -1);
478 if (0 != t->napps && t->apps)
479 GNUNET_free (t->apps);
486 * Get the peer descriptor for the peer with id from the given tunnel
487 * @param t Tunnel handle
488 * @param id Short form ID of the wanted peer
489 * @return handle to the requested peer or NULL if not found
491 static struct GNUNET_MESH_Peer *
492 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
496 for (i = 0; i < t->npeers; i++)
497 if (t->peers[i]->id == id)
504 * Add a peer into a tunnel
505 * @param t Tunnel handle
506 * @param pi Full ID of the new peer
507 * @return handle to the newly created peer
509 static struct GNUNET_MESH_Peer *
510 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
511 const struct GNUNET_PeerIdentity *pi)
513 struct GNUNET_MESH_Peer *p;
521 id = GNUNET_PEER_intern (pi);
523 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
526 GNUNET_array_append (t->peers, t->npeers, p);
532 * Remove a peer from a tunnel
533 * @param p Peer handle
536 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
540 for (i = 0; i < p->t->npeers; i++)
542 if (p->t->peers[i] == p)
545 if (i == p->t->npeers)
550 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
551 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
556 * Notify client that the transmission has timed out
558 * @param tc task context
561 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
563 struct GNUNET_MESH_TransmitHandle *th = cls;
564 struct GNUNET_MESH_Handle *mesh;
566 mesh = th->tunnel->mesh;
567 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
568 if (th->notify != NULL)
569 th->notify (th->notify_cls, 0, NULL);
571 if ((NULL == mesh->th_head) && (NULL != mesh->th))
573 /* queue empty, no point in asking for transmission */
574 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
581 * Add a transmit handle to the transmission queue by priority and set the
584 * @param h mesh handle with the queue head and tail
585 * @param th handle to the packet to be transmitted
588 add_to_queue (struct GNUNET_MESH_Handle *h,
589 struct GNUNET_MESH_TransmitHandle *th)
591 struct GNUNET_MESH_TransmitHandle *p;
600 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
601 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
604 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
605 (th->timeout), &timeout_transmission, th);
610 * Auxiliary function to send an already constructed packet to the service.
611 * Takes care of creating a new queue element, copying the message and
612 * calling the tmt_rdy function if necessary.
614 * @param h mesh handle
615 * @param msg message to transmit
616 * @param tunnel tunnel this send is related to (NULL if N/A)
619 send_packet (struct GNUNET_MESH_Handle *h,
620 const struct GNUNET_MessageHeader *msg,
621 struct GNUNET_MESH_Tunnel *tunnel);
625 * Reconnect callback: tries to reconnect again after a failer previous
627 * @param cls closure (mesh handle)
628 * @param tc task context
631 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
635 * Send a connect packet to the service with the applications and types
636 * requested by the user.
638 * @param h The mesh handle.
642 send_connect (struct GNUNET_MESH_Handle *h)
646 size = sizeof (struct GNUNET_MESH_ClientConnect);
647 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
648 size += h->n_handlers * sizeof (uint16_t);
650 char buf[size] GNUNET_ALIGN;
651 struct GNUNET_MESH_ClientConnect *msg;
652 GNUNET_MESH_ApplicationType *apps;
657 /* build connection packet */
658 msg = (struct GNUNET_MESH_ClientConnect *) buf;
659 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
660 msg->header.size = htons (size);
661 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
662 for (napps = 0; napps < h->n_applications; napps++)
664 apps[napps] = htonl (h->applications[napps]);
665 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
667 types = (uint16_t *) & apps[napps];
668 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
669 types[ntypes] = htons (h->message_handlers[ntypes].type);
670 msg->applications = htons (napps);
671 msg->types = htons (ntypes);
672 LOG (GNUNET_ERROR_TYPE_DEBUG,
673 "Sending %lu bytes long message %d types and %d apps\n",
674 ntohs (msg->header.size), ntypes, napps);
675 send_packet (h, &msg->header, NULL);
681 * Reconnect to the service, retransmit all infomation to try to restore the
684 * @param h handle to the mesh
686 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
689 do_reconnect (struct GNUNET_MESH_Handle *h)
691 struct GNUNET_MESH_Tunnel *t;
694 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
695 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
696 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
698 h->in_receive = GNUNET_NO;
702 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
705 if (NULL != h->client)
707 GNUNET_CLIENT_disconnect (h->client);
711 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
712 if (h->client == NULL)
714 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
717 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
718 GNUNET_TIME_relative_multiply
719 (h->reconnect_time, 2));
720 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
721 GNUNET_TIME_relative_to_string (h->reconnect_time));
727 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
730 /* Rebuild all tunnels */
731 for (t = h->tunnels_head; NULL != t; t = t->next)
733 struct GNUNET_MESH_TunnelMessage tmsg;
734 struct GNUNET_MESH_PeerControl pmsg;
736 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
738 /* Tunnel was created by service (incoming tunnel) */
739 /* TODO: Notify service of missing tunnel, to request
740 * creator to recreate path (find a path to him via DHT?)
744 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
745 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
746 tmsg.tunnel_id = htonl (t->tid);
747 send_packet (h, &tmsg.header, t);
749 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
750 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
751 pmsg.tunnel_id = htonl (t->tid);
753 /* Reconnect all peers */
754 /* If the tunnel was "by type", dont connect individual peers */
755 for (i = 0; i < t->npeers && 0 == t->napps; i++)
757 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
758 if (NULL != t->disconnect_handler && t->peers[i]->connected)
759 t->disconnect_handler (t->cls, &pmsg.peer);
760 send_packet (t->mesh, &pmsg.header, t);
762 /* Reconnect all types, if any */
763 for (i = 0; i < t->napps; i++)
765 struct GNUNET_MESH_ConnectPeerByType msg;
767 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
768 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
769 msg.tunnel_id = htonl (t->tid);
770 msg.type = htonl (t->apps[i]);
771 send_packet (t->mesh, &msg.header, t);
773 if (GNUNET_NO == t->buffering)
774 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
775 if (GNUNET_YES == t->speed_min)
776 GNUNET_MESH_tunnel_speed_min (t);
782 * Reconnect callback: tries to reconnect again after a failer previous
784 * @param cls closure (mesh handle)
785 * @param tc task context
788 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
790 struct GNUNET_MESH_Handle *h = cls;
792 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
793 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
800 * Reconnect to the service, retransmit all infomation to try to restore the
803 * @param h handle to the mesh
805 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
808 reconnect (struct GNUNET_MESH_Handle *h)
810 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
811 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
812 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
817 /******************************************************************************/
818 /*********************** RECEIVE HANDLERS ****************************/
819 /******************************************************************************/
822 * Process the new tunnel notification and add it to the tunnels in the handle
824 * @param h The mesh handle
825 * @param msg A message with the details of the new incoming tunnel
828 process_tunnel_created (struct GNUNET_MESH_Handle *h,
829 const struct GNUNET_MESH_TunnelNotification *msg)
831 struct GNUNET_MESH_Tunnel *t;
832 MESH_TunnelNumber tid;
834 tid = ntohl (msg->tunnel_id);
835 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
840 if (NULL != h->new_tunnel)
842 struct GNUNET_ATS_Information atsi;
844 t = create_tunnel (h, tid);
845 t->owner = GNUNET_PEER_intern (&msg->peer);
847 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
848 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
850 t->peers[0]->connected = 1;
851 t->peers[0]->id = t->owner;
852 GNUNET_PEER_change_rc (t->owner, 1);
857 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
858 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
862 struct GNUNET_MESH_TunnelMessage d_msg;
864 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
866 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
867 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
868 d_msg.tunnel_id = msg->tunnel_id;
870 send_packet (h, &d_msg.header, NULL);
877 * Process the tunnel destroy notification and free associated resources
879 * @param h The mesh handle
880 * @param msg A message with the details of the tunnel being destroyed
883 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
884 const struct GNUNET_MESH_TunnelMessage *msg)
886 struct GNUNET_MESH_Tunnel *t;
887 MESH_TunnelNumber tid;
889 tid = ntohl (msg->tunnel_id);
890 t = retrieve_tunnel (h, tid);
900 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
901 destroy_tunnel (t, GNUNET_YES);
907 * Process the new peer event and notify the upper level of it
909 * @param h The mesh handle
910 * @param msg A message with the details of the peer event
913 process_peer_event (struct GNUNET_MESH_Handle *h,
914 const struct GNUNET_MESH_PeerControl *msg)
916 struct GNUNET_MESH_Tunnel *t;
917 struct GNUNET_MESH_Peer *p;
918 struct GNUNET_ATS_Information atsi;
922 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
923 size = ntohs (msg->header.size);
924 if (size != sizeof (struct GNUNET_MESH_PeerControl))
929 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
935 id = GNUNET_PEER_search (&msg->peer);
936 if ((p = retrieve_peer (t, id)) == NULL)
937 p = add_peer_to_tunnel (t, &msg->peer);
938 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
940 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
941 if (NULL != t->connect_handler)
945 t->connect_handler (t->cls, &msg->peer, &atsi);
951 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
952 if (NULL != t->disconnect_handler && p->connected)
954 t->disconnect_handler (t->cls, &msg->peer);
956 remove_peer_from_tunnel (p);
959 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
964 * Process the incoming data packets
966 * @param h The mesh handle
967 * @param message A message encapsulating the data
969 * @return GNUNET_YES if everything went fine
970 * GNUNET_NO if client closed connection (h no longer valid)
973 process_incoming_data (struct GNUNET_MESH_Handle *h,
974 const struct GNUNET_MessageHeader *message)
976 const struct GNUNET_MessageHeader *payload;
977 const struct GNUNET_MESH_MessageHandler *handler;
978 const struct GNUNET_PeerIdentity *peer;
979 struct GNUNET_MESH_Unicast *ucast;
980 struct GNUNET_MESH_Multicast *mcast;
981 struct GNUNET_MESH_ToOrigin *to_orig;
982 struct GNUNET_MESH_Tunnel *t;
986 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
987 type = ntohs (message->type);
990 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
991 ucast = (struct GNUNET_MESH_Unicast *) message;
993 t = retrieve_tunnel (h, ntohl (ucast->tid));
994 payload = (struct GNUNET_MessageHeader *) &ucast[1];
996 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
997 GNUNET_i2s (peer), ntohl (ucast->tid));
999 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1000 mcast = (struct GNUNET_MESH_Multicast *) message;
1001 t = retrieve_tunnel (h, ntohl (mcast->tid));
1002 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1004 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1005 GNUNET_i2s (peer), ntohl (mcast->tid));
1007 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1008 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1009 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1010 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1011 peer = &to_orig->sender;
1012 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1013 GNUNET_i2s (peer), ntohl (to_orig->tid));
1021 /* Tunnel was ignored, probably service didn't get it yet */
1024 type = ntohs (payload->type);
1025 for (i = 0; i < h->n_handlers; i++)
1027 handler = &h->message_handlers[i];
1028 if (handler->type == type)
1030 struct GNUNET_ATS_Information atsi;
1035 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1038 GNUNET_MESH_disconnect (h);
1043 LOG (GNUNET_ERROR_TYPE_DEBUG,
1044 "callback completed successfully\n");
1053 * Process a local ACK message, enabling the client to send
1054 * more data to the service.
1056 * @param h Mesh handle.
1057 * @param message Message itself.
1060 process_ack (struct GNUNET_MESH_Handle *h,
1061 const struct GNUNET_MessageHeader *message)
1063 struct GNUNET_MESH_LocalAck *msg;
1064 struct GNUNET_MESH_Tunnel *t;
1067 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1068 msg = (struct GNUNET_MESH_LocalAck *) message;
1070 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1074 LOG (GNUNET_ERROR_TYPE_WARNING,
1075 "ACK on unknown tunnel %X\n",
1076 ntohl (msg->tunnel_id));
1079 ack = ntohl (msg->max_pid);
1080 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1086 * Function to process all messages received from the service
1088 * @param cls closure
1089 * @param msg message received, NULL on timeout or fatal error
1092 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1094 struct GNUNET_MESH_Handle *h = cls;
1098 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL msg\n");
1102 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1104 switch (ntohs (msg->type))
1106 /* Notify of a new incoming tunnel */
1107 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1108 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1110 /* Notify of a tunnel disconnection */
1111 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1112 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1114 /* Notify of a new peer or a peer disconnect in the tunnel */
1115 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1116 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1117 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1119 /* Notify of a new data packet in the tunnel */
1120 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1121 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1122 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1123 if (GNUNET_NO == process_incoming_data (h, msg))
1126 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1127 process_ack (h, msg);
1130 /* We shouldn't get any other packages, log and ignore */
1131 LOG (GNUNET_ERROR_TYPE_WARNING,
1132 "unsolicited message form service (type %d)\n",
1135 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1136 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1137 GNUNET_TIME_UNIT_FOREVER_REL);
1141 /******************************************************************************/
1142 /************************ SEND FUNCTIONS ****************************/
1143 /******************************************************************************/
1146 * Function called to send a message to the service.
1147 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1150 * @param cls closure, the mesh handle
1151 * @param size number of bytes available in buf
1152 * @param buf where the callee should write the connect message
1153 * @return number of bytes written to buf
1156 send_callback (void *cls, size_t size, void *buf)
1158 struct GNUNET_MESH_Handle *h = cls;
1159 struct GNUNET_MESH_TransmitHandle *th;
1164 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1166 if ((0 == size) || (NULL == buf))
1168 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL callback\n");
1173 while ((NULL != (th = h->th_head)) && (size >= th->size))
1175 if (NULL != th->notify)
1177 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1179 /* traffic to origin */
1180 struct GNUNET_MESH_ToOrigin to;
1181 struct GNUNET_MessageHeader *mh;
1183 GNUNET_assert (size >= th->size);
1184 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1185 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1186 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1190 psize += sizeof (to);
1191 GNUNET_assert (size >= psize);
1192 to.header.size = htons (psize);
1193 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1194 to.tid = htonl (th->tunnel->tid);
1195 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1196 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1197 memcpy (cbuf, &to, sizeof (to));
1200 else if (th->target == 0)
1203 struct GNUNET_MESH_Multicast mc;
1204 struct GNUNET_MessageHeader *mh;
1206 GNUNET_assert (size >= th->size);
1207 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1208 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1209 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1213 psize += sizeof (mc);
1214 GNUNET_assert (size >= psize);
1215 mc.header.size = htons (psize);
1216 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1217 mc.tid = htonl (th->tunnel->tid);
1220 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1221 memcpy (cbuf, &mc, sizeof (mc));
1227 struct GNUNET_MESH_Unicast uc;
1228 struct GNUNET_MessageHeader *mh;
1230 GNUNET_assert (size >= th->size);
1231 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1232 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1233 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1237 psize += sizeof (uc);
1238 GNUNET_assert (size >= psize);
1239 uc.header.size = htons (psize);
1240 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1241 uc.tid = htonl (th->tunnel->tid);
1242 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1243 GNUNET_PEER_resolve (th->target, &uc.destination);
1244 memcpy (cbuf, &uc, sizeof (uc));
1250 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1251 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1253 memcpy (cbuf, &th[1], th->size);
1256 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1257 GNUNET_SCHEDULER_cancel (th->timeout_task);
1258 if (NULL != th->notify)
1260 th->tunnel->npackets--;
1262 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1268 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1269 if (NULL != (th = h->th_head))
1271 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", th->size);
1274 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1275 GNUNET_TIME_UNIT_FOREVER_REL,
1276 GNUNET_YES, &send_callback, h);
1278 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1279 if (GNUNET_NO == h->in_receive)
1281 h->in_receive = GNUNET_YES;
1282 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1283 GNUNET_TIME_UNIT_FOREVER_REL);
1290 * Auxiliary function to send an already constructed packet to the service.
1291 * Takes care of creating a new queue element, copying the message and
1292 * calling the tmt_rdy function if necessary.
1294 * @param h mesh handle
1295 * @param msg message to transmit
1296 * @param tunnel tunnel this send is related to (NULL if N/A)
1299 send_packet (struct GNUNET_MESH_Handle *h,
1300 const struct GNUNET_MessageHeader *msg,
1301 struct GNUNET_MESH_Tunnel *tunnel)
1303 struct GNUNET_MESH_TransmitHandle *th;
1306 msize = ntohs (msg->size);
1307 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1308 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1310 th->tunnel = tunnel;
1311 memcpy (&th[1], msg, msize);
1312 add_to_queue (h, th);
1316 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1317 GNUNET_TIME_UNIT_FOREVER_REL,
1318 GNUNET_YES, &send_callback, h);
1322 /******************************************************************************/
1323 /********************** API CALL DEFINITIONS *************************/
1324 /******************************************************************************/
1327 * Connect to the mesh service.
1329 * @param cfg configuration to use
1330 * @param cls closure for the various callbacks that follow
1331 * (including handlers in the handlers array)
1332 * @param new_tunnel function called when an *inbound* tunnel is created
1333 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1334 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1335 * is called on the tunnel
1336 * @param handlers callbacks for messages we care about, NULL-terminated
1337 * note that the mesh is allowed to drop notifications about
1338 * inbound messages if the client does not process them fast
1339 * enough (for this notification type, a bounded queue is used)
1340 * @param stypes list of the applications that this client claims to provide
1341 * @return handle to the mesh service NULL on error
1342 * (in this case, init is never called)
1344 struct GNUNET_MESH_Handle *
1345 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1346 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1347 GNUNET_MESH_TunnelEndHandler cleaner,
1348 const struct GNUNET_MESH_MessageHandler *handlers,
1349 const GNUNET_MESH_ApplicationType *stypes)
1351 struct GNUNET_MESH_Handle *h;
1353 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1354 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1356 h->new_tunnel = new_tunnel;
1357 h->cleaner = cleaner;
1358 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1359 if (h->client == NULL)
1367 h->applications = stypes;
1368 h->message_handlers = handlers;
1369 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1370 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1371 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1373 /* count handlers and apps, calculate size */
1374 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1375 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1377 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1383 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1384 * disconnect callbacks will be called on any still connected peers, notifying
1385 * about their disconnection. The registered inbound tunnel cleaner will be
1386 * called should any inbound tunnels still exist.
1388 * @param handle connection to mesh to disconnect
1391 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1393 struct GNUNET_MESH_Tunnel *t;
1394 struct GNUNET_MESH_Tunnel *aux;
1395 struct GNUNET_MESH_TransmitHandle *th;
1397 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1399 t = handle->tunnels_head;
1403 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1406 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1408 destroy_tunnel (t, GNUNET_YES);
1411 while ( (th = handle->th_head) != NULL)
1413 struct GNUNET_MessageHeader *msg;
1415 /* Make sure it is an allowed packet (everything else should have been
1416 * already canceled).
1418 GNUNET_break (NULL == th->notify);
1419 msg = (struct GNUNET_MessageHeader *) &th[1];
1420 switch (ntohs(msg->type))
1422 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1423 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1427 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1431 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1435 if (NULL != handle->th)
1437 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1440 if (NULL != handle->client)
1442 GNUNET_CLIENT_disconnect (handle->client);
1443 handle->client = NULL;
1445 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1447 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1448 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1450 GNUNET_free (handle);
1455 * Announce to ther peer the availability of services described by the regex,
1456 * in order to be reachable to other peers via connect_by_string.
1458 * Note that the first 8 characters are considered to be part of a prefix,
1459 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1460 * all matching strings will be stored in the DHT.
1462 * @param h handle to mesh.
1463 * @param regex string with the regular expression describing local services.
1466 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1469 struct GNUNET_MessageHeader *msg;
1473 len = strlen (regex);
1474 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1475 GNUNET_assert (UINT16_MAX > msgsize);
1478 char buffer[msgsize];
1480 msg = (struct GNUNET_MessageHeader *) buffer;
1481 msg->size = htons (msgsize);
1482 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1483 memcpy (&msg[1], regex, len);
1485 send_packet(h, msg, NULL);
1490 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1491 * and to broadcast).
1493 * @param h mesh handle
1494 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1495 * @param connect_handler function to call when peers are actually connected
1496 * @param disconnect_handler function to call when peers are disconnected
1497 * @param handler_cls closure for connect/disconnect handlers
1499 struct GNUNET_MESH_Tunnel *
1500 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1501 GNUNET_MESH_PeerConnectHandler connect_handler,
1502 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1505 struct GNUNET_MESH_Tunnel *t;
1506 struct GNUNET_MESH_TunnelMessage msg;
1508 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1509 t = create_tunnel (h, 0);
1510 t->connect_handler = connect_handler;
1511 t->disconnect_handler = disconnect_handler;
1512 t->cls = handler_cls;
1513 t->ctx = tunnel_ctx;
1514 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1515 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1516 msg.tunnel_id = htonl (t->tid);
1517 send_packet (h, &msg.header, t);
1523 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1526 * @param tunnel tunnel handle
1529 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1531 struct GNUNET_MESH_Handle *h;
1532 struct GNUNET_MESH_TunnelMessage msg;
1533 struct GNUNET_MESH_TransmitHandle *th;
1535 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1538 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1539 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1540 msg.tunnel_id = htonl (tunnel->tid);
1544 struct GNUNET_MESH_TransmitHandle *aux;
1545 if (th->tunnel == tunnel)
1548 /* FIXME call the handler? */
1549 if (NULL != th->notify)
1550 th->notify (th->notify_cls, 0, NULL);
1551 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1559 destroy_tunnel (tunnel, GNUNET_NO);
1560 send_packet (h, &msg.header, NULL);
1564 * Request that the tunnel data rate is limited to the speed of the slowest
1567 * @param tunnel Tunnel affected.
1570 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1572 struct GNUNET_MESH_TunnelMessage msg;
1573 struct GNUNET_MESH_Handle *h;
1576 tunnel->speed_min = GNUNET_YES;
1578 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1579 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1580 msg.tunnel_id = htonl (tunnel->tid);
1582 send_packet (h, &msg.header, NULL);
1587 * Request that the tunnel data rate is limited to the speed of the fastest
1588 * receiver. This is the default behavior.
1590 * @param tunnel Tunnel affected.
1593 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1595 struct GNUNET_MESH_TunnelMessage msg;
1596 struct GNUNET_MESH_Handle *h;
1599 tunnel->speed_min = GNUNET_NO;
1601 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1602 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1603 msg.tunnel_id = htonl (tunnel->tid);
1605 send_packet (h, &msg.header, NULL);
1609 * Turn on/off the buffering status of the tunnel.
1611 * @param tunnel Tunnel affected.
1612 * @param buffer GNUNET_YES to turn buffering on (default),
1613 * GNUNET_NO otherwise.
1616 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1618 struct GNUNET_MESH_TunnelMessage msg;
1619 struct GNUNET_MESH_Handle *h;
1622 tunnel->buffering = buffer;
1624 if (GNUNET_YES == buffer)
1625 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1627 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1628 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1629 msg.tunnel_id = htonl (tunnel->tid);
1631 send_packet (h, &msg.header, NULL);
1635 * Request that a peer should be added to the tunnel. The existing
1636 * connect handler will be called ONCE with either success or failure.
1637 * This function should NOT be called again with the same peer before the
1638 * connect handler is called.
1640 * @param tunnel handle to existing tunnel
1641 * @param peer peer to add
1644 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1645 const struct GNUNET_PeerIdentity *peer)
1647 struct GNUNET_MESH_PeerControl msg;
1648 GNUNET_PEER_Id peer_id;
1651 peer_id = GNUNET_PEER_intern (peer);
1652 for (i = 0; i < tunnel->npeers; i++)
1654 if (tunnel->peers[i]->id == peer_id)
1656 /* Peer already exists in tunnel */
1657 GNUNET_PEER_change_rc (peer_id, -1);
1662 if (NULL == add_peer_to_tunnel (tunnel, peer))
1665 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1666 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1667 msg.tunnel_id = htonl (tunnel->tid);
1669 send_packet (tunnel->mesh, &msg.header, tunnel);
1676 * Request that a peer should be removed from the tunnel. The existing
1677 * disconnect handler will be called ONCE if we were connected.
1679 * @param tunnel handle to existing tunnel
1680 * @param peer peer to remove
1683 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1684 const struct GNUNET_PeerIdentity *peer)
1686 struct GNUNET_MESH_PeerControl msg;
1687 GNUNET_PEER_Id peer_id;
1690 peer_id = GNUNET_PEER_search (peer);
1696 for (i = 0; i < tunnel->npeers; i++)
1697 if (tunnel->peers[i]->id == peer_id)
1699 if (i == tunnel->npeers)
1704 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1705 tunnel->disconnect_handler (tunnel->cls, peer);
1706 GNUNET_PEER_change_rc (peer_id, -1);
1707 GNUNET_free (tunnel->peers[i]);
1708 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1709 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1711 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1712 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1713 msg.tunnel_id = htonl (tunnel->tid);
1714 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1715 send_packet (tunnel->mesh, &msg.header, tunnel);
1720 * Request that the mesh should try to connect to a peer supporting the given
1723 * @param tunnel handle to existing tunnel
1724 * @param app_type application type that must be supported by the peer (MESH
1725 * should discover peer in proximity handling this type)
1728 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1729 GNUNET_MESH_ApplicationType app_type)
1731 struct GNUNET_MESH_ConnectPeerByType msg;
1733 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1735 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1736 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1737 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1738 msg.tunnel_id = htonl (tunnel->tid);
1739 msg.type = htonl (app_type);
1740 send_packet (tunnel->mesh, &msg.header, tunnel);
1745 * Request that the mesh should try to connect to a peer matching the
1746 * description given in the service string.
1748 * FIXME: allow multiple? how to deal with reconnect?
1750 * @param tunnel handle to existing tunnel
1751 * @param description string describing the destination node requirements
1754 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1755 const char *description)
1757 struct GNUNET_MESH_ConnectPeerByString *m;
1761 len = strlen (description);
1762 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1763 GNUNET_assert (UINT16_MAX > msgsize);
1765 char buffer[msgsize];
1767 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1768 m->header.size = htons (msgsize);
1769 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1770 m->tunnel_id = htonl (tunnel->tid);
1771 memcpy(&m[1], description, len);
1773 send_packet (tunnel->mesh, &m->header, tunnel);
1779 * Request that the given peer isn't added to this tunnel in calls to
1780 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1782 * @param tunnel handle to existing tunnel.
1783 * @param peer peer identity of the peer which should be blacklisted
1787 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1788 const struct GNUNET_PeerIdentity *peer)
1790 struct GNUNET_MESH_PeerControl msg;
1792 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1793 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1794 msg.tunnel_id = htonl (tunnel->tid);
1796 send_packet (tunnel->mesh, &msg.header, tunnel);
1803 * Request that the given peer isn't blacklisted anymore from this tunnel,
1804 * and therefore can be added in future calls to connect_by_*.
1805 * The peer must have been previously blacklisted for this tunnel.
1807 * @param tunnel handle to existing tunnel.
1808 * @param peer peer identity of the peer which shouldn't be blacklisted
1809 * for the tunnel anymore.
1812 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1813 const struct GNUNET_PeerIdentity *peer)
1815 struct GNUNET_MESH_PeerControl msg;
1817 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1818 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1819 msg.tunnel_id = htonl (tunnel->tid);
1821 send_packet (tunnel->mesh, &msg.header, tunnel);
1828 * Ask the mesh to call "notify" once it is ready to transmit the
1829 * given number of bytes to the specified tunnel or target.
1830 * Only one call can be active at any time, to issue another request,
1831 * wait for the callback or cancel the current request.
1833 * @param tunnel tunnel to use for transmission
1834 * @param cork is corking allowed for this transmission?
1835 * @param maxdelay how long can the message wait?
1836 * @param target destination for the message
1837 * NULL for multicast to all tunnel targets
1838 * @param notify_size how many bytes of buffer space does notify want?
1839 * @param notify function to call when buffer space is available;
1840 * will be called with NULL on timeout or if the overall queue
1841 * for this peer is larger than queue_size and this is currently
1842 * the message with the lowest priority
1843 * @param notify_cls closure for notify
1844 * @return non-NULL if the notify callback was queued,
1845 * NULL if we can not even queue the request (insufficient
1846 * memory); if NULL is returned, "notify" will NOT be called.
1848 struct GNUNET_MESH_TransmitHandle *
1849 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1850 struct GNUNET_TIME_Relative maxdelay,
1851 const struct GNUNET_PeerIdentity *target,
1853 GNUNET_CONNECTION_TransmitReadyNotify notify,
1856 struct GNUNET_MESH_TransmitHandle *th;
1859 GNUNET_assert (NULL != tunnel);
1860 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1862 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1864 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1865 GNUNET_assert (NULL != notify);
1866 GNUNET_assert (0 == tunnel->npackets);
1868 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1869 th->tunnel = tunnel;
1870 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1871 th->target = GNUNET_PEER_intern (target);
1872 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1873 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1874 else if (NULL == target)
1875 overhead = sizeof (struct GNUNET_MESH_Multicast);
1877 overhead = sizeof (struct GNUNET_MESH_Unicast);
1878 th->size = notify_size + overhead;
1879 th->notify = notify;
1880 th->notify_cls = notify_cls;
1881 add_to_queue (tunnel->mesh, th);
1882 if (NULL != tunnel->mesh->th)
1885 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1886 GNUNET_TIME_UNIT_FOREVER_REL,
1887 GNUNET_YES, &send_callback,
1894 * Cancel the specified transmission-ready notification.
1896 * @param th handle that was returned by "notify_transmit_ready".
1899 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1901 struct GNUNET_MESH_Handle *mesh;
1903 mesh = th->tunnel->mesh;
1904 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1905 GNUNET_SCHEDULER_cancel (th->timeout_task);
1906 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1908 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1910 /* queue empty, no point in asking for transmission */
1911 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1918 * Transition API for tunnel ctx management
1921 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1927 * Transition API for tunnel ctx management
1930 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)