start of rationale for packets
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 06 Sep 2006 17:06:45 +0200
changeset 80 3706b1172ab9
parent 79 84f791c00aa5
child 81 80856bb1e1e8
start of rationale for packets
src/common/packet.h
--- a/src/common/packet.h	Wed Sep 06 16:46:26 2006 +0200
+++ b/src/common/packet.h	Wed Sep 06 17:06:45 2006 +0200
@@ -31,6 +31,13 @@
 
 /**
  * \brief network packets
+ *
+ * Each network packet contains a byte buffer and a list of tags.
+ * The byte buffer stores the serialized content of the chunks added 
+ * to a packet. The serialized representation of these chunks is expected
+ * to match that of real network packets bit for bit (although nothing
+ * forces you to do this) which means that the content of a packet buffer
+ * is expected to be that of a real packet.
  */
 class Packet {
 public: