some doxygen
authorTom Henderson <tomh@tomh.org>
Sat, 27 Mar 2010 14:06:59 -0700
changeset 6161 c52406de004d
parent 6160 1a89001b3124
child 6162 c36d596775f3
some doxygen
src/internet-stack/pending-data.h
--- a/src/internet-stack/pending-data.h	Sat Mar 27 14:01:41 2010 -0700
+++ b/src/internet-stack/pending-data.h	Sat Mar 27 14:06:59 2010 -0700
@@ -53,12 +53,42 @@
   virtual void Clear ();// Remove all associated data
   virtual void Add (uint32_t s, const uint8_t* d = 0);// Add some data to end
   virtual void Add (Ptr<Packet> p);
-  // Inquire available data from (f,o) sequence pair
-  virtual uint32_t SizeFromSeq (const SequenceNumber&, const SequenceNumber&);
+  /**
+   * This method returns the number of bytes in the PendingData buffer
+   * beyond the sequence number specified by seqOffset.
+   *
+   * The variables seqFront and seqOffset correspond to a sequence number
+   * space in use by the user.  What is significant in this method is the
+   * difference between them; i.e. the quantity (seqOffset - seqFront). 
+   * This difference is subtracted from Size(), yielding the number of
+   * bytes beyond seqOffset, from the user perspective, in the PendingData
+   * buffer.
+   *
+   * If the first number specified is not a sequence number that corresponds
+   * to the first data byte in the PendingData buffer, the computation
+   * returned will be in error.
+   * 
+   * \return number of bytes 
+   * \param seqFront sequence number of assumed first byte in the PendingData
+   * \param seqOffset sequence number of offset 
+   */
+  virtual uint32_t SizeFromSeq (const SequenceNumber& seqFront, const SequenceNumber& seqOffset);
   // Inquire available data from offset
-  virtual uint32_t SizeFromOffset (uint32_t);
+  /**
+   * \return number of bytes in the data buffer beyond the offset specified
+   * \param offset offset (from zero) 
+   */
+  virtual uint32_t SizeFromOffset (uint32_t offset);
   // Available size from sequence difference 
-  virtual uint32_t OffsetFromSeq (const SequenceNumber&, const SequenceNumber&);
+  /**
+   * Subtracts seqFront from seqOffset after enforcing seqFront is less
+   * than seqOffset
+   *
+   * \param seqFront sequence number to be subtracted from seqOffset
+   * \param seqOffset higher sequence number
+   * \return seqOffset-seqFront
+   */
+  virtual uint32_t OffsetFromSeq (const SequenceNumber& seqFront, const SequenceNumber& seqOffset);
   virtual Ptr<Packet> CopyFromOffset (uint32_t, uint32_t);  // Size, offset, ret packet
   // Copy data, size, offset specified by sequence difference
   virtual Ptr<Packet> CopyFromSeq (uint32_t, const SequenceNumber&, const SequenceNumber&);