2 This file is part of GNUnet
3 (C) 2009, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file include/gnunet_fragmentation_lib.h
22 * @brief library to help fragment messages
23 * @author Christian Grothoff
25 * TODO: consider additional flow-control for sending from
26 * fragmentation based on continuations.
29 #ifndef GNUNET_FRAGMENTATION_LIB_H
30 #define GNUNET_FRAGMENTATION_LIB_H
32 #include "gnunet_util_lib.h"
33 #include "gnunet_bandwidth_lib.h"
34 #include "gnunet_statistics_service.h"
39 #if 0 /* keep Emacsens' auto-indent happy */
46 * Fragmentation context.
48 struct GNUNET_FRAGMENT_Context;
52 * Function that is called with messages created by the fragmentation
53 * module. In the case of the 'proc' callback of the
54 * GNUNET_FRAGMENT_context_create function, this function must
55 * eventually call 'GNUNET_FRAGMENT_context_transmission_done'.
58 * @param msg the message that was created
60 typedef void (*GNUNET_FRAGMENT_MessageProcessor) (void *cls,
62 GNUNET_MessageHeader * msg);
66 * Create a fragmentation context for the given message.
67 * Fragments the message into fragments of size "mtu" or
68 * less. Calls 'proc' on each un-acknowledged fragment,
69 * using both the expected 'delay' between messages and
70 * acknowledgements and the given 'tracker' to guide the
71 * frequency of calls to 'proc'.
73 * @param stats statistics context
74 * @param mtu the maximum message size for each fragment
75 * @param tracker bandwidth tracker to use for flow control (can be NULL)
76 * @param msg_delay initial delay to insert between fragment transmissions
77 * based on previous messages
78 * @param ack_delay expected delay between fragment transmission
79 * and ACK based on previous messages
80 * @param msg the message to fragment
81 * @param proc function to call for each fragment to transmit
82 * @param proc_cls closure for proc
83 * @return the fragmentation context
85 struct GNUNET_FRAGMENT_Context *
86 GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
88 struct GNUNET_BANDWIDTH_Tracker *tracker,
89 struct GNUNET_TIME_Relative msg_delay,
90 struct GNUNET_TIME_Relative ack_delay,
91 const struct GNUNET_MessageHeader *msg,
92 GNUNET_FRAGMENT_MessageProcessor proc,
97 * Continuation to call from the 'proc' function after the fragment
98 * has been transmitted (and hence the next fragment can now be
101 * @param fc fragmentation context
104 GNUNET_FRAGMENT_context_transmission_done (struct GNUNET_FRAGMENT_Context *fc);
108 * Process an acknowledgement message we got from the other
109 * side (to control re-transmits).
111 * @param fc fragmentation context
112 * @param msg acknowledgement message we received
113 * @return GNUNET_OK if this ack completes the work of the 'fc'
114 * (all fragments have been received);
115 * GNUNET_NO if more messages are pending
116 * GNUNET_SYSERR if this ack is not valid for this fc
119 GNUNET_FRAGMENT_process_ack (struct GNUNET_FRAGMENT_Context *fc,
120 const struct GNUNET_MessageHeader *msg);
124 * Destroy the given fragmentation context (stop calling 'proc', free
127 * @param fc fragmentation context
128 * @param msg_delay where to store average delay between individual message transmissions the
129 * last message (OUT only)
130 * @param ack_delay where to store average delay between transmission and ACK for the
131 * last message, set to FOREVER if the message was not fully transmitted (OUT only)
134 GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *fc,
135 struct GNUNET_TIME_Relative *msg_delay,
136 struct GNUNET_TIME_Relative *ack_delay);
140 * Defragmentation context (one per connection).
142 struct GNUNET_DEFRAGMENT_Context;
146 * Function that is called with acknowledgement messages created by
147 * the fragmentation module. Acknowledgements are cummulative,
148 * so it is OK to only transmit the 'latest' ack message for the same
152 * @param id unique message ID (modulo collisions)
153 * @param msg the message that was created
155 typedef void (*GNUNET_DEFRAGMENT_AckProcessor) (void *cls, uint32_t id,
157 GNUNET_MessageHeader * msg);
161 * Create a defragmentation context.
163 * @param stats statistics context
164 * @param mtu the maximum message size for each fragment
165 * @param num_msgs how many fragmented messages
166 * to we defragment at most at the same time?
167 * @param cls closure for proc and ackp
168 * @param proc function to call with defragmented messages
169 * @param ackp function to call with acknowledgements (to send
170 * back to the other side)
171 * @return the defragmentation context
173 struct GNUNET_DEFRAGMENT_Context *
174 GNUNET_DEFRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
175 uint16_t mtu, unsigned int num_msgs,
177 GNUNET_FRAGMENT_MessageProcessor proc,
178 GNUNET_DEFRAGMENT_AckProcessor ackp);
182 * Destroy the given defragmentation context.
184 * @param dc defragmentation context
187 GNUNET_DEFRAGMENT_context_destroy (struct GNUNET_DEFRAGMENT_Context *dc);
191 * We have received a fragment. Process it.
193 * @param dc the context
194 * @param msg the message that was received
195 * @return GNUNET_OK on success, GNUNET_NO if this was a duplicate, GNUNET_SYSERR on error
198 GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc,
199 const struct GNUNET_MessageHeader *msg);
202 #if 0 /* keep Emacsens' auto-indent happy */
209 /* end of gnunet_fragmentation_lib.h */