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 delay expected delay between fragment transmission
77 * and ACK based on previous messages
78 * @param msg the message to fragment
79 * @param proc function to call for each fragment to transmit
80 * @param proc_cls closure for proc
81 * @return the fragmentation context
83 struct GNUNET_FRAGMENT_Context *
84 GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
86 struct GNUNET_BANDWIDTH_Tracker *tracker,
87 struct GNUNET_TIME_Relative delay,
88 const struct GNUNET_MessageHeader *msg,
89 GNUNET_FRAGMENT_MessageProcessor proc,
94 * Continuation to call from the 'proc' function after the fragment
95 * has been transmitted (and hence the next fragment can now be
98 * @param fc fragmentation context
101 GNUNET_FRAGMENT_context_transmission_done (struct GNUNET_FRAGMENT_Context *fc);
105 * Process an acknowledgement message we got from the other
106 * side (to control re-transmits).
108 * @param fc fragmentation context
109 * @param msg acknowledgement message we received
110 * @return GNUNET_OK if this ack completes the work of the 'fc'
111 * (all fragments have been received);
112 * GNUNET_NO if more messages are pending
113 * GNUNET_SYSERR if this ack is not valid for this fc
116 GNUNET_FRAGMENT_process_ack (struct GNUNET_FRAGMENT_Context *fc,
117 const struct GNUNET_MessageHeader *msg);
121 * Destroy the given fragmentation context (stop calling 'proc', free
124 * @param fc fragmentation context
125 * @return average delay between transmission and ACK for the
126 * last message, FOREVER if the message was not fully transmitted
128 struct GNUNET_TIME_Relative
129 GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *fc);
133 * Defragmentation context (one per connection).
135 struct GNUNET_DEFRAGMENT_Context;
139 * Function that is called with acknowledgement messages created by
140 * the fragmentation module. Acknowledgements are cummulative,
141 * so it is OK to only transmit the 'latest' ack message for the same
145 * @param id unique message ID (modulo collisions)
146 * @param msg the message that was created
148 typedef void (*GNUNET_DEFRAGMENT_AckProcessor) (void *cls, uint32_t id,
150 GNUNET_MessageHeader * msg);
154 * Create a defragmentation context.
156 * @param stats statistics context
157 * @param mtu the maximum message size for each fragment
158 * @param num_msgs how many fragmented messages
159 * to we defragment at most at the same time?
160 * @param cls closure for proc and ackp
161 * @param proc function to call with defragmented messages
162 * @param ackp function to call with acknowledgements (to send
163 * back to the other side)
164 * @return the defragmentation context
166 struct GNUNET_DEFRAGMENT_Context *
167 GNUNET_DEFRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
168 uint16_t mtu, unsigned int num_msgs,
170 GNUNET_FRAGMENT_MessageProcessor proc,
171 GNUNET_DEFRAGMENT_AckProcessor ackp);
175 * Destroy the given defragmentation context.
177 * @param dc defragmentation context
180 GNUNET_DEFRAGMENT_context_destroy (struct GNUNET_DEFRAGMENT_Context *dc);
184 * We have received a fragment. Process it.
186 * @param dc the context
187 * @param msg the message that was received
188 * @return GNUNET_OK on success, GNUNET_NO if this was a duplicate, GNUNET_SYSERR on error
191 GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc,
192 const struct GNUNET_MessageHeader *msg);
195 #if 0 /* keep Emacsens' auto-indent happy */
202 /* end of gnunet_fragmentation_lib.h */