Changeset 032bbe7 in mainline for uspace/srv/net/tl/tcp/segment.c

Timestamp:

2011-09-22T19:53:07Z (13 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

32105348

Parents:

0093ab6

Message:

Document functions and files.

File:

• uspace/srv/net/tl/tcp/segment.c (modified) (8 diffs)

uspace/srv/net/tl/tcp/segment.c

@@ -32 +32 @@
 
 /**
- * @file
+ * @file Segment processing
  */
 
@@ -41 +41 @@
 #include "tcp_type.h"
 
+/** Alocate new segment structure. */
 tcp_segment_t *tcp_segment_new(void)
 {
@@ -46 +47 @@
 }
 
+/** Delete segment. */
 void tcp_segment_delete(tcp_segment_t *seg)
 {
@@ -51 +53 @@
 }
 
-/** Create a control segment. */
+/** Create a control segment.
+ *
+  * @return     Control segment
+ */
 tcp_segment_t *tcp_segment_make_ctrl(tcp_control_t ctrl)
 {
@@ -66 +71 @@
 }
 
+/** Create an RST segment.
+ *
+ * @param seg   Segment we are replying to
+ * @return      RST segment
+ */
 tcp_segment_t *tcp_segment_make_rst(tcp_segment_t *seg)
 {
@@ -80 +90 @@
 }
 
-/** Trim segment to the specified interval.
+/** Trim segment from left and right by the specified amount.
  *
- * Trim any text or control whose sequence number is outside of [lo, hi)
- * interval.
+ * Trim any text or control to remove the specified amount of sequence
+ * numbers from the left (lower sequence numbers) and right side
+ * (higher sequence numbers) of the segment.
+ *
+ * @param seg           Segment, will be modified in place
+ * @param left          Amount of sequence numbers to trim from the left
+ * @param right         Amount of sequence numbers to trim from the right
  */
 void tcp_segment_trim(tcp_segment_t *seg, uint32_t left, uint32_t right)
@@ -134 +149 @@
 /** Copy out text data from segment.
  *
+ * Data is copied from the beginning of the segment text up to @a size bytes.
+ * @a size must not be greater than the size of the segment text, but
+ * it can be less.
+ *
+ * @param seg   Segment
+ * @param buf   Destination buffer
+ * @param size  Size of destination buffer
  */
 void tcp_segment_text_copy(tcp_segment_t *seg, void *buf, size_t size)
@@ -141 +163 @@
 }
 
-/** Return number of bytes in segment text. */
+/** Return number of bytes in segment text.
+ *
+ * @param seg   Segment
+ * @return      Number of bytes in segment text
+ */
 size_t tcp_segment_text_size(tcp_segment_t *seg)
 {