Changeset fc4bf2a in mainline

Timestamp:

2013-07-16T16:42:33Z (11 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

313824a

Parents:

c0f3460

Message:

comments (thx Antonin Steinhauser)

File:

• uspace/srv/net/inetsrv/ntrans.c (modified) (5 diffs)

uspace/srv/net/inetsrv/ntrans.c

@@ -47 +47 @@
 static FIBRIL_CONDVAR_INITIALIZE(ntrans_cv);
 
+/** Look for address in translation table
+ *
+ * @param ip_addr IPv6 address
+ *
+ * @return inet_ntrans_t with the address on success
+ * @return NULL if nothing found
+ */
 static inet_ntrans_t *ntrans_find(addr128_t ip_addr)
 {
@@ -60 +67 @@
 }
 
+/** Add entry to translation table
+ *
+ * @param ip_addr  IPv6 address of the new entry
+ * @param mac_addr MAC address of the new entry
+ *
+ * @return EOK on success
+ * @return ENOMEM if not enough memory
+ *
+ */
 int ntrans_add(addr128_t ip_addr, addr48_t mac_addr)
 {
@@ -86 +102 @@
 }
 
+/** Remove entry from translation table
+ *
+ * @param ip_addr IPv6 address of the entry to be removed
+ *
+ * @return EOK on success
+ * @return ENOENT when no such address found
+ *
+ */
 int ntrans_remove(addr128_t ip_addr)
 {
@@ -104 +128 @@
 }
 
+/** Translate IPv6 address to MAC address using the translation table
+ *
+ * @param ip_addr  IPv6 address to be translated
+ * @param mac_addr MAC address to be assigned
+ *
+ * @return EOK on success
+ * @return ENOENT when no such address found
+ *
+ */
 int ntrans_lookup(addr128_t ip_addr, addr48_t mac_addr)
 {
@@ -118 +151 @@
 }
 
+/** Wait on translation table CV for some time
+ *
+ * @param timeout Timeout in microseconds
+ *
+ * @return EOK if woken up by another fibril
+ * @return ETIMEDOUT if timed out
+ *
+ */
 int ntrans_wait_timeout(suseconds_t timeout)
 {