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

Timestamp:

2011-09-22T19:53:07Z (14 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/iqueue.c (modified) (4 diffs)

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

@@ -32 +32 @@
 
 /**
- * @file
+ * @file Connection incoming segments queue
+ *
+ * Segments are sorted in order of their sequence number.
  */
 
@@ -44 +46 @@
 #include "tcp_type.h"
 
+/** Initialize incoming segments queue.
+ *
+ * @param iqueue        Incoming queue
+ * @param conn          Connection the queue is associated with
+ */
 void tcp_iqueue_init(tcp_iqueue_t *iqueue, tcp_conn_t *conn)
 {
@@ -50 +57 @@
 }
 
+/** Insert segment into incoming queue.
+ *
+ * @param iqueue        Incoming queue
+ * @param seg           Segment
+ */
 void tcp_iqueue_insert_seg(tcp_iqueue_t *iqueue, tcp_segment_t *seg)
 {
@@ -67 +79 @@
 }
 
+/** Get next ready segment from incoming queue.
+ *
+ * Return the segment with the earliest sequence number if it is ready.
+ * A segment is ready if its SEG.SEQ is earlier or equal to RCV.NXT.
+ *
+ * @param iqueue        Incoming queue
+ * @param seg           Place to store pointer to segment
+ * @return              EOK on success, ENOENT if no segment is ready
+ */
 int tcp_iqueue_get_ready_seg(tcp_iqueue_t *iqueue, tcp_segment_t **seg)
 {