2 This file is part of GNUnet.
3 Copyright (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., 51 Franklin Street, Fifth Floor,
15 Boston, MA 02110-1301, USA.
19 * @file cadet/cadet_api.c
20 * @brief cadet api: client implementation of new cadet service
21 * @author Bartlomiej Polot
25 #include "gnunet_util_lib.h"
26 #include "gnunet_cadet_service.h"
28 #include "cadet_protocol.h"
30 #define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__)
31 #define DATA_OVERHEAD sizeof(struct GNUNET_CADET_LocalData)
33 /******************************************************************************/
34 /************************ DATA STRUCTURES ****************************/
35 /******************************************************************************/
38 * Transmission queue to the service
40 struct GNUNET_CADET_TransmitHandle
46 struct GNUNET_CADET_TransmitHandle *next;
51 struct GNUNET_CADET_TransmitHandle *prev;
54 * Channel this message is sent on / for (may be NULL for control messages).
56 struct GNUNET_CADET_Channel *channel;
59 * Callback to obtain the message to transmit, or NULL if we
60 * got the message in 'data'. Notice that messages built
61 * by 'notify' need to be encapsulated with information about
64 GNUNET_CONNECTION_TransmitReadyNotify notify;
67 * Closure for 'notify'
72 * How long is this message valid. Once the timeout has been
73 * reached, the message must no longer be sent. If this
74 * is a message with a 'notify' callback set, the 'notify'
75 * function should be called with 'buf' NULL and size 0.
77 struct GNUNET_TIME_Absolute timeout;
80 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
82 struct GNUNET_SCHEDULER_Task * timeout_task;
85 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
95 GNUNET_CADET_ChannelCB channel_cb;
100 GNUNET_CADET_PeersCB peers_cb;
105 GNUNET_CADET_PeerCB peer_cb;
110 GNUNET_CADET_TunnelsCB tunnels_cb;
115 GNUNET_CADET_TunnelCB tunnel_cb;
120 * Opaque handle to the service.
122 struct GNUNET_CADET_Handle
126 * Handle to the server connection, to send messages later
128 struct GNUNET_CLIENT_Connection *client;
131 * Set of handlers used for processing incoming messages in the channels
133 const struct GNUNET_CADET_MessageHandler *message_handlers;
136 * Number of handlers in the handlers array.
138 unsigned int n_handlers;
143 const uint32_t *ports;
148 unsigned int n_ports;
151 * Double linked list of the channels this client is connected to, head.
153 struct GNUNET_CADET_Channel *channels_head;
156 * Double linked list of the channels this client is connected to, tail.
158 struct GNUNET_CADET_Channel *channels_tail;
161 * Callback for inbound channel creation
163 GNUNET_CADET_InboundChannelNotificationHandler *new_channel;
166 * Callback for inbound channel disconnection
168 GNUNET_CADET_ChannelEndHandler *cleaner;
171 * Handle to cancel pending transmissions in case of disconnection
173 struct GNUNET_CLIENT_TransmitHandle *th;
176 * Closure for all the handlers given by the client
181 * Messages to send to the service, head.
183 struct GNUNET_CADET_TransmitHandle *th_head;
186 * Messages to send to the service, tail.
188 struct GNUNET_CADET_TransmitHandle *th_tail;
191 * chid of the next channel to create (to avoid reusing IDs often)
193 CADET_ChannelNumber next_chid;
196 * Have we started the task to receive messages from the service
197 * yet? We do this after we send the 'CADET_LOCAL_CONNECT' message.
202 * Configuration given by the client, in case of reconnection
204 const struct GNUNET_CONFIGURATION_Handle *cfg;
207 * Time to the next reconnect in case one reconnect fails
209 struct GNUNET_TIME_Relative reconnect_time;
212 * Task for trying to reconnect.
214 struct GNUNET_SCHEDULER_Task * reconnect_task;
217 * Callback for an info task (only one active at a time).
219 union CadetInfoCB info_cb;
222 * Info callback closure for @c info_cb.
229 * Description of a peer
231 struct GNUNET_CADET_Peer
234 * ID of the peer in short form
239 * Channel this peer belongs to
241 struct GNUNET_CADET_Channel *t;
246 * Opaque handle to a channel.
248 struct GNUNET_CADET_Channel
254 struct GNUNET_CADET_Channel *next;
259 struct GNUNET_CADET_Channel *prev;
262 * Handle to the cadet this channel belongs to
264 struct GNUNET_CADET_Handle *cadet;
267 * Local ID of the channel
269 CADET_ChannelNumber chid;
277 * Other end of the channel.
282 * Any data the caller wants to put in here
287 * Size of packet queued in this channel
289 unsigned int packet_size;
292 * Channel options: reliability, etc.
294 enum GNUNET_CADET_ChannelOption options;
297 * Are we allowed to send to the service?
305 * Implementation state for cadet's message queue.
310 * The current transmit handle, or NULL
311 * if no transmit is active.
313 struct GNUNET_CADET_TransmitHandle *th;
316 * Channel to send the data over.
318 struct GNUNET_CADET_Channel *channel;
322 /******************************************************************************/
323 /*********************** DECLARATIONS *************************/
324 /******************************************************************************/
327 * Function called to send a message to the service.
328 * "buf" will be NULL and "size" zero if the socket was closed for writing in
331 * @param cls closure, the cadet handle
332 * @param size number of bytes available in buf
333 * @param buf where the callee should write the connect message
334 * @return number of bytes written to buf
337 send_callback (void *cls, size_t size, void *buf);
340 /******************************************************************************/
341 /*********************** AUXILIARY FUNCTIONS *************************/
342 /******************************************************************************/
345 * Check if transmission is a payload packet.
347 * @param th Transmission handle.
349 * @return #GNUNET_YES if it is a payload packet,
350 * #GNUNET_NO if it is a cadet management packet.
353 th_is_payload (struct GNUNET_CADET_TransmitHandle *th)
355 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
360 * Check whether there is any message ready in the queue and find the size.
362 * @param h Cadet handle.
364 * @return The size of the first ready message in the queue, including overhead.
365 * 0 if there is none.
368 message_ready_size (struct GNUNET_CADET_Handle *h)
370 struct GNUNET_CADET_TransmitHandle *th;
371 struct GNUNET_CADET_Channel *ch;
373 for (th = h->th_head; NULL != th; th = th->next)
376 if (GNUNET_NO == th_is_payload (th) || GNUNET_YES == ch->allow_send)
384 * Get the channel handler for the channel specified by id from the given handle
385 * @param h Cadet handle
386 * @param chid ID of the wanted channel
387 * @return handle to the required channel or NULL if not found
389 static struct GNUNET_CADET_Channel *
390 retrieve_channel (struct GNUNET_CADET_Handle *h, CADET_ChannelNumber chid)
392 struct GNUNET_CADET_Channel *ch;
394 ch = h->channels_head;
397 if (ch->chid == chid)
406 * Create a new channel and insert it in the channel list of the cadet handle
408 * @param h Cadet handle
409 * @param chid Desired chid of the channel, 0 to assign one automatically.
411 * @return Handle to the created channel.
413 static struct GNUNET_CADET_Channel *
414 create_channel (struct GNUNET_CADET_Handle *h, CADET_ChannelNumber chid)
416 struct GNUNET_CADET_Channel *ch;
418 ch = GNUNET_new (struct GNUNET_CADET_Channel);
419 GNUNET_CONTAINER_DLL_insert (h->channels_head, h->channels_tail, ch);
423 ch->chid = h->next_chid;
424 while (NULL != retrieve_channel (h, h->next_chid))
427 h->next_chid &= ~GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
428 h->next_chid |= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
435 ch->allow_send = GNUNET_NO;
441 * Destroy the specified channel.
442 * - Destroys all peers, calling the disconnect callback on each if needed
443 * - Cancels all outgoing traffic for that channel, calling respective notifys
444 * - Calls cleaner if channel was inbound
445 * - Frees all memory used
447 * @param ch Pointer to the channel.
448 * @param call_cleaner Whether to call the cleaner handler.
450 * @return Handle to the required channel or NULL if not found.
453 destroy_channel (struct GNUNET_CADET_Channel *ch, int call_cleaner)
455 struct GNUNET_CADET_Handle *h;
456 struct GNUNET_CADET_TransmitHandle *th;
457 struct GNUNET_CADET_TransmitHandle *next;
459 LOG (GNUNET_ERROR_TYPE_DEBUG, " destroy_channel %X\n", ch->chid);
468 GNUNET_CONTAINER_DLL_remove (h->channels_head, h->channels_tail, ch);
470 /* signal channel destruction */
471 if ( (NULL != h->cleaner) && (0 != ch->peer) && (GNUNET_YES == call_cleaner) )
473 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling cleaner\n");
474 h->cleaner (h->cls, ch, ch->ctx);
477 /* check that clients did not leave messages behind in the queue */
478 for (th = h->th_head; NULL != th; th = next)
481 if (th->channel != ch)
483 /* Clients should have aborted their requests already.
484 * Management traffic should be ok, as clients can't cancel that.
485 * If the service crashed and we are reconnecting, it's ok.
487 GNUNET_break (GNUNET_NO == th_is_payload (th)
488 || GNUNET_NO == h->in_receive);
489 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
491 /* clean up request */
492 if (NULL != th->timeout_task)
493 GNUNET_SCHEDULER_cancel (th->timeout_task);
497 /* if there are no more pending requests with cadet service, cancel active request */
498 /* Note: this should be unnecessary... */
499 if ((0 == message_ready_size (h)) && (NULL != h->th))
501 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
506 GNUNET_PEER_change_rc (ch->peer, -1);
513 * Notify client that the transmission has timed out
516 * @param tc task context
519 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
521 struct GNUNET_CADET_TransmitHandle *th = cls;
522 struct GNUNET_CADET_Handle *cadet = th->channel->cadet;
524 th->timeout_task = NULL;
525 th->channel->packet_size = 0;
526 GNUNET_CONTAINER_DLL_remove (cadet->th_head, cadet->th_tail, th);
527 if (GNUNET_YES == th_is_payload (th))
528 GNUNET_break (0 == th->notify (th->notify_cls, 0, NULL));
530 if ((0 == message_ready_size (cadet)) && (NULL != cadet->th))
532 /* nothing ready to transmit, no point in asking for transmission */
533 GNUNET_CLIENT_notify_transmit_ready_cancel (cadet->th);
540 * Add a transmit handle to the transmission queue and set the
543 * @param h cadet handle with the queue head and tail
544 * @param th handle to the packet to be transmitted
547 add_to_queue (struct GNUNET_CADET_Handle *h,
548 struct GNUNET_CADET_TransmitHandle *th)
550 GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
551 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us == th->timeout.abs_value_us)
554 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
555 (th->timeout), &timeout_transmission, th);
560 * Auxiliary function to send an already constructed packet to the service.
561 * Takes care of creating a new queue element, copying the message and
562 * calling the tmt_rdy function if necessary.
564 * @param h cadet handle
565 * @param msg message to transmit
566 * @param channel channel this send is related to (NULL if N/A)
569 send_packet (struct GNUNET_CADET_Handle *h,
570 const struct GNUNET_MessageHeader *msg,
571 struct GNUNET_CADET_Channel *channel);
575 * Send an ack on the channel to confirm the processing of a message.
577 * @param ch Channel on which to send the ACK.
580 send_ack (struct GNUNET_CADET_Channel *ch)
582 struct GNUNET_CADET_LocalAck msg;
584 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending ACK on channel %X\n", ch->chid);
585 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
586 msg.header.size = htons (sizeof (msg));
587 msg.channel_id = htonl (ch->chid);
589 send_packet (ch->cadet, &msg.header, ch);
596 * Reconnect callback: tries to reconnect again after a failer previous
598 * @param cls closure (cadet handle)
599 * @param tc task context
602 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
606 * Send a connect packet to the service with the applications and types
607 * requested by the user.
609 * @param h The cadet handle.
613 send_connect (struct GNUNET_CADET_Handle *h)
617 size = sizeof (struct GNUNET_CADET_ClientConnect);
618 size += h->n_ports * sizeof (uint32_t);
620 char buf[size] GNUNET_ALIGN;
621 struct GNUNET_CADET_ClientConnect *msg;
625 /* build connection packet */
626 msg = (struct GNUNET_CADET_ClientConnect *) buf;
627 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT);
628 msg->header.size = htons (size);
629 ports = (uint32_t *) &msg[1];
630 for (i = 0; i < h->n_ports; i++)
632 ports[i] = htonl (h->ports[i]);
633 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n",
636 LOG (GNUNET_ERROR_TYPE_DEBUG,
637 "Sending %lu bytes long message with %u ports\n",
638 ntohs (msg->header.size), h->n_ports);
639 send_packet (h, &msg->header, NULL);
645 * Reconnect to the service, retransmit all infomation to try to restore the
648 * @param h handle to the cadet
650 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
653 do_reconnect (struct GNUNET_CADET_Handle *h)
655 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
656 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
657 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
658 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
659 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
664 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
667 if (NULL != h->client)
669 GNUNET_CLIENT_disconnect (h->client);
673 h->client = GNUNET_CLIENT_connect ("cadet", h->cfg);
674 if (h->client == NULL)
676 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
679 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
680 GNUNET_TIME_relative_multiply
681 (h->reconnect_time, 2));
682 LOG (GNUNET_ERROR_TYPE_DEBUG, "Next retry in %s\n",
683 GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
690 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
697 * Reconnect callback: tries to reconnect again after a failer previous
699 * @param cls closure (cadet handle)
700 * @param tc task context
703 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
705 struct GNUNET_CADET_Handle *h = cls;
707 h->reconnect_task = NULL;
708 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
715 * Reconnect to the service, retransmit all infomation to try to restore the
718 * @param h handle to the cadet
720 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
723 reconnect (struct GNUNET_CADET_Handle *h)
725 struct GNUNET_CADET_Channel *ch;
727 LOG (GNUNET_ERROR_TYPE_DEBUG,
728 "Requested RECONNECT, destroying all channels\n");
729 h->in_receive = GNUNET_NO;
730 for (ch = h->channels_head; NULL != ch; ch = h->channels_head)
731 destroy_channel (ch, GNUNET_YES);
732 if (NULL == h->reconnect_task)
733 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
738 /******************************************************************************/
739 /*********************** RECEIVE HANDLERS ****************************/
740 /******************************************************************************/
743 * Process the new channel notification and add it to the channels in the handle
745 * @param h The cadet handle
746 * @param msg A message with the details of the new incoming channel
749 process_channel_created (struct GNUNET_CADET_Handle *h,
750 const struct GNUNET_CADET_ChannelMessage *msg)
752 struct GNUNET_CADET_Channel *ch;
753 CADET_ChannelNumber chid;
756 chid = ntohl (msg->channel_id);
757 port = ntohl (msg->port);
758 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming channel %X:%u\n", chid, port);
759 if (chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
764 if (NULL != h->new_channel)
768 ch = create_channel (h, chid);
769 ch->allow_send = GNUNET_NO;
770 ch->peer = GNUNET_PEER_intern (&msg->peer);
774 ch->options = ntohl (msg->opt);
776 LOG (GNUNET_ERROR_TYPE_DEBUG, " created channel %p\n", ch);
777 ctx = h->new_channel (h->cls, ch, &msg->peer, ch->port, ch->options);
780 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
784 struct GNUNET_CADET_ChannelMessage d_msg;
786 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming channels\n");
788 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
789 d_msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
790 d_msg.channel_id = msg->channel_id;
791 memset (&d_msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
795 send_packet (h, &d_msg.header, NULL);
802 * Process the channel destroy notification and free associated resources
804 * @param h The cadet handle
805 * @param msg A message with the details of the channel being destroyed
808 process_channel_destroy (struct GNUNET_CADET_Handle *h,
809 const struct GNUNET_CADET_ChannelMessage *msg)
811 struct GNUNET_CADET_Channel *ch;
812 CADET_ChannelNumber chid;
814 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel Destroy received from service\n");
815 chid = ntohl (msg->channel_id);
816 ch = retrieve_channel (h, chid);
820 LOG (GNUNET_ERROR_TYPE_DEBUG, "channel %X unknown\n", chid);
823 LOG (GNUNET_ERROR_TYPE_DEBUG, " destroying channel %X\n", ch->chid);
824 destroy_channel (ch, GNUNET_YES);
829 * Process the incoming data packets, call appropriate handlers.
831 * @param h The cadet handle
832 * @param message A message encapsulating the data
835 process_incoming_data (struct GNUNET_CADET_Handle *h,
836 const struct GNUNET_MessageHeader *message)
838 const struct GNUNET_MessageHeader *payload;
839 const struct GNUNET_CADET_MessageHandler *handler;
840 struct GNUNET_CADET_LocalData *dmsg;
841 struct GNUNET_CADET_Channel *ch;
846 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
847 dmsg = (struct GNUNET_CADET_LocalData *) message;
848 ch = retrieve_channel (h, ntohl (dmsg->id));
855 payload = (struct GNUNET_MessageHeader *) &dmsg[1];
856 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s data on channel %s [%X]\n",
857 GC_f2s (ch->chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV),
858 GNUNET_i2s (GNUNET_PEER_resolve2 (ch->peer)), ntohl (dmsg->id));
860 size = ntohs (message->size);
861 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u bytes\n", size);
863 type = ntohs (payload->type);
864 size = ntohs (payload->size);
865 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload type %s\n", GC_m2s (type));
866 for (i = 0; i < h->n_handlers; i++)
868 handler = &h->message_handlers[i];
869 LOG (GNUNET_ERROR_TYPE_DEBUG, " checking handler for type %u\n",
871 if (handler->type == type)
874 handler->callback (h->cls, ch, &ch->ctx, payload))
876 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
877 GNUNET_CADET_channel_destroy (ch);
882 LOG (GNUNET_ERROR_TYPE_DEBUG,
883 "callback completed successfully\n");
892 * Process a local ACK message, enabling the client to send
893 * more data to the service.
895 * @param h Cadet handle.
896 * @param message Message itself.
899 process_ack (struct GNUNET_CADET_Handle *h,
900 const struct GNUNET_MessageHeader *message)
902 struct GNUNET_CADET_LocalAck *msg;
903 struct GNUNET_CADET_Channel *ch;
904 CADET_ChannelNumber chid;
906 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
907 msg = (struct GNUNET_CADET_LocalAck *) message;
908 chid = ntohl (msg->channel_id);
909 ch = retrieve_channel (h, chid);
912 LOG (GNUNET_ERROR_TYPE_DEBUG, "ACK on unknown channel %X\n", chid);
915 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X!\n", ch->chid);
916 ch->allow_send = GNUNET_YES;
917 if (NULL == h->th && 0 < ch->packet_size)
919 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n");
920 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, ch->packet_size,
921 GNUNET_TIME_UNIT_FOREVER_REL,
922 GNUNET_YES, &send_callback, h);
928 * Process a local reply about info on all channels, pass info to the user.
930 * @param h Cadet handle.
931 * @param message Message itself.
934 // process_get_channels (struct GNUNET_CADET_Handle *h,
935 // const struct GNUNET_MessageHeader *message)
937 // struct GNUNET_CADET_LocalInfo *msg;
939 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Channels messasge received\n");
941 // if (NULL == h->channels_cb)
943 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
947 // msg = (struct GNUNET_CADET_LocalInfo *) message;
948 // if (ntohs (message->size) !=
949 // (sizeof (struct GNUNET_CADET_LocalInfo) +
950 // sizeof (struct GNUNET_PeerIdentity)))
952 // GNUNET_break_op (0);
953 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
954 // "Get channels message: size %hu - expected %u\n",
955 // ntohs (message->size),
956 // sizeof (struct GNUNET_CADET_LocalInfo));
959 // h->channels_cb (h->channels_cls,
960 // ntohl (msg->channel_id),
962 // &msg->destination);
968 * Process a local monitor_channel reply, pass info to the user.
970 * @param h Cadet handle.
971 * @param message Message itself.
974 // process_show_channel (struct GNUNET_CADET_Handle *h,
975 // const struct GNUNET_MessageHeader *message)
977 // struct GNUNET_CADET_LocalInfo *msg;
980 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Channel messasge received\n");
982 // if (NULL == h->channel_cb)
984 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
988 // /* Verify message sanity */
989 // msg = (struct GNUNET_CADET_LocalInfo *) message;
990 // esize = sizeof (struct GNUNET_CADET_LocalInfo);
991 // if (ntohs (message->size) != esize)
993 // GNUNET_break_op (0);
994 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
995 // "Show channel message: size %hu - expected %u\n",
996 // ntohs (message->size),
999 // h->channel_cb (h->channel_cls, NULL, NULL);
1000 // h->channel_cb = NULL;
1001 // h->channel_cls = NULL;
1006 // h->channel_cb (h->channel_cls,
1007 // &msg->destination,
1014 * Process a local reply about info on all tunnels, pass info to the user.
1016 * @param h Cadet handle.
1017 * @param message Message itself.
1020 process_get_peers (struct GNUNET_CADET_Handle *h,
1021 const struct GNUNET_MessageHeader *message)
1023 struct GNUNET_CADET_LocalInfoPeer *msg;
1026 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Peer messasge received\n");
1028 if (NULL == h->info_cb.peers_cb)
1030 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1034 size = ntohs (message->size);
1035 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) > size)
1037 h->info_cb.peers_cb (h->info_cls, NULL, -1, 0, 0);
1038 h->info_cb.peers_cb = NULL;
1043 msg = (struct GNUNET_CADET_LocalInfoPeer *) message;
1044 h->info_cb.peers_cb (h->info_cls, &msg->destination,
1045 (int) ntohs (msg->tunnel),
1046 (unsigned int ) ntohs (msg->paths),
1052 * Process a local peer info reply, pass info to the user.
1054 * @param h Cadet handle.
1055 * @param message Message itself.
1058 process_get_peer (struct GNUNET_CADET_Handle *h,
1059 const struct GNUNET_MessageHeader *message)
1061 struct GNUNET_CADET_LocalInfoTunnel *msg;
1065 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Tunnel messasge received\n");
1066 if (NULL == h->info_cb.peer_cb)
1068 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1072 /* Verify message sanity */
1073 msg = (struct GNUNET_CADET_LocalInfoTunnel *) message;
1074 msize = ntohs (message->size);
1075 esize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
1078 GNUNET_break_op (0);
1079 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1082 // esize += ch_n * sizeof (CADET_ChannelNumber);
1083 // esize += c_n * sizeof (struct GNUNET_CADET_Hash);
1086 GNUNET_break_op (0);
1087 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "m:%u, e: %u\n", msize, esize);
1088 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1092 /* Call Callback with tunnel info. */
1093 h->info_cb.peer_cb (h->info_cls, &msg->destination, 0, 0, 0, NULL);
1096 h->info_cb.peer_cb = NULL;
1102 * Process a local reply about info on all tunnels, pass info to the user.
1104 * @param h Cadet handle.
1105 * @param message Message itself.
1108 process_get_tunnels (struct GNUNET_CADET_Handle *h,
1109 const struct GNUNET_MessageHeader *message)
1111 struct GNUNET_CADET_LocalInfoTunnel *msg;
1114 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Tunnels messasge received\n");
1116 if (NULL == h->info_cb.tunnels_cb)
1118 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1122 size = ntohs (message->size);
1123 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) > size)
1125 h->info_cb.tunnels_cb (h->info_cls, NULL, 0, 0, 0, 0);
1126 h->info_cb.tunnels_cb = NULL;
1131 msg = (struct GNUNET_CADET_LocalInfoTunnel *) message;
1132 h->info_cb.tunnels_cb (h->info_cls, &msg->destination,
1133 ntohl (msg->channels), ntohl (msg->connections),
1134 ntohs (msg->estate), ntohs (msg->cstate));
1140 * Process a local tunnel info reply, pass info to the user.
1142 * @param h Cadet handle.
1143 * @param message Message itself.
1146 process_get_tunnel (struct GNUNET_CADET_Handle *h,
1147 const struct GNUNET_MessageHeader *message)
1149 struct GNUNET_CADET_LocalInfoTunnel *msg;
1154 struct GNUNET_CADET_Hash *conns;
1155 CADET_ChannelNumber *chns;
1157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Tunnel messasge received\n");
1158 if (NULL == h->info_cb.tunnel_cb)
1160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1164 /* Verify message sanity */
1165 msg = (struct GNUNET_CADET_LocalInfoTunnel *) message;
1166 msize = ntohs (message->size);
1167 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1170 GNUNET_break_op (0);
1171 h->info_cb.tunnel_cb (h->info_cls, NULL, 0, 0, NULL, NULL, 0, 0);
1174 ch_n = ntohl (msg->channels);
1175 c_n = ntohl (msg->connections);
1176 esize += ch_n * sizeof (CADET_ChannelNumber);
1177 esize += c_n * sizeof (struct GNUNET_CADET_Hash);
1180 GNUNET_break_op (0);
1181 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "m:%u, e: %u (%u ch, %u conn)\n",
1182 msize, esize, ch_n, c_n);
1183 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u (%u ch, %u conn)\n",
1184 sizeof (struct GNUNET_CADET_LocalInfoTunnel),
1185 sizeof (CADET_ChannelNumber), sizeof (struct GNUNET_HashCode));
1186 h->info_cb.tunnel_cb (h->info_cls, NULL, 0, 0, NULL, NULL, 0, 0);
1190 /* Call Callback with tunnel info. */
1191 conns = (struct GNUNET_CADET_Hash *) &msg[1];
1192 chns = (CADET_ChannelNumber *) &conns[c_n];
1193 h->info_cb.tunnel_cb (h->info_cls, &msg->destination,
1194 ch_n, c_n, chns, conns,
1195 ntohs (msg->estate), ntohs (msg->cstate));
1198 h->info_cb.tunnel_cb = NULL;
1204 * Function to process all messages received from the service
1206 * @param cls closure
1207 * @param msg message received, NULL on timeout or fatal error
1210 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1212 struct GNUNET_CADET_Handle *h = cls;
1217 LOG (GNUNET_ERROR_TYPE_DEBUG,
1218 "Cadet service disconnected, reconnecting\n", h);
1222 type = ntohs (msg->type);
1223 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1224 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1228 /* Notify of a new incoming channel */
1229 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1230 process_channel_created (h, (struct GNUNET_CADET_ChannelMessage *) msg);
1232 /* Notify of a channel disconnection */
1233 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY: /* TODO separate(gid problem)*/
1234 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
1235 process_channel_destroy (h, (struct GNUNET_CADET_ChannelMessage *) msg);
1237 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA:
1238 process_incoming_data (h, msg);
1240 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK:
1241 process_ack (h, msg);
1243 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1244 // process_get_channels (h, msg);
1246 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1247 // process_show_channel (h, msg);
1249 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1250 process_get_peers (h, msg);
1252 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1253 process_get_peer (h, msg);
1255 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1256 process_get_tunnels (h, msg);
1258 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1259 process_get_tunnel (h, msg);
1261 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1262 // process_show_channel (h, msg);
1265 /* We shouldn't get any other packages, log and ignore */
1266 LOG (GNUNET_ERROR_TYPE_WARNING,
1267 "unsolicited message form service (type %s)\n",
1268 GC_m2s (ntohs (msg->type)));
1270 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1271 if (GNUNET_YES == h->in_receive)
1273 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1274 GNUNET_TIME_UNIT_FOREVER_REL);
1278 LOG (GNUNET_ERROR_TYPE_DEBUG,
1279 "in receive off, not calling CLIENT_receive\n");
1284 /******************************************************************************/
1285 /************************ SEND FUNCTIONS ****************************/
1286 /******************************************************************************/
1289 * Function called to send a message to the service.
1290 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1293 * @param cls closure, the cadet handle
1294 * @param size number of bytes available in buf
1295 * @param buf where the callee should write the connect message
1296 * @return number of bytes written to buf
1299 send_callback (void *cls, size_t size, void *buf)
1301 struct GNUNET_CADET_Handle *h = cls;
1302 struct GNUNET_CADET_TransmitHandle *th;
1303 struct GNUNET_CADET_TransmitHandle *next;
1304 struct GNUNET_CADET_Channel *ch;
1310 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1311 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send callback, buffer %u\n", size);
1312 if ((0 == size) || (NULL == buf))
1314 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Received NULL send callback on %p\n", h);
1321 nsize = message_ready_size (h);
1322 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1325 if (GNUNET_YES == th_is_payload (th))
1327 struct GNUNET_CADET_LocalData *dmsg;
1328 struct GNUNET_MessageHeader *mh;
1330 LOG (GNUNET_ERROR_TYPE_DEBUG, "# payload, %u bytes on %X (%p)\n",
1331 th->size, ch->chid, ch);
1332 if (GNUNET_NO == ch->allow_send)
1334 /* This channel is not ready to transmit yet, Try the next message */
1338 ch->packet_size = 0;
1339 GNUNET_assert (size >= th->size);
1340 dmsg = (struct GNUNET_CADET_LocalData *) cbuf;
1341 mh = (struct GNUNET_MessageHeader *) &dmsg[1];
1342 psize = th->notify (th->notify_cls, size - DATA_OVERHEAD, mh);
1346 GNUNET_assert (sizeof (struct GNUNET_MessageHeader) <= psize);
1347 psize += DATA_OVERHEAD;
1348 GNUNET_assert (size >= psize);
1349 dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
1350 dmsg->header.size = htons (psize);
1351 dmsg->id = htonl (ch->chid);
1352 LOG (GNUNET_ERROR_TYPE_DEBUG, "# sending, type %s\n",
1353 GC_m2s (ntohs (mh->type)));
1354 ch->allow_send = GNUNET_NO;
1358 LOG (GNUNET_ERROR_TYPE_DEBUG,
1359 "# callback returned size 0, "
1360 "application canceled transmission\n");
1365 const struct GNUNET_MessageHeader *mh;
1367 mh = (const struct GNUNET_MessageHeader *) &th[1];
1368 LOG (GNUNET_ERROR_TYPE_DEBUG, "# cadet internal traffic, type %s\n",
1369 GC_m2s (ntohs (mh->type)));
1370 memcpy (cbuf, &th[1], th->size);
1373 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= psize);
1374 if (th->timeout_task != NULL)
1375 GNUNET_SCHEDULER_cancel (th->timeout_task);
1377 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1379 nsize = message_ready_size (h);
1384 LOG (GNUNET_ERROR_TYPE_DEBUG, "# total size: %u\n", tsize);
1386 size = message_ready_size (h);
1389 LOG (GNUNET_ERROR_TYPE_DEBUG, "# next size: %u\n", size);
1391 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1392 GNUNET_TIME_UNIT_FOREVER_REL,
1393 GNUNET_YES, &send_callback, h);
1397 if (NULL != h->th_head)
1398 LOG (GNUNET_ERROR_TYPE_DEBUG, "# nothing ready to transmit\n");
1400 LOG (GNUNET_ERROR_TYPE_DEBUG, "# nothing left to transmit\n");
1402 if (GNUNET_NO == h->in_receive)
1404 LOG (GNUNET_ERROR_TYPE_DEBUG, "# start receiving from service\n");
1405 h->in_receive = GNUNET_YES;
1406 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1407 GNUNET_TIME_UNIT_FOREVER_REL);
1409 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send callback() END\n");
1415 * Auxiliary function to send an already constructed packet to the service.
1416 * Takes care of creating a new queue element, copying the message and
1417 * calling the tmt_rdy function if necessary.
1419 * @param h cadet handle
1420 * @param msg message to transmit
1421 * @param channel channel this send is related to (NULL if N/A)
1424 send_packet (struct GNUNET_CADET_Handle *h,
1425 const struct GNUNET_MessageHeader *msg,
1426 struct GNUNET_CADET_Channel *channel)
1428 struct GNUNET_CADET_TransmitHandle *th;
1431 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1432 GC_m2s(ntohs(msg->type)));
1433 msize = ntohs (msg->size);
1434 th = GNUNET_malloc (sizeof (struct GNUNET_CADET_TransmitHandle) + msize);
1435 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1437 th->channel = channel;
1438 memcpy (&th[1], msg, msize);
1439 add_to_queue (h, th);
1442 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1444 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1445 GNUNET_TIME_UNIT_FOREVER_REL,
1446 GNUNET_YES, &send_callback, h);
1450 /******************************************************************************/
1451 /********************** API CALL DEFINITIONS *************************/
1452 /******************************************************************************/
1454 struct GNUNET_CADET_Handle *
1455 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1456 GNUNET_CADET_InboundChannelNotificationHandler new_channel,
1457 GNUNET_CADET_ChannelEndHandler cleaner,
1458 const struct GNUNET_CADET_MessageHandler *handlers,
1459 const uint32_t *ports)
1461 struct GNUNET_CADET_Handle *h;
1463 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect()\n");
1464 h = GNUNET_new (struct GNUNET_CADET_Handle);
1465 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1467 h->new_channel = new_channel;
1468 h->cleaner = cleaner;
1469 h->client = GNUNET_CLIENT_connect ("cadet", cfg);
1470 if (h->client == NULL)
1477 h->message_handlers = handlers;
1479 h->next_chid = GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
1480 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1481 h->reconnect_task = NULL;
1483 if (NULL != ports && ports[0] != 0 && NULL == new_channel)
1486 LOG (GNUNET_ERROR_TYPE_DEBUG,
1487 "no new channel handler given, ports parameter is useless!!\n");
1489 if ((NULL == ports || ports[0] == 0) && NULL != new_channel)
1492 LOG (GNUNET_ERROR_TYPE_DEBUG,
1493 "no ports given, new channel handler will never be called!!\n");
1495 /* count handlers */
1496 for (h->n_handlers = 0;
1497 handlers && handlers[h->n_handlers].type;
1499 for (h->n_ports = 0;
1500 ports && ports[h->n_ports];
1503 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect() END\n");
1509 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1511 struct GNUNET_CADET_Channel *ch;
1512 struct GNUNET_CADET_Channel *aux;
1513 struct GNUNET_CADET_TransmitHandle *th;
1515 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET DISCONNECT\n");
1517 ch = handle->channels_head;
1521 if (ch->chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1524 LOG (GNUNET_ERROR_TYPE_DEBUG, "channel %X not destroyed\n", ch->chid);
1526 destroy_channel (ch, GNUNET_YES);
1529 while ( (th = handle->th_head) != NULL)
1531 struct GNUNET_MessageHeader *msg;
1533 /* Make sure it is an allowed packet (everything else should have been
1534 * already canceled).
1536 GNUNET_break (GNUNET_NO == th_is_payload (th));
1537 msg = (struct GNUNET_MessageHeader *) &th[1];
1538 switch (ntohs(msg->type))
1540 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT:
1541 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1542 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1543 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1544 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1545 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1546 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1547 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1548 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1552 LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected unsent msg %s\n",
1553 GC_m2s (ntohs(msg->type)));
1556 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1560 if (NULL != handle->th)
1562 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1565 if (NULL != handle->client)
1567 GNUNET_CLIENT_disconnect (handle->client);
1568 handle->client = NULL;
1570 if (NULL != handle->reconnect_task)
1572 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1573 handle->reconnect_task = NULL;
1575 GNUNET_free (handle);
1580 * Create a new channel towards a remote peer.
1582 * If the destination port is not open by any peer or the destination peer
1583 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1586 * @param h cadet handle
1587 * @param channel_ctx client's channel context to associate with the channel
1588 * @param peer peer identity the channel should go to
1589 * @param port Port number.
1590 * @param options CadetOption flag field, with all desired option bits set to 1.
1592 * @return handle to the channel
1594 struct GNUNET_CADET_Channel *
1595 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1597 const struct GNUNET_PeerIdentity *peer,
1599 enum GNUNET_CADET_ChannelOption options)
1601 struct GNUNET_CADET_Channel *ch;
1602 struct GNUNET_CADET_ChannelMessage msg;
1604 LOG (GNUNET_ERROR_TYPE_DEBUG,
1605 "Creating new channel to %s:%u\n",
1606 GNUNET_i2s (peer), port);
1607 ch = create_channel (h, 0);
1608 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", ch);
1609 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", ch->chid);
1610 ch->ctx = channel_ctx;
1611 ch->peer = GNUNET_PEER_intern (peer);
1612 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE);
1613 msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
1614 msg.channel_id = htonl (ch->chid);
1615 msg.port = htonl (port);
1617 msg.opt = htonl (options);
1618 ch->allow_send = GNUNET_NO;
1619 send_packet (h, &msg.header, ch);
1625 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1627 struct GNUNET_CADET_Handle *h;
1628 struct GNUNET_CADET_ChannelMessage msg;
1629 struct GNUNET_CADET_TransmitHandle *th;
1631 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying channel\n");
1634 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
1635 msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
1636 msg.channel_id = htonl (channel->chid);
1637 memset (&msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
1643 struct GNUNET_CADET_TransmitHandle *aux;
1644 if (th->channel == channel)
1647 if (GNUNET_YES == th_is_payload (th))
1649 /* applications should cancel before destroying channel */
1651 th->notify (th->notify_cls, 0, NULL);
1653 GNUNET_CADET_notify_transmit_ready_cancel (th);
1660 destroy_channel (channel, GNUNET_YES);
1661 send_packet (h, &msg.header, NULL);
1666 * Get information about a channel.
1668 * @param channel Channel handle.
1669 * @param option Query (GNUNET_CADET_OPTION_*).
1670 * @param ... dependant on option, currently not used
1672 * @return Union with an answer to the query.
1674 const union GNUNET_CADET_ChannelInfo *
1675 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1676 enum GNUNET_CADET_ChannelOption option, ...)
1678 static int bool_flag;
1679 const union GNUNET_CADET_ChannelInfo *ret;
1683 case GNUNET_CADET_OPTION_NOBUFFER:
1684 case GNUNET_CADET_OPTION_RELIABLE:
1685 case GNUNET_CADET_OPTION_OOORDER:
1686 if (0 != (option & channel->options))
1687 bool_flag = GNUNET_YES;
1689 bool_flag = GNUNET_NO;
1690 ret = (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1692 case GNUNET_CADET_OPTION_PEER:
1693 ret = (const union GNUNET_CADET_ChannelInfo *) GNUNET_PEER_resolve2 (channel->peer);
1703 struct GNUNET_CADET_TransmitHandle *
1704 GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel, int cork,
1705 struct GNUNET_TIME_Relative maxdelay,
1707 GNUNET_CONNECTION_TransmitReadyNotify notify,
1710 struct GNUNET_CADET_TransmitHandle *th;
1712 GNUNET_assert (NULL != channel);
1713 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= notify_size);
1714 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY\n");
1715 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X\n", channel->chid);
1716 LOG (GNUNET_ERROR_TYPE_DEBUG, " allow_send %d\n", channel->allow_send);
1717 if (channel->chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1718 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
1720 LOG (GNUNET_ERROR_TYPE_DEBUG, " to destination\n");
1721 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1722 GNUNET_assert (NULL != notify);
1723 GNUNET_assert (0 == channel->packet_size); // Only one data packet allowed
1724 th = GNUNET_new (struct GNUNET_CADET_TransmitHandle);
1725 th->channel = channel;
1726 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1727 th->size = notify_size + DATA_OVERHEAD;
1728 channel->packet_size = th->size;
1729 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1730 th->notify = notify;
1731 th->notify_cls = notify_cls;
1732 add_to_queue (channel->cadet, th);
1733 if (NULL != channel->cadet->th)
1735 if (GNUNET_NO == channel->allow_send)
1737 LOG (GNUNET_ERROR_TYPE_DEBUG, " call client notify tmt rdy\n");
1738 channel->cadet->th =
1739 GNUNET_CLIENT_notify_transmit_ready (channel->cadet->client, th->size,
1740 GNUNET_TIME_UNIT_FOREVER_REL,
1741 GNUNET_YES, &send_callback,
1743 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY END\n");
1749 GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th)
1751 struct GNUNET_CADET_Handle *cadet;
1753 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY CANCEL\n");
1754 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X (%p)\n",
1755 th->channel->chid, th->channel);
1756 LOG (GNUNET_ERROR_TYPE_DEBUG, " size %u bytes\n", th->size);
1757 th->channel->packet_size = 0;
1758 cadet = th->channel->cadet;
1759 if (th->timeout_task != NULL)
1760 GNUNET_SCHEDULER_cancel (th->timeout_task);
1761 GNUNET_CONTAINER_DLL_remove (cadet->th_head, cadet->th_tail, th);
1763 if ((0 == message_ready_size (cadet)) && (NULL != cadet->th))
1765 /* queue empty, no point in asking for transmission */
1766 GNUNET_CLIENT_notify_transmit_ready_cancel (cadet->th);
1769 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY CANCEL END\n");
1774 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1781 send_info_request (struct GNUNET_CADET_Handle *h, uint16_t type)
1783 struct GNUNET_MessageHeader msg;
1785 msg.size = htons (sizeof (msg));
1786 msg.type = htons (type);
1787 send_packet (h, &msg, NULL);
1792 * Request a debug dump on the service's STDERR.
1794 * WARNING: unstable API, likely to change in the future!
1796 * @param h cadet handle
1799 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1801 LOG (GNUNET_ERROR_TYPE_DEBUG, "requesting dump\n");
1802 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1807 * Request information about peers known to the running cadet service.
1808 * The callback will be called for every peer known to the service.
1809 * Only one info request (of any kind) can be active at once.
1812 * WARNING: unstable API, likely to change in the future!
1814 * @param h Handle to the cadet peer.
1815 * @param callback Function to call with the requested data.
1816 * @param callback_cls Closure for @c callback.
1818 * @return #GNUNET_OK / #GNUNET_SYSERR
1821 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1822 GNUNET_CADET_PeersCB callback,
1825 if (NULL != h->info_cb.peers_cb)
1828 return GNUNET_SYSERR;
1830 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1831 h->info_cb.peers_cb = callback;
1832 h->info_cls = callback_cls;
1838 * Cancel a peer info request. The callback will not be called (anymore).
1840 * WARNING: unstable API, likely to change in the future!
1842 * @param h Cadet handle.
1844 * @return Closure given to GNUNET_CADET_get_peers.
1847 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1852 h->info_cb.peers_cb = NULL;
1859 * Request information about a peer known to the running cadet peer.
1860 * The callback will be called for the tunnel once.
1861 * Only one info request (of any kind) can be active at once.
1863 * WARNING: unstable API, likely to change in the future!
1865 * @param h Handle to the cadet peer.
1866 * @param id Peer whose tunnel to examine.
1867 * @param callback Function to call with the requested data.
1868 * @param callback_cls Closure for @c callback.
1870 * @return #GNUNET_OK / #GNUNET_SYSERR
1873 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1874 const struct GNUNET_PeerIdentity *id,
1875 GNUNET_CADET_PeerCB callback,
1878 struct GNUNET_CADET_LocalInfo msg;
1880 if (NULL != h->info_cb.peer_cb)
1883 return GNUNET_SYSERR;
1886 memset (&msg, 0, sizeof (msg));
1887 msg.header.size = htons (sizeof (msg));
1888 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1890 send_packet (h, &msg.header, NULL);
1891 h->info_cb.peer_cb = callback;
1892 h->info_cls = callback_cls;
1898 * Request information about tunnels of the running cadet peer.
1899 * The callback will be called for every tunnel of the service.
1900 * Only one info request (of any kind) can be active at once.
1902 * WARNING: unstable API, likely to change in the future!
1904 * @param h Handle to the cadet peer.
1905 * @param callback Function to call with the requested data.
1906 * @param callback_cls Closure for @c callback.
1908 * @return #GNUNET_OK / #GNUNET_SYSERR
1911 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1912 GNUNET_CADET_TunnelsCB callback,
1915 if (NULL != h->info_cb.tunnels_cb)
1918 return GNUNET_SYSERR;
1920 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1921 h->info_cb.tunnels_cb = callback;
1922 h->info_cls = callback_cls;
1928 * Cancel a monitor request. The monitor callback will not be called.
1930 * @param h Cadet handle.
1932 * @return Closure given to GNUNET_CADET_get_tunnels.
1935 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1939 h->info_cb.tunnels_cb = NULL;
1949 * Request information about a tunnel of the running cadet peer.
1950 * The callback will be called for the tunnel once.
1951 * Only one info request (of any kind) can be active at once.
1953 * WARNING: unstable API, likely to change in the future!
1955 * @param h Handle to the cadet peer.
1956 * @param id Peer whose tunnel to examine.
1957 * @param callback Function to call with the requested data.
1958 * @param callback_cls Closure for @c callback.
1960 * @return #GNUNET_OK / #GNUNET_SYSERR
1963 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1964 const struct GNUNET_PeerIdentity *id,
1965 GNUNET_CADET_TunnelCB callback,
1968 struct GNUNET_CADET_LocalInfo msg;
1970 if (NULL != h->info_cb.tunnel_cb)
1973 return GNUNET_SYSERR;
1976 memset (&msg, 0, sizeof (msg));
1977 msg.header.size = htons (sizeof (msg));
1978 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1980 send_packet (h, &msg.header, NULL);
1981 h->info_cb.tunnel_cb = callback;
1982 h->info_cls = callback_cls;
1988 * Request information about a specific channel of the running cadet peer.
1990 * WARNING: unstable API, likely to change in the future!
1991 * FIXME Add destination option.
1993 * @param h Handle to the cadet peer.
1994 * @param initiator ID of the owner of the channel.
1995 * @param channel_number Channel number.
1996 * @param callback Function to call with the requested data.
1997 * @param callback_cls Closure for @c callback.
1999 * @return #GNUNET_OK / #GNUNET_SYSERR
2002 GNUNET_CADET_show_channel (struct GNUNET_CADET_Handle *h,
2003 struct GNUNET_PeerIdentity *initiator,
2004 unsigned int channel_number,
2005 GNUNET_CADET_ChannelCB callback,
2008 struct GNUNET_CADET_LocalInfo msg;
2010 if (NULL != h->info_cb.channel_cb)
2013 return GNUNET_SYSERR;
2016 msg.header.size = htons (sizeof (msg));
2017 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL);
2018 msg.peer = *initiator;
2019 msg.channel_id = htonl (channel_number);
2020 // msg.reserved = 0;
2021 send_packet (h, &msg.header, NULL);
2022 h->info_cb.channel_cb = callback;
2023 h->info_cls = callback_cls;
2029 * Function called to notify a client about the connection
2030 * begin ready to queue more data. "buf" will be
2031 * NULL and "size" zero if the connection was closed for
2032 * writing in the meantime.
2034 * @param cls closure
2035 * @param size number of bytes available in buf
2036 * @param buf where the callee should write the message
2037 * @return number of bytes written to buf
2040 cadet_mq_ntr (void *cls, size_t size,
2043 struct GNUNET_MQ_Handle *mq = cls;
2044 struct CadetMQState *state = GNUNET_MQ_impl_state (mq);
2045 const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
2051 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
2054 msize = ntohs (msg->size);
2055 GNUNET_assert (msize <= size);
2056 memcpy (buf, msg, msize);
2057 GNUNET_MQ_impl_send_continue (mq);
2063 * Signature of functions implementing the
2064 * sending functionality of a message queue.
2066 * @param mq the message queue
2067 * @param msg the message to send
2068 * @param impl_state state of the implementation
2071 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
2072 const struct GNUNET_MessageHeader *msg,
2075 struct CadetMQState *state = impl_state;
2077 GNUNET_assert (NULL == state->th);
2079 GNUNET_CADET_notify_transmit_ready (state->channel,
2080 /* FIXME: add option for corking */
2082 GNUNET_TIME_UNIT_FOREVER_REL,
2090 * Signature of functions implementing the
2091 * destruction of a message queue.
2092 * Implementations must not free 'mq', but should
2093 * take care of 'impl_state'.
2095 * @param mq the message queue to destroy
2096 * @param impl_state state of the implementation
2099 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
2102 struct CadetMQState *state = impl_state;
2104 if (NULL != state->th)
2105 GNUNET_CADET_notify_transmit_ready_cancel (state->th);
2107 GNUNET_free (state);
2112 * Create a message queue for a cadet channel.
2113 * The message queue can only be used to transmit messages,
2114 * not to receive them.
2116 * @param channel the channel to create the message qeue for
2117 * @return a message queue to messages over the channel
2119 struct GNUNET_MQ_Handle *
2120 GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel)
2122 struct GNUNET_MQ_Handle *mq;
2123 struct CadetMQState *state;
2125 state = GNUNET_new (struct CadetMQState);
2126 state->channel = channel;
2128 mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
2129 &cadet_mq_destroy_impl,
2130 NULL, /* FIXME: cancel impl. */
2132 NULL, /* no msg handlers */
2133 NULL, /* no err handlers */
2134 NULL); /* no handler cls */