added test_stream_big to make check tests
[oweals/gnunet.git] / src / stream / stream_protocol.h
index b7fff7e5f862fa19114e2f15a5f50768ca2f6a43..d1c43b778ea93a41986f8f6d0a78bdcaf8cc2296 100644 (file)
@@ -37,11 +37,12 @@ extern "C"
 
 #include "gnunet_util_lib.h"
 
+GNUNET_NETWORK_STRUCT_BEGIN
+
 
 /**
  * The stream message header
- *
- * The message can be of Data, Acknowledgement or both
+ * All messages of STREAM should commonly have this as header
  */
 struct GNUNET_STREAM_MessageHeader
 {
@@ -51,9 +52,9 @@ struct GNUNET_STREAM_MessageHeader
   struct GNUNET_MessageHeader header;
 
   /**
-   * A number which identifies a session between the two peers.
+   * A number which identifies a session between the two peers. FIXME: not needed
    */
-  uint32_t session_id;
+  uint32_t session_id GNUNET_PACKED;
 
 };
 
@@ -70,6 +71,13 @@ struct GNUNET_STREAM_DataMessage
    */
   struct GNUNET_STREAM_MessageHeader header;
 
+  /**
+   * Sequence number; starts with a random value.  (Just in case
+   * someone breaks mesh and is able to try to do a Sequence
+   * Prediction Attack on us.)
+   */
+  uint32_t sequence_number GNUNET_PACKED;
+
   /**
    * number of milliseconds to the soft deadline for sending acknowledgement
    * measured from the time this message is received. It is optimal for the
@@ -77,25 +85,24 @@ struct GNUNET_STREAM_DataMessage
    */
   struct GNUNET_TIME_RelativeNBO ack_deadline;
 
-  /**
-   * Sequence number; starts with a random value.  (Just in case
-   * someone breaks mesh and is able to try to do a Sequence
-   * Prediction Attack on us.)
-   */
-  uint32_t sequence_number;
-
   /**
    * Offset of the packet in the overall stream, modulo 2^32; allows
    * the receiver to calculate where in the destination buffer the
-   * message should be placed.
+   * message should be placed.  In network byte order.
    */
-  uint32_t offset;
+  uint32_t offset GNUNET_PACKED;
 
   /**
    * The data should be appended here
    */
 };
 
+
+/**
+ * Number of bits in GNUNET_STREAM_AckBitmap
+ */
+#define GNUNET_STREAM_ACK_BITMAP_BIT_LENGTH 64
+
 /**
  * The Selective Acknowledgement Bitmap
  */
@@ -117,22 +124,67 @@ struct GNUNET_STREAM_AckMessage
    * The Selective Acknowledgement Bitmap. Computed relative to the base_seq
    * (bit n corresponds to the Data message with sequence number base_seq+n)
    */
-  GNUNET_STREAM_AckBitmap bitmap;
+  GNUNET_STREAM_AckBitmap bitmap GNUNET_PACKED;
 
   /**
-   * The sequence number of the Data Message upto which the receiver has filled
-   * its buffer without any missing packets
+   * The sequence number of the next Data Message receiver is
+   * anticipating. Data messages less than this number are received by receiver
    */
-  uint32_t base_sequence_number;
+  uint32_t base_sequence_number GNUNET_PACKED;
 
   /**
    * Available buffer space past the last acknowledged buffer (for flow control),
    * in bytes.
    */
-  uint32_t receive_window_remaining;
+  uint32_t receive_window_remaining GNUNET_PACKED;
 };
 
 
+/**
+ * Message for Acknowledging HELLO
+ */
+struct GNUNET_STREAM_HelloAckMessage
+{
+  /**
+   * The stream message header
+   */
+  struct GNUNET_STREAM_MessageHeader header;
+
+  /**
+   * The selected sequence number. Following data tranmissions from the sender
+   * start with this sequence
+   */
+  uint32_t sequence_number GNUNET_PACKED;
+
+  /**
+   * The size(in bytes) of the receive window on the peer sending this message
+   *
+   * FIXME: Remove if not needed
+   */
+  uint32_t receiver_window_size GNUNET_PACKED;
+};
+
+
+/**
+ * The Transmit close message(used to signal transmission is closed)
+ */
+struct GNUNET_STREAM_TransmitCloseMessage
+{
+  /**
+   * The stream message header
+   */
+  struct GNUNET_STREAM_MessageHeader header;
+
+  /**
+   * The last sequence number of the packet after which the transmission has
+   * ended 
+   */
+  uint32_t final_sequence_number GNUNET_PACKED;
+};
+
+GNUNET_NETWORK_STRUCT_END
+
+
 #if 0                           /** keep Emacsens' auto-indent happy */
 {
 #endif