paragraph for gnunet devs that don't know how to use the web
[oweals/gnunet.git] / src / fragmentation / fragmentation.h
1 /*
2      This file is part of GNUnet
3      Copyright (C) 2009, 2011 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your option) any later version.
9
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      Affero General Public License for more details.
14     
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18 /**
19  * @file src/fragmentation/fragmentation.h
20  * @brief library to help fragment messages
21  * @author Christian Grothoff
22  */
23 #ifndef FRAGMENTATION_H
24 #define FRAGMENTATION_H
25 #include "platform.h"
26 #include "gnunet_fragmentation_lib.h"
27
28 GNUNET_NETWORK_STRUCT_BEGIN
29
30 /**
31  * Header for a message fragment.  Followed by the
32  * original message.
33  */
34 struct FragmentHeader
35 {
36
37   /**
38    * Message header.
39    */
40   struct GNUNET_MessageHeader header;
41
42   /**
43    * Unique fragment ID.
44    */
45   uint32_t fragment_id GNUNET_PACKED;
46
47   /**
48    * Total message size of the original message.
49    */
50   uint16_t total_size GNUNET_PACKED;
51
52   /**
53    * Absolute offset (in bytes) of this fragment in the original
54    * message.  Will be a multiple of the MTU.
55    */
56   uint16_t offset GNUNET_PACKED;
57
58 };
59
60
61 /**
62  * Message fragment acknowledgement.
63  */
64 struct FragmentAcknowledgement
65 {
66
67   /**
68    * Message header.
69    */
70   struct GNUNET_MessageHeader header;
71
72   /**
73    * Unique fragment ID.
74    */
75   uint32_t fragment_id GNUNET_PACKED;
76
77   /**
78    * Bits that are being acknowledged, in big-endian.
79    * (bits that are set correspond to fragments that
80    * have not yet been received).
81    */
82   uint64_t bits GNUNET_PACKED;
83
84 };
85 GNUNET_NETWORK_STRUCT_END
86
87 #endif