Changeset 8cd21d16 in mainline for uspace/lib/c/generic/async_sess.c

Timestamp:

2010-12-26T17:52:18Z (14 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

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

Children:

4791e3c

Parents:

a1dc7fe

Message:

Subst conn_link with sess_link and add some docblocks.

File:

• uspace/lib/c/generic/async_sess.c (modified) (8 diffs)

uspace/lib/c/generic/async_sess.c

@@ -107 +107 @@
 #include <assert.h>
 
+/** An inactive open connection. */
 typedef struct {
-        link_t conn_link;       /**< Link for the list of connections. */
-        link_t global_link;     /**< Link for the global list of phones. */
+        link_t sess_link;       /**< Link for the session list of inactive connections. */
+        link_t global_link;     /**< Link for the global list of inactive connectinos. */
         int data_phone;         /**< Connected data phone. */
 } conn_node_t;
@@ -139 +140 @@
 }
 
+/** Create a session.
+ *
+ * Session is a logical datapath from a client task to a server task.
+ * One session can accomodate multiple concurrent exchanges. Here
+ * @a phone is a phone connected to the desired server task.
+ *
+ * This function always succeeds.
+ *
+ * @param sess  Session structure provided by caller, will be filled in.
+ * @param phone Phone connected to the desired server task.
+ */
 void async_session_create(async_sess_t *sess, int phone)
 {
@@ -150 +162 @@
 }
 
+/** Destroy a session.
+ *
+ * Dismantle session structure @a sess and release any resources (connections)
+ * held by the session.
+ *
+ * @param sess  Session to destroy.
+ */
 void async_session_destroy(async_sess_t *sess)
 {
@@ -165 +184 @@
         while (!list_empty(&sess->conn_head)) {
                 conn = list_get_instance(sess->conn_head.next, conn_node_t,
-                    conn_link);
-
-                list_remove(&conn->conn_link);
+                    sess_link);
+
+                list_remove(&conn->sess_link);
                 list_remove(&conn->global_link);
                 
@@ -177 +196 @@
 static void conn_node_initialize(conn_node_t *conn)
 {
-        link_initialize(&conn->conn_link);
+        link_initialize(&conn->sess_link);
         link_initialize(&conn->global_link);
         conn->data_phone = -1;
@@ -200 +219 @@
                  */
                 conn = list_get_instance(sess->conn_head.next, conn_node_t,
-                    conn_link);
-                list_remove(&conn->conn_link);
+                    sess_link);
+                list_remove(&conn->sess_link);
                 list_remove(&conn->global_link);
                 
@@ -224 +243 @@
                             conn_node_t, global_link);
                         list_remove(&conn->global_link);
-                        list_remove(&conn->conn_link);
+                        list_remove(&conn->sess_link);
                         data_phone = conn->data_phone;
                         free(conn);
@@ -267 +286 @@
         conn_node_initialize(conn);
         conn->data_phone = data_phone;
-        list_append(&conn->conn_link, &sess->conn_head);
+        list_append(&conn->sess_link, &sess->conn_head);
         list_append(&conn->global_link, &inactive_conn_head);
         fibril_mutex_unlock(&async_sess_mutex);