REST/NAMESTORE: rework API
[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      SPDX-License-Identifier: AGPL3.0-or-later
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 GNUNET_NETWORK_STRUCT_BEGIN
31
32 /**
33  * Header for a message fragment.  Followed by the
34  * original message.
35  */
36 struct FragmentHeader
37 {
38
39   /**
40    * Message header.
41    */
42   struct GNUNET_MessageHeader header;
43
44   /**
45    * Unique fragment ID.
46    */
47   uint32_t fragment_id GNUNET_PACKED;
48
49   /**
50    * Total message size of the original message.
51    */
52   uint16_t total_size GNUNET_PACKED;
53
54   /**
55    * Absolute offset (in bytes) of this fragment in the original
56    * message.  Will be a multiple of the MTU.
57    */
58   uint16_t offset GNUNET_PACKED;
59
60 };
61
62
63 /**
64  * Message fragment acknowledgement.
65  */
66 struct FragmentAcknowledgement
67 {
68
69   /**
70    * Message header.
71    */
72   struct GNUNET_MessageHeader header;
73
74   /**
75    * Unique fragment ID.
76    */
77   uint32_t fragment_id GNUNET_PACKED;
78
79   /**
80    * Bits that are being acknowledged, in big-endian.
81    * (bits that are set correspond to fragments that
82    * have not yet been received).
83    */
84   uint64_t bits GNUNET_PACKED;
85
86 };
87 GNUNET_NETWORK_STRUCT_END
88
89 #endif