naming
[oweals/gnunet.git] / src / fragmentation / fragmentation.h
1 /*
2      This file is part of GNUnet
3      (C) 2009, 2011 Christian Grothoff (and other contributing authors)
4
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.
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      General Public License for more details.
14
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.
19 */
20 /**
21  * @file src/fragmentation/fragmentation.h
22  * @brief library to help fragment messages
23  * @author Christian Grothoff
24  */
25 #ifndef FRAGMENTATION_H
26 #define FRAGMENTATION_H
27 #include "platform.h"
28 #include "gnunet_fragmentation_lib.h"
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;
46
47   /**
48    * Total message size of the original message.
49    */
50   uint16_t total_size;
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;
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;
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;
83
84 };
85
86
87 #endif