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
53 * created by the fragmentation module.
56 * @param msg the message that was created
58 typedef void (*GNUNET_FRAGMENT_MessageProcessor) (void *cls,
59 const struct GNUNET_MessageHeader *msg);
63 * Create a fragmentation context for the given message.
64 * Fragments the message into fragments of size "mtu" or
65 * less. Calls 'proc' on each un-acknowledged fragment,
66 * using both the expected 'delay' between messages and
67 * acknowledgements and the given 'tracker' to guide the
68 * frequency of calls to 'proc'.
70 * @param stats statistics context
71 * @param mtu the maximum message size for each fragment
72 * @param tracker bandwidth tracker to use for flow control (can be NULL)
73 * @param delay expected delay between fragment transmission
74 * and ACK based on previous messages
75 * @param msg the message to fragment
76 * @param proc function to call for each fragment to transmit
77 * @param proc_cls closure for proc
78 * @return the fragmentation context
80 struct GNUNET_FRAGMENT_Context *
81 GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
83 struct GNUNET_BANDWIDTH_Tracker *tracker,
84 struct GNUNET_TIME_Relative delay,
85 const struct GNUNET_MessageHeader *msg,
86 GNUNET_FRAGMENT_MessageProcessor proc,
91 * Process an acknowledgement message we got from the other
92 * side (to control re-transmits).
94 * @param fc fragmentation context
95 * @param msg acknowledgement message we received
96 * @return GNUNET_OK if this ack completes the work of the 'fc'
97 * (all fragments have been received);
98 * GNUNET_NO if more messages are pending
99 * GNUNET_SYSERR if this ack is not valid for this fc
101 int GNUNET_FRAGMENT_process_ack (struct GNUNET_FRAGMENT_Context *fc,
102 const struct GNUNET_MessageHeader *msg);
106 * Destroy the given fragmentation context (stop calling 'proc', free
109 * @param fc fragmentation context
110 * @return average delay between transmission and ACK for the
111 * last message, FOREVER if the message was not fully transmitted
113 struct GNUNET_TIME_Relative
114 GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *fc);
118 * Defragmentation context (one per connection).
120 struct GNUNET_DEFRAGMENT_Context;
124 * Create a defragmentation context.
126 * @param stats statistics context
127 * @param mtu the maximum message size for each fragment
128 * @param num_msgs how many fragmented messages
129 * to we defragment at most at the same time?
130 * @param cls closure for proc and ackp
131 * @param proc function to call with defragmented messages
132 * @param ackp function to call with acknowledgements (to send
133 * back to the other side)
134 * @return the defragmentation context
136 struct GNUNET_DEFRAGMENT_Context *
137 GNUNET_DEFRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
139 unsigned int num_msgs,
141 GNUNET_FRAGMENT_MessageProcessor proc,
142 GNUNET_FRAGMENT_MessageProcessor ackp);
146 * Destroy the given defragmentation context.
148 * @param dc defragmentation context
151 GNUNET_DEFRAGMENT_context_destroy (struct GNUNET_DEFRAGMENT_Context *dc);
155 * We have received a fragment. Process it.
157 * @param dc the context
158 * @param msg the message that was received
159 * @return GNUNET_OK on success, GNUNET_NO if this was a duplicate, GNUNET_SYSERR on error
162 GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc,
163 const struct GNUNET_MessageHeader *msg);
166 #if 0 /* keep Emacsens' auto-indent happy */
173 /* end of gnunet_fragmentation_lib.h */