2 This file is part of GNUnet.
3 (C) 2008--2013 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.
22 * @file stream/stream.h
23 * @brief P2P protocol for the stream connections
24 * @author Sree Harsha Totakura
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
40 GNUNET_NETWORK_STRUCT_BEGIN
44 * The HELLO message to begin the handshake
46 struct GNUNET_STREAM_HelloMessage
49 * Type is GNUNET_MESSAGE_TYPE_STREAM_HELLO
51 struct GNUNET_MessageHeader header;
54 * The application port number
56 uint64_t port GNUNET_PACKED;;
60 * The Data message, should be prefixed with stream header with its type set to
63 struct GNUNET_STREAM_DataMessage
67 * Type is GNUNET_MESSAGE_TYPE_STREAM_DATA
69 struct GNUNET_MessageHeader header;
72 * Sequence number; starts with a random value. (Just in case
73 * someone breaks mesh and is able to try to do a Sequence
74 * Prediction Attack on us.)
76 uint32_t sequence_number GNUNET_PACKED;
79 * number of milliseconds to the soft deadline for sending acknowledgement
80 * measured from the time this message is received. It is optimal for the
81 * communication to send the ack within the soft deadline
83 struct GNUNET_TIME_RelativeNBO ack_deadline;
86 * Offset of the packet in the overall stream, modulo 2^32; allows
87 * the receiver to calculate where in the destination buffer the
88 * message should be placed. In network byte order.
90 uint32_t offset GNUNET_PACKED;
93 * The data should be appended here
99 * Number of bits in GNUNET_STREAM_AckBitmap
101 #define GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH 64
104 * The Selective Acknowledgement Bitmap
106 typedef uint64_t GNUNET_STREAM_AckBitmap;
110 * The Acknowledgment Message to confirm receipt of DATA.
112 struct GNUNET_STREAM_AckMessage
116 * Type is GNUNET_MESSAGE_TYPE_STREAM_ACK
118 struct GNUNET_MessageHeader header;
121 * The sequence number of the next Data Message receiver is
122 * anticipating. Data messages less than this number are received by receiver
124 uint32_t base_sequence_number GNUNET_PACKED;
127 * The Selective Acknowledgement Bitmap. Computed relative to the base_seq
128 * (bit n corresponds to the Data message with sequence number base_seq+n)
130 GNUNET_STREAM_AckBitmap bitmap GNUNET_PACKED;
133 * Available buffer space past the last acknowledged buffer (for flow control),
136 uint32_t receive_window_remaining GNUNET_PACKED;
141 * Message for Acknowledging HELLO
143 struct GNUNET_STREAM_HelloAckMessage
146 * The stream message header
148 struct GNUNET_MessageHeader header;
151 * The selected sequence number. Following data tranmissions from the sender
152 * start with this sequence
154 uint32_t sequence_number GNUNET_PACKED;
157 * The size(in bytes) of the receive window on the peer sending this message
159 * FIXME: Remove if not needed
161 uint32_t receiver_window_size GNUNET_PACKED;
164 GNUNET_NETWORK_STRUCT_END
167 #if 0 /** keep Emacsens' auto-indent happy */
174 #endif /* STREAM.H */
176 /* End of stream.h */