[hipl-commit] [trunk] Rev 4006: Doxygen for hipd/user.c.

From: Miika Komu <miika@xxxxxx>
To: hipl-commit@xxxxxxxxxxxxx
Date: Thu, 18 Mar 2010 15:19:07 +0200
Committer: Miika Komu <miika@xxxxxx>
Date: 18/03/2010 at 15:19:07
Revision: 4006
Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Doxygen for hipd/user.c.
  Removed one unreferenced function.

Modified:
  M  hipd/user.c
  M  hipd/user.h

=== modified file 'hipd/user.c'
--- hipd/user.c 2010-03-18 12:09:47 +0000
+++ hipd/user.c 2010-03-18 13:19:05 +0000
@@ -1,16 +1,25 @@
 /** @file
- * This file defines a user message handling function for the Host Identity
- * Protocol (HIP).
- *
- * We don't currently have a workqueue. The functionality in this file mostly
- * covers catching userspace messages only.
+ *
+ * Distributed under <a 
href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>.
+ *
+ * This file defines a user message (i.e. message from hipconf or hipfw) 
processing.
+ * The interface sends a response message back if the sender requested one. See
+ * lib/core/message.c for the details.
+ *
+ * No queue has been implemented for the user message. The interface relies on
+ * the user socket internal buffers to have enough space for caching.
+ *
+ * The user socket listens on an UDP port bound to IPv6 loopback.
+ * Processing of user messages includes an access control mechanism based on 
the
+ * port number. If the sender's port number is below 1024, it is running on
+ * root privileges and has full access. Ports above 1024 have limited access
+ * to functionality.
  *
  * @author  Miika Komu <miika_iki.fi>
  * @author  Kristian Slavov <kslavov_hiit.fi>
  * @author  Bing Zhou <bingzhou_cc.hut.fi>
  * @author  Tao Wan  <twan_cc.hut.fi>
  * @author  Rene Hummen
- * @note    Distributed under <a 
href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>.
  */
 
 /* required for s6_addr32 */
@@ -1252,20 +1261,3 @@
 
     return err;
 }
-
-int hip_handle_netlink_msg(const struct nlmsghdr *msg, int len, void *arg)
-{
-    int err = 0;
-
-    for (; NLMSG_OK(msg, (uint32_t) len); msg = NLMSG_NEXT(msg, len)) {
-        switch (msg->nlmsg_type) {
-        case HIP_MSG_ADD_PEER_MAP_HIT_IP:
-            HIP_DEBUG("add hit-ip map\n");
-            break;
-        default:
-            HIP_DEBUG("Unexpected msg type: %d\n", msg->nlmsg_type);
-            break;
-        }
-    }
-    return err;
-}

=== modified file 'hipd/user.h'
--- hipd/user.h 2010-02-17 17:38:08 +0000
+++ hipd/user.h 2010-03-18 13:19:05 +0000
@@ -29,6 +29,4 @@
 int hip_sendto_user(const struct hip_common *msg, const struct sockaddr *dst);
 int hip_handle_user_msg(hip_common_t *msg, struct sockaddr_in6 *src);
 
-int hip_handle_netlink_msg(const struct nlmsghdr *msg, int len, void *arg);
-
 #endif /* HIP_HIPD_USER_H */
[hipl-commit] [trunk] Rev 4006: Doxygen for hipd/user.c.

Other related posts:
