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 new 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__)
43 #define DEBUG_ACK GNUNET_YES
45 /******************************************************************************/
46 /************************ DATA STRUCTURES ****************************/
47 /******************************************************************************/
50 * Transmission queue to the service
52 struct GNUNET_MESH_TransmitHandle
58 struct GNUNET_MESH_TransmitHandle *next;
63 struct GNUNET_MESH_TransmitHandle *prev;
66 * Tunnel this message is sent on / for (may be NULL for control messages).
68 struct GNUNET_MESH_Tunnel *tunnel;
71 * Callback to obtain the message to transmit, or NULL if we
72 * got the message in 'data'. Notice that messages built
73 * by 'notify' need to be encapsulated with information about
76 GNUNET_CONNECTION_TransmitReadyNotify notify;
79 * Closure for 'notify'
84 * How long is this message valid. Once the timeout has been
85 * reached, the message must no longer be sent. If this
86 * is a message with a 'notify' callback set, the 'notify'
87 * function should be called with 'buf' NULL and size 0.
89 struct GNUNET_TIME_Absolute timeout;
92 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
94 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
97 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
104 * Opaque handle to the service.
106 struct GNUNET_MESH_Handle
110 * Handle to the server connection, to send messages later
112 struct GNUNET_CLIENT_Connection *client;
115 * Set of handlers used for processing incoming messages in the tunnels
117 const struct GNUNET_MESH_MessageHandler *message_handlers;
120 * Number of handlers in the handlers array.
122 unsigned int n_handlers;
127 const uint32_t *ports;
132 unsigned int n_ports;
135 * Double linked list of the tunnels this client is connected to, head.
137 struct GNUNET_MESH_Tunnel *tunnels_head;
140 * Double linked list of the tunnels this client is connected to, tail.
142 struct GNUNET_MESH_Tunnel *tunnels_tail;
145 * Callback for inbound tunnel creation
147 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
150 * Callback for inbound tunnel disconnection
152 GNUNET_MESH_TunnelEndHandler *cleaner;
155 * Handle to cancel pending transmissions in case of disconnection
157 struct GNUNET_CLIENT_TransmitHandle *th;
160 * Closure for all the handlers given by the client
165 * Messages to send to the service, head.
167 struct GNUNET_MESH_TransmitHandle *th_head;
170 * Messages to send to the service, tail.
172 struct GNUNET_MESH_TransmitHandle *th_tail;
175 * tid of the next tunnel to create (to avoid reusing IDs often)
177 MESH_TunnelNumber next_tid;
180 * Have we started the task to receive messages from the service
181 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
186 * Configuration given by the client, in case of reconnection
188 const struct GNUNET_CONFIGURATION_Handle *cfg;
191 * Time to the next reconnect in case one reconnect fails
193 struct GNUNET_TIME_Relative reconnect_time;
196 * Task for trying to reconnect.
198 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
203 GNUNET_MESH_TunnelsCB tunnels_cb;
206 * Monitor callback closure.
213 GNUNET_MESH_TunnelCB tunnel_cb;
216 * Tunnel callback closure.
221 unsigned int acks_sent;
222 unsigned int acks_recv;
228 * Description of a peer
230 struct GNUNET_MESH_Peer
233 * ID of the peer in short form
238 * Tunnel this peer belongs to
240 struct GNUNET_MESH_Tunnel *t;
243 * Flag indicating whether service has informed about its connection
251 * Opaque handle to a tunnel.
253 struct GNUNET_MESH_Tunnel
259 struct GNUNET_MESH_Tunnel *next;
264 struct GNUNET_MESH_Tunnel *prev;
267 * Handle to the mesh this tunnel belongs to
269 struct GNUNET_MESH_Handle *mesh;
272 * Local ID of the tunnel
274 MESH_TunnelNumber tid;
282 * Other end of the tunnel.
287 * Any data the caller wants to put in here
292 * Size of packet queued in this tunnel
294 unsigned int packet_size;
297 * Is the tunnel allowed to buffer?
302 * Is the tunnel realiable?
307 * If reliable, is the tunnel out of order?
312 * Are we allowed to send to the service?
320 * Implementation state for mesh's message queue.
325 * The current transmit handle, or NULL
326 * if no transmit is active.
328 struct GNUNET_MESH_TransmitHandle *th;
331 * Tunnel to send the data over.
333 struct GNUNET_MESH_Tunnel *tunnel;
337 /******************************************************************************/
338 /*********************** DECLARATIONS *************************/
339 /******************************************************************************/
342 * Function called to send a message to the service.
343 * "buf" will be NULL and "size" zero if the socket was closed for writing in
346 * @param cls closure, the mesh handle
347 * @param size number of bytes available in buf
348 * @param buf where the callee should write the connect message
349 * @return number of bytes written to buf
352 send_callback (void *cls, size_t size, void *buf);
355 /******************************************************************************/
356 /*********************** AUXILIARY FUNCTIONS *************************/
357 /******************************************************************************/
360 * Check if transmission is a payload packet.
362 * @param th Transmission handle.
364 * @return GNUNET_YES if it is a payload packet,
365 * GNUNET_NO if it is a mesh management packet.
368 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
370 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
375 * Check whether there is any message ready in the queue and find the size.
377 * @param h Mesh handle.
379 * @return The size of the first ready message in the queue,
380 * 0 if there is none.
383 message_ready_size (struct GNUNET_MESH_Handle *h)
385 struct GNUNET_MESH_TransmitHandle *th;
386 struct GNUNET_MESH_Tunnel *t;
388 for (th = h->th_head; NULL != th; th = th->next)
391 if (GNUNET_NO == th_is_payload (th))
393 LOG (GNUNET_ERROR_TYPE_DEBUG, "# message internal\n");
396 if (GNUNET_YES == t->allow_send)
398 LOG (GNUNET_ERROR_TYPE_DEBUG, "# message payload ok\n");
407 * Get the tunnel handler for the tunnel specified by id from the given handle
408 * @param h Mesh handle
409 * @param tid ID of the wanted tunnel
410 * @return handle to the required tunnel or NULL if not found
412 static struct GNUNET_MESH_Tunnel *
413 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
415 struct GNUNET_MESH_Tunnel *t;
429 * Create a new tunnel and insert it in the tunnel list of the mesh handle
430 * @param h Mesh handle
431 * @param tid desired tid of the tunnel, 0 to assign one automatically
432 * @return handle to the created tunnel
434 static struct GNUNET_MESH_Tunnel *
435 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
437 struct GNUNET_MESH_Tunnel *t;
439 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
440 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
444 t->tid = h->next_tid;
445 while (NULL != retrieve_tunnel (h, h->next_tid))
448 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
449 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
456 t->allow_send = GNUNET_NO;
457 t->nobuffer = GNUNET_NO;
463 * Destroy the specified tunnel.
464 * - Destroys all peers, calling the disconnect callback on each if needed
465 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
466 * - Calls cleaner if tunnel was inbound
467 * - Frees all memory used
469 * @param t Pointer to the tunnel.
470 * @param call_cleaner Whether to call the cleaner handler.
472 * @return Handle to the required tunnel or NULL if not found.
475 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
477 struct GNUNET_MESH_Handle *h;
478 struct GNUNET_MESH_TransmitHandle *th;
479 struct GNUNET_MESH_TransmitHandle *next;
481 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
490 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
492 /* signal tunnel destruction */
493 if ( (NULL != h->cleaner) && (0 != t->peer) && (GNUNET_YES == call_cleaner) )
494 h->cleaner (h->cls, t, t->ctx);
496 /* check that clients did not leave messages behind in the queue */
497 for (th = h->th_head; NULL != th; th = next)
502 /* Clients should have aborted their requests already.
503 * Management traffic should be ok, as clients can't cancel that */
504 GNUNET_break (GNUNET_NO == th_is_payload(th));
505 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
507 /* clean up request */
508 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
509 GNUNET_SCHEDULER_cancel (th->timeout_task);
513 /* if there are no more pending requests with mesh service, cancel active request */
514 /* Note: this should be unnecessary... */
515 if ((0 == message_ready_size (h)) && (NULL != h->th))
517 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
522 GNUNET_PEER_change_rc (t->peer, -1);
529 * Notify client that the transmission has timed out
532 * @param tc task context
535 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
537 struct GNUNET_MESH_TransmitHandle *th = cls;
538 struct GNUNET_MESH_Handle *mesh;
540 mesh = th->tunnel->mesh;
541 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
542 th->tunnel->packet_size = 0;
543 if (GNUNET_YES == th_is_payload (th))
544 th->notify (th->notify_cls, 0, NULL);
546 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
548 /* nothing ready to transmit, no point in asking for transmission */
549 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
556 * Add a transmit handle to the transmission queue and set the
559 * @param h mesh handle with the queue head and tail
560 * @param th handle to the packet to be transmitted
563 add_to_queue (struct GNUNET_MESH_Handle *h,
564 struct GNUNET_MESH_TransmitHandle *th)
566 GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
567 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us == th->timeout.abs_value_us)
570 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
571 (th->timeout), &timeout_transmission, th);
576 * Auxiliary function to send an already constructed packet to the service.
577 * Takes care of creating a new queue element, copying the message and
578 * calling the tmt_rdy function if necessary.
580 * @param h mesh handle
581 * @param msg message to transmit
582 * @param tunnel tunnel this send is related to (NULL if N/A)
585 send_packet (struct GNUNET_MESH_Handle *h,
586 const struct GNUNET_MessageHeader *msg,
587 struct GNUNET_MESH_Tunnel *tunnel);
591 * Send an ack on the tunnel to confirm the processing of a message.
593 * @param t Tunnel on which to send the ACK.
596 send_ack (struct GNUNET_MESH_Tunnel *t)
598 struct GNUNET_MESH_LocalAck msg;
600 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending ACK on tunnel %X\n", t->tid);
601 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
602 msg.header.size = htons (sizeof (msg));
603 msg.tunnel_id = htonl (t->tid);
606 t->mesh->acks_sent++;
609 send_packet (t->mesh, &msg.header, t);
616 * Reconnect callback: tries to reconnect again after a failer previous
618 * @param cls closure (mesh handle)
619 * @param tc task context
622 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
626 * Send a connect packet to the service with the applications and types
627 * requested by the user.
629 * @param h The mesh handle.
633 send_connect (struct GNUNET_MESH_Handle *h)
637 size = sizeof (struct GNUNET_MESH_ClientConnect);
638 size += h->n_ports * sizeof (uint32_t);
640 char buf[size] GNUNET_ALIGN;
641 struct GNUNET_MESH_ClientConnect *msg;
645 /* build connection packet */
646 msg = (struct GNUNET_MESH_ClientConnect *) buf;
647 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
648 msg->header.size = htons (size);
649 ports = (uint32_t *) &msg[1];
650 for (i = 0; i < h->n_ports; i++)
652 ports[i] = htonl (h->ports[i]);
653 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n",
656 LOG (GNUNET_ERROR_TYPE_DEBUG,
657 "Sending %lu bytes long message with %u ports\n",
658 ntohs (msg->header.size), h->n_ports);
659 send_packet (h, &msg->header, NULL);
665 * Reconnect to the service, retransmit all infomation to try to restore the
668 * @param h handle to the mesh
670 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
673 do_reconnect (struct GNUNET_MESH_Handle *h)
675 struct GNUNET_MESH_Tunnel *t;
677 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
678 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
679 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
680 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
681 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
686 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
689 if (NULL != h->client)
691 GNUNET_CLIENT_disconnect (h->client);
695 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
696 if (h->client == NULL)
698 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
701 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
702 GNUNET_TIME_relative_multiply
703 (h->reconnect_time, 2));
704 LOG (GNUNET_ERROR_TYPE_DEBUG,
705 "Next retry in %s\n",
706 GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
713 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
716 /* Rebuild all tunnels */
717 for (t = h->tunnels_head; NULL != t; t = t->next)
719 struct GNUNET_MESH_TunnelMessage tmsg;
722 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
724 /* Tunnel was created by service (incoming tunnel) */
725 /* TODO: Notify service of missing tunnel, to request
726 * creator to recreate path (find a path to him via DHT?)
730 t->allow_send = GNUNET_NO;
731 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
732 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
733 tmsg.tunnel_id = htonl (t->tid);
734 tmsg.port = htonl (t->port);
735 GNUNET_PEER_resolve (t->peer, &tmsg.peer);
738 if (GNUNET_YES == t->nobuffer)
739 options |= GNUNET_MESH_OPTION_NOBUFFER;
741 if (GNUNET_YES == t->reliable)
742 options |= GNUNET_MESH_OPTION_RELIABLE;
744 tmsg.opt = htonl (options);
745 send_packet (h, &tmsg.header, t);
751 * Reconnect callback: tries to reconnect again after a failer previous
753 * @param cls closure (mesh handle)
754 * @param tc task context
757 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
759 struct GNUNET_MESH_Handle *h = cls;
761 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
762 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
769 * Reconnect to the service, retransmit all infomation to try to restore the
772 * @param h handle to the mesh
774 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
777 reconnect (struct GNUNET_MESH_Handle *h)
779 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
780 h->in_receive = GNUNET_NO;
781 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
782 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
787 /******************************************************************************/
788 /*********************** RECEIVE HANDLERS ****************************/
789 /******************************************************************************/
792 * Process the new tunnel notification and add it to the tunnels in the handle
794 * @param h The mesh handle
795 * @param msg A message with the details of the new incoming tunnel
798 process_tunnel_created (struct GNUNET_MESH_Handle *h,
799 const struct GNUNET_MESH_TunnelMessage *msg)
801 struct GNUNET_MESH_Tunnel *t;
802 MESH_TunnelNumber tid;
805 tid = ntohl (msg->tunnel_id);
806 port = ntohl (msg->port);
807 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X:%u\n", tid, port);
808 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
813 if (NULL != h->new_tunnel)
815 t = create_tunnel (h, tid);
816 t->allow_send = GNUNET_NO;
817 t->peer = GNUNET_PEER_intern (&msg->peer);
821 if (0 != (msg->opt & GNUNET_MESH_OPTION_NOBUFFER))
822 t->nobuffer = GNUNET_YES;
824 t->nobuffer = GNUNET_NO;
825 if (0 != (msg->opt & GNUNET_MESH_OPTION_RELIABLE))
826 t->reliable = GNUNET_YES;
828 t->reliable = GNUNET_NO;
829 if (GNUNET_YES == t->reliable &&
830 0 != (msg->opt & GNUNET_MESH_OPTION_OOORDER))
831 t->ooorder = GNUNET_YES;
833 t->ooorder = GNUNET_NO;
834 LOG (GNUNET_ERROR_TYPE_DEBUG, " created tunnel %p\n", t);
835 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, t->port);
836 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
840 struct GNUNET_MESH_TunnelMessage d_msg;
842 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
844 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
845 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
846 d_msg.tunnel_id = msg->tunnel_id;
847 memset (&d_msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
851 send_packet (h, &d_msg.header, NULL);
858 * Process the tunnel destroy notification and free associated resources
860 * @param h The mesh handle
861 * @param msg A message with the details of the tunnel being destroyed
864 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
865 const struct GNUNET_MESH_TunnelMessage *msg)
867 struct GNUNET_MESH_Tunnel *t;
868 MESH_TunnelNumber tid;
870 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel from service\n");
871 tid = ntohl (msg->tunnel_id);
872 t = retrieve_tunnel (h, tid);
876 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X unknown\n", tid);
879 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
880 destroy_tunnel (t, GNUNET_YES);
885 * Process the incoming data packets, call appropriate handlers.
887 * @param h The mesh handle
888 * @param message A message encapsulating the data
891 process_incoming_data (struct GNUNET_MESH_Handle *h,
892 const struct GNUNET_MessageHeader *message)
894 const struct GNUNET_MessageHeader *payload;
895 const struct GNUNET_MESH_MessageHandler *handler;
896 struct GNUNET_MESH_LocalData *dmsg;
897 struct GNUNET_MESH_Tunnel *t;
901 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
903 dmsg = (struct GNUNET_MESH_LocalData *) message;
905 t = retrieve_tunnel (h, ntohl (dmsg->tid));
906 payload = (struct GNUNET_MessageHeader *) &dmsg[1];
907 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s data on tunnel %s [%X]\n",
908 t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV ? "fwd" : "bck",
909 GNUNET_i2s (GNUNET_PEER_resolve2(t->peer)), ntohl (dmsg->tid));
912 /* Tunnel was ignored/destroyed, probably service didn't get it yet */
913 LOG (GNUNET_ERROR_TYPE_DEBUG, " ignored!\n");
916 type = ntohs (payload->type);
917 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload type %u\n", type);
918 for (i = 0; i < h->n_handlers; i++)
920 handler = &h->message_handlers[i];
921 LOG (GNUNET_ERROR_TYPE_DEBUG,
922 " checking handler for type %u\n",
924 if (handler->type == type)
927 handler->callback (h->cls, t, &t->ctx, payload))
929 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
930 GNUNET_MESH_tunnel_destroy (t);
935 LOG (GNUNET_ERROR_TYPE_DEBUG,
936 "callback completed successfully\n");
944 * Process a local ACK message, enabling the client to send
945 * more data to the service.
947 * @param h Mesh handle.
948 * @param message Message itself.
951 process_ack (struct GNUNET_MESH_Handle *h,
952 const struct GNUNET_MessageHeader *message)
954 struct GNUNET_MESH_LocalAck *msg;
955 struct GNUNET_MESH_Tunnel *t;
956 MESH_TunnelNumber tid;
958 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
960 msg = (struct GNUNET_MESH_LocalAck *) message;
961 tid = ntohl (msg->tunnel_id);
962 t = retrieve_tunnel (h, tid);
965 LOG (GNUNET_ERROR_TYPE_WARNING, "ACK on unknown tunnel %X\n", tid);
968 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X!\n", t->tid);
969 t->allow_send = GNUNET_YES;
970 if (NULL == h->th && 0 < t->packet_size)
972 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n");
974 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
975 GNUNET_TIME_UNIT_FOREVER_REL,
976 GNUNET_YES, &send_callback, h);
982 * Process a local reply about info on all tunnels, pass info to the user.
984 * @param h Mesh handle.
985 * @param message Message itself.
988 process_get_tunnels (struct GNUNET_MESH_Handle *h,
989 const struct GNUNET_MessageHeader *message)
991 struct GNUNET_MESH_LocalMonitor *msg;
993 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Tunnels messasge received\n");
995 if (NULL == h->tunnels_cb)
997 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
1001 msg = (struct GNUNET_MESH_LocalMonitor *) message;
1002 if (ntohs (message->size) !=
1003 (sizeof (struct GNUNET_MESH_LocalMonitor) +
1004 sizeof (struct GNUNET_PeerIdentity)))
1006 GNUNET_break_op (0);
1007 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1008 "Get tunnels message: size %hu - expected %u\n",
1009 ntohs (message->size),
1010 sizeof (struct GNUNET_MESH_LocalMonitor));
1013 h->tunnels_cb (h->tunnels_cls,
1014 ntohl (msg->tunnel_id),
1022 * Process a local monitor_tunnel reply, pass info to the user.
1024 * @param h Mesh handle.
1025 * @param message Message itself.
1028 process_show_tunnel (struct GNUNET_MESH_Handle *h,
1029 const struct GNUNET_MessageHeader *message)
1031 struct GNUNET_MESH_LocalMonitor *msg;
1034 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Tunnel messasge received\n");
1036 if (NULL == h->tunnel_cb)
1038 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
1042 /* Verify message sanity */
1043 msg = (struct GNUNET_MESH_LocalMonitor *) message;
1044 esize = sizeof (struct GNUNET_MESH_LocalMonitor);
1045 if (ntohs (message->size) != esize)
1047 GNUNET_break_op (0);
1048 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1049 "Show tunnel message: size %hu - expected %u\n",
1050 ntohs (message->size),
1053 h->tunnel_cb (h->tunnel_cls, NULL, NULL);
1054 h->tunnel_cb = NULL;
1055 h->tunnel_cls = NULL;
1060 h->tunnel_cb (h->tunnel_cls,
1067 * Function to process all messages received from the service
1069 * @param cls closure
1070 * @param msg message received, NULL on timeout or fatal error
1073 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1075 struct GNUNET_MESH_Handle *h = cls;
1080 LOG (GNUNET_ERROR_TYPE_DEBUG,
1081 "Mesh service disconnected, reconnecting\n", h);
1085 type = ntohs (msg->type);
1086 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1087 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1088 GNUNET_MESH_DEBUG_M2S (type));
1091 /* Notify of a new incoming tunnel */
1092 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1093 process_tunnel_created (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1095 /* Notify of a tunnel disconnection */
1096 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1097 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1099 /* Notify of a new data packet in the tunnel */
1100 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA:
1101 process_incoming_data (h, msg);
1103 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1104 process_ack (h, msg);
1106 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1107 process_get_tunnels (h, msg);
1109 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1110 process_show_tunnel (h, msg);
1113 /* We shouldn't get any other packages, log and ignore */
1114 LOG (GNUNET_ERROR_TYPE_WARNING,
1115 "unsolicited message form service (type %s)\n",
1116 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1118 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1119 if (GNUNET_YES == h->in_receive)
1121 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1122 GNUNET_TIME_UNIT_FOREVER_REL);
1126 LOG (GNUNET_ERROR_TYPE_DEBUG,
1127 "in receive off, not calling CLIENT_receive\n");
1132 /******************************************************************************/
1133 /************************ SEND FUNCTIONS ****************************/
1134 /******************************************************************************/
1137 * Function called to send a message to the service.
1138 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1141 * @param cls closure, the mesh handle
1142 * @param size number of bytes available in buf
1143 * @param buf where the callee should write the connect message
1144 * @return number of bytes written to buf
1147 send_callback (void *cls, size_t size, void *buf)
1149 struct GNUNET_MESH_Handle *h = cls;
1150 struct GNUNET_MESH_TransmitHandle *th;
1151 struct GNUNET_MESH_TransmitHandle *next;
1152 struct GNUNET_MESH_Tunnel *t;
1158 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1159 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() Buffer %u\n", size);
1160 if ((0 == size) || (NULL == buf))
1162 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Received NULL send callback on %p\n", h);
1169 nsize = message_ready_size (h);
1170 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1173 if (GNUNET_YES == th_is_payload (th))
1175 struct GNUNET_MESH_LocalData *dmsg;
1176 struct GNUNET_MessageHeader *mh;
1178 LOG (GNUNET_ERROR_TYPE_DEBUG, "# payload\n");
1179 if (GNUNET_NO == t->allow_send)
1181 /* This tunnel is not ready to transmit yet, try next message */
1186 GNUNET_assert (size >= th->size);
1187 dmsg = (struct GNUNET_MESH_LocalData *) cbuf;
1188 mh = (struct GNUNET_MessageHeader *) &dmsg[1];
1189 psize = th->notify (th->notify_cls,
1190 size - sizeof (struct GNUNET_MESH_LocalData),
1194 psize += sizeof (struct GNUNET_MESH_LocalData);
1195 GNUNET_assert (size >= psize);
1196 dmsg->header.size = htons (psize);
1197 dmsg->tid = htonl (t->tid);
1198 dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA);
1199 LOG (GNUNET_ERROR_TYPE_DEBUG, "# payload type %s\n",
1200 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1201 t->allow_send = GNUNET_NO;
1205 LOG (GNUNET_ERROR_TYPE_DEBUG,
1206 "# callback returned size 0, "
1207 "application canceled transmission\n");
1212 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1214 LOG (GNUNET_ERROR_TYPE_DEBUG, "# mesh internal traffic, type %s\n",
1215 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1216 memcpy (cbuf, &th[1], th->size);
1219 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1220 GNUNET_SCHEDULER_cancel (th->timeout_task);
1221 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1224 nsize = message_ready_size (h);
1229 LOG (GNUNET_ERROR_TYPE_DEBUG, "# total size: %u\n", tsize);
1231 size = message_ready_size (h);
1234 LOG (GNUNET_ERROR_TYPE_DEBUG, "# next size: %u\n", size);
1236 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1237 GNUNET_TIME_UNIT_FOREVER_REL,
1238 GNUNET_YES, &send_callback, h);
1242 if (NULL != h->th_head)
1243 LOG (GNUNET_ERROR_TYPE_DEBUG, "# can't transmit any more\n");
1245 LOG (GNUNET_ERROR_TYPE_DEBUG, "# nothing left to transmit\n");
1247 if (GNUNET_NO == h->in_receive)
1249 LOG (GNUNET_ERROR_TYPE_DEBUG, "# start receiving from service\n");
1250 h->in_receive = GNUNET_YES;
1251 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1252 GNUNET_TIME_UNIT_FOREVER_REL);
1254 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send packet() END\n");
1260 * Auxiliary function to send an already constructed packet to the service.
1261 * Takes care of creating a new queue element, copying the message and
1262 * calling the tmt_rdy function if necessary.
1264 * @param h mesh handle
1265 * @param msg message to transmit
1266 * @param tunnel tunnel this send is related to (NULL if N/A)
1269 send_packet (struct GNUNET_MESH_Handle *h,
1270 const struct GNUNET_MessageHeader *msg,
1271 struct GNUNET_MESH_Tunnel *tunnel)
1273 struct GNUNET_MESH_TransmitHandle *th;
1276 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1277 GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1278 msize = ntohs (msg->size);
1279 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1280 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1282 th->tunnel = tunnel;
1283 memcpy (&th[1], msg, msize);
1284 add_to_queue (h, th);
1285 LOG (GNUNET_ERROR_TYPE_DEBUG, " queued\n");
1288 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1290 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1291 GNUNET_TIME_UNIT_FOREVER_REL,
1292 GNUNET_YES, &send_callback, h);
1296 /******************************************************************************/
1297 /********************** API CALL DEFINITIONS *************************/
1298 /******************************************************************************/
1300 struct GNUNET_MESH_Handle *
1301 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1302 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1303 GNUNET_MESH_TunnelEndHandler cleaner,
1304 const struct GNUNET_MESH_MessageHandler *handlers,
1305 const uint32_t *ports)
1307 struct GNUNET_MESH_Handle *h;
1309 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1310 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1311 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1313 h->new_tunnel = new_tunnel;
1314 h->cleaner = cleaner;
1315 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1316 if (h->client == NULL)
1323 h->message_handlers = handlers;
1325 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1326 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1327 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1329 if (NULL != ports && ports[0] != 0 && NULL == new_tunnel)
1332 LOG (GNUNET_ERROR_TYPE_DEBUG,
1333 "no new tunnel handler given, ports parameter is useless!!\n");
1335 if ((NULL == ports || ports[0] == 0) && NULL != new_tunnel)
1338 LOG (GNUNET_ERROR_TYPE_DEBUG,
1339 "no ports given, new tunnel handler will never be called!!\n");
1341 /* count handlers */
1342 for (h->n_handlers = 0;
1343 handlers && handlers[h->n_handlers].type;
1345 for (h->n_ports = 0;
1346 ports && ports[h->n_ports];
1349 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1355 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1357 struct GNUNET_MESH_Tunnel *t;
1358 struct GNUNET_MESH_Tunnel *aux;
1359 struct GNUNET_MESH_TransmitHandle *th;
1361 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1364 LOG (GNUNET_ERROR_TYPE_INFO, "Sent %d ACKs\n", handle->acks_sent);
1365 LOG (GNUNET_ERROR_TYPE_INFO, "Recv %d ACKs\n\n", handle->acks_recv);
1368 t = handle->tunnels_head;
1372 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1375 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1377 destroy_tunnel (t, GNUNET_YES);
1380 while ( (th = handle->th_head) != NULL)
1382 struct GNUNET_MessageHeader *msg;
1384 /* Make sure it is an allowed packet (everything else should have been
1385 * already canceled).
1387 GNUNET_break (GNUNET_NO == th_is_payload (th));
1388 msg = (struct GNUNET_MessageHeader *) &th[1];
1389 switch (ntohs(msg->type))
1391 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1392 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1393 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS:
1394 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL:
1398 LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected msg %u\n",
1402 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1406 if (NULL != handle->th)
1408 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1411 if (NULL != handle->client)
1413 GNUNET_CLIENT_disconnect (handle->client);
1414 handle->client = NULL;
1416 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1418 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1419 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1421 GNUNET_free (handle);
1426 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1427 * and to broadcast).
1429 * @param h mesh handle
1430 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1431 * @param peer peer identity the tunnel should go to
1432 * @param port Port number.
1433 * @param nobuffer Flag for disabling buffering on relay nodes.
1434 * @param reliable Flag for end-to-end reliability.
1436 * @return handle to the tunnel
1438 struct GNUNET_MESH_Tunnel *
1439 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
1441 const struct GNUNET_PeerIdentity *peer,
1446 struct GNUNET_MESH_Tunnel *t;
1447 struct GNUNET_MESH_TunnelMessage msg;
1449 LOG (GNUNET_ERROR_TYPE_DEBUG,
1450 "Creating new tunnel to %s:%u\n",
1451 GNUNET_i2s (peer), port);
1452 t = create_tunnel (h, 0);
1453 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", t);
1454 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", t->tid);
1455 t->ctx = tunnel_ctx;
1456 t->peer = GNUNET_PEER_intern (peer);
1457 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1458 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1459 msg.tunnel_id = htonl (t->tid);
1460 msg.port = htonl (port);
1463 if (GNUNET_YES == reliable)
1464 msg.opt |= GNUNET_MESH_OPTION_RELIABLE;
1465 if (GNUNET_YES == nobuffer)
1466 msg.opt |= GNUNET_MESH_OPTION_NOBUFFER;
1467 msg.opt = htonl (msg.opt);
1469 send_packet (h, &msg.header, t);
1475 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1477 struct GNUNET_MESH_Handle *h;
1478 struct GNUNET_MESH_TunnelMessage msg;
1479 struct GNUNET_MESH_TransmitHandle *th;
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1484 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1485 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1486 msg.tunnel_id = htonl (tunnel->tid);
1487 memset (&msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
1493 struct GNUNET_MESH_TransmitHandle *aux;
1494 if (th->tunnel == tunnel)
1497 /* FIXME call the handler? */
1498 if (GNUNET_YES == th_is_payload (th))
1499 th->notify (th->notify_cls, 0, NULL);
1500 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1508 destroy_tunnel (tunnel, GNUNET_YES);
1509 send_packet (h, &msg.header, NULL);
1514 * Get information about a tunnel.
1516 * @param tunnel Tunnel handle.
1517 * @param option Query (GNUNET_MESH_OPTION_*).
1518 * @param ... dependant on option, currently not used
1520 * @return Union with an answer to the query.
1522 const union MeshTunnelInfo *
1523 GNUNET_MESH_tunnel_get_info (struct GNUNET_MESH_Tunnel *tunnel,
1524 enum MeshTunnelOption option, ...)
1526 const union MeshTunnelInfo *ret;
1530 case GNUNET_MESH_OPTION_NOBUFFER:
1531 ret = (const union MeshTunnelInfo *) &tunnel->nobuffer;
1533 case GNUNET_MESH_OPTION_RELIABLE:
1534 ret = (const union MeshTunnelInfo *) &tunnel->reliable;
1536 case GNUNET_MESH_OPTION_OOORDER:
1537 ret = (const union MeshTunnelInfo *) &tunnel->ooorder;
1539 case GNUNET_MESH_OPTION_PEER:
1540 ret = (const union MeshTunnelInfo *) &tunnel->peer;
1550 struct GNUNET_MESH_TransmitHandle *
1551 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1552 struct GNUNET_TIME_Relative maxdelay,
1554 GNUNET_CONNECTION_TransmitReadyNotify notify,
1557 struct GNUNET_MESH_TransmitHandle *th;
1559 GNUNET_assert (NULL != tunnel);
1560 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
1561 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X\n", tunnel->tid);
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, " allow_send %d\n", tunnel->allow_send);
1563 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1564 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
1566 LOG (GNUNET_ERROR_TYPE_DEBUG, " to destination\n");
1567 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1568 GNUNET_assert (NULL != notify);
1569 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1570 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1571 th->tunnel = tunnel;
1572 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1573 th->size = notify_size + sizeof (struct GNUNET_MESH_LocalData);
1574 tunnel->packet_size = th->size;
1575 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1576 th->notify = notify;
1577 th->notify_cls = notify_cls;
1578 add_to_queue (tunnel->mesh, th);
1579 if (NULL != tunnel->mesh->th)
1581 if (GNUNET_NO == tunnel->allow_send)
1583 LOG (GNUNET_ERROR_TYPE_DEBUG, " call client notify tmt rdy\n");
1585 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1586 GNUNET_TIME_UNIT_FOREVER_REL,
1587 GNUNET_YES, &send_callback,
1589 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
1595 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1597 struct GNUNET_MESH_Handle *mesh;
1599 th->tunnel->packet_size = 0;
1600 mesh = th->tunnel->mesh;
1601 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1602 GNUNET_SCHEDULER_cancel (th->timeout_task);
1603 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1605 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
1607 /* queue empty, no point in asking for transmission */
1608 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1614 GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel)
1621 * Request information about the running mesh peer.
1622 * The callback will be called for every tunnel known to the service,
1623 * listing all active peers that blong to the tunnel.
1625 * If called again on the same handle, it will overwrite the previous
1626 * callback and cls. To retrieve the cls, monitor_cancel must be
1629 * WARNING: unstable API, likely to change in the future!
1631 * @param h Handle to the mesh peer.
1632 * @param callback Function to call with the requested data.
1633 * @param callback_cls Closure for @c callback.
1636 GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
1637 GNUNET_MESH_TunnelsCB callback,
1640 struct GNUNET_MessageHeader msg;
1642 msg.size = htons (sizeof (msg));
1643 msg.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
1644 send_packet (h, &msg, NULL);
1645 h->tunnels_cb = callback;
1646 h->tunnels_cls = callback_cls;
1653 * Cancel a monitor request. The monitor callback will not be called.
1655 * @param h Mesh handle.
1657 * @return Closure given to GNUNET_MESH_monitor, if any.
1660 GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h)
1664 cls = h->tunnels_cls;
1665 h->tunnels_cb = NULL;
1666 h->tunnels_cls = NULL;
1672 * Request information about a specific tunnel of the running mesh peer.
1674 * WARNING: unstable API, likely to change in the future!
1675 * FIXME Add destination option.
1677 * @param h Handle to the mesh peer.
1678 * @param initiator ID of the owner of the tunnel.
1679 * @param tunnel_number Tunnel number.
1680 * @param callback Function to call with the requested data.
1681 * @param callback_cls Closure for @c callback.
1684 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
1685 struct GNUNET_PeerIdentity *initiator,
1686 unsigned int tunnel_number,
1687 GNUNET_MESH_TunnelCB callback,
1690 struct GNUNET_MESH_LocalMonitor msg;
1692 msg.header.size = htons (sizeof (msg));
1693 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL);
1694 msg.owner = *initiator;
1695 msg.tunnel_id = htonl (tunnel_number);
1697 send_packet (h, &msg.header, NULL);
1698 h->tunnel_cb = callback;
1699 h->tunnel_cls = callback_cls;
1706 * Function called to notify a client about the connection
1707 * begin ready to queue more data. "buf" will be
1708 * NULL and "size" zero if the connection was closed for
1709 * writing in the meantime.
1711 * @param cls closure
1712 * @param size number of bytes available in buf
1713 * @param buf where the callee should write the message
1714 * @return number of bytes written to buf
1717 mesh_mq_ntr (void *cls, size_t size,
1720 struct GNUNET_MQ_Handle *mq = cls;
1721 struct MeshMQState *state = GNUNET_MQ_impl_state (mq);
1722 const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
1725 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "mesh-mq",
1726 "writing message (t: %u, s: %u) to buffer\n",
1727 ntohs (msg->type), ntohs (msg->size));
1732 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
1735 msize = ntohs (msg->size);
1736 GNUNET_assert (msize <= size);
1737 memcpy (buf, msg, msize);
1738 GNUNET_MQ_impl_send_continue (mq);
1744 * Signature of functions implementing the
1745 * sending functionality of a message queue.
1747 * @param mq the message queue
1748 * @param msg the message to send
1749 * @param impl_state state of the implementation
1752 mesh_mq_send_impl (struct GNUNET_MQ_Handle *mq,
1753 const struct GNUNET_MessageHeader *msg, void *impl_state)
1755 struct MeshMQState *state = impl_state;
1757 GNUNET_assert (NULL == state->th);
1758 GNUNET_MQ_impl_send_commit (mq);
1759 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "mesh-mq",
1760 "calling ntr for message (t: %u, s: %u)\n",
1761 ntohs (msg->type), ntohs (msg->size));
1763 GNUNET_MESH_notify_transmit_ready (state->tunnel,
1764 /* FIXME: add option for corking */
1766 GNUNET_TIME_UNIT_FOREVER_REL,
1774 * Signature of functions implementing the
1775 * destruction of a message queue.
1776 * Implementations must not free 'mq', but should
1777 * take care of 'impl_state'.
1779 * @param mq the message queue to destroy
1780 * @param impl_state state of the implementation
1783 mesh_mq_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
1785 struct MeshMQState *state = impl_state;
1787 if (NULL != state->th)
1788 GNUNET_MESH_notify_transmit_ready_cancel (state->th);
1790 GNUNET_free (state);
1795 * Create a message queue for a mesh tunnel.
1796 * The message queue can only be used to transmit messages,
1797 * not to receive them.
1799 * @param tunnel the tunnel to create the message qeue for
1800 * @return a message queue to messages over the tunnel
1802 struct GNUNET_MQ_Handle *
1803 GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel)
1805 struct GNUNET_MQ_Handle *mq;
1806 struct MeshMQState *state;
1808 state = GNUNET_new (struct MeshMQState);
1809 state->tunnel = tunnel;
1811 mq = GNUNET_MQ_queue_for_callbacks (mesh_mq_send_impl,
1812 mesh_mq_destroy_impl,
1813 NULL, /* FIXME: cancel impl. */
1815 NULL, /* no msg handlers */
1816 NULL, /* no err handlers */
1817 NULL); /* no handler cls */