2 This file is part of GNUnet.
3 (C) 2012 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_protocol.h
23 * @brief P2P protocol for the stream connections
24 * @author Sree Harsha Totakura
27 #ifndef STREAM_PROTOCOL_H
28 #define STREAM_PROTOCOL_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
42 * The stream message header
44 * The message can be of Data, Acknowledgement or both
46 struct GNUNET_STREAM_MessageHeader
49 * The GNUNET message header, types are from GNUNET_MESSAGE_TYPE_STREAM_*-range.
51 struct GNUNET_MessageHeader header;
54 * A number which identifies a session between the two peers.
62 * The Data message, should be prefixed with stream header with its type set to
65 struct GNUNET_STREAM_DataMessage
69 * Type is GNUNET_MESSAGE_TYPE_STREAM_DATA
71 struct GNUNET_STREAM_MessageHeader header;
74 * number of milliseconds to the soft deadline for sending acknowledgement
75 * measured from the time this message is received. It is optimal for the
76 * communication to send the ack within the soft deadline
78 struct GNUNET_TIME_RelativeNBO ack_deadline;
81 * Sequence number; starts with a random value. (Just in case
82 * someone breaks mesh and is able to try to do a Sequence
83 * Prediction Attack on us.)
85 uint32_t sequence_number;
88 * Offset of the packet in the overall stream, modulo 2^32; allows
89 * the receiver to calculate where in the destination buffer the
90 * message should be placed.
95 * The data should be appended here
100 * The Selective Acknowledgement Bitmap
102 typedef uint64_t GNUNET_STREAM_AckBitmap;
106 * The Acknowledgment Message to confirm receipt of DATA.
108 struct GNUNET_STREAM_AckMessage
112 * Type is GNUNET_MESSAGE_TYPE_STREAM_ACK
114 struct GNUNET_STREAM_MessageHeader header;
117 * The Selective Acknowledgement Bitmap. Computed relative to the base_seq
118 * (bit n corresponds to the Data message with sequence number base_seq+n)
120 GNUNET_STREAM_AckBitmap bitmap;
123 * The sequence number of the Data Message upto which the receiver has filled
124 * its buffer without any missing packets
126 uint32_t base_sequence_number;
129 * Available buffer space past the last acknowledged buffer (for flow control),
132 uint32_t receive_window_remaining;
136 #if 0 /** keep Emacsens' auto-indent happy */
143 #endif /* STREAM_PROTOCOL_H */