[hipl-dev] [Branch ~hipl-core/hipl/trunk] Rev 5160: Fixed missing function documentation.
- From: noreply@xxxxxxxxxxxxx
- To: HIPL core team <hipl-dev@xxxxxxxxxxxxx>
- Date: Tue, 16 Nov 2010 14:26:28 -0000
------------------------------------------------------------
revno: 5160
author: Stefan Götz <stefan.goetz@xxxxxxxxxxxxxxxxx>
committer: Diego Biurrun <diego@xxxxxxxxxx>
branch nick: fw-cache-port-cleanup
timestamp: Mon 2010-11-15 22:21:47 +0100
message:
Fixed missing function documentation.
modified:
firewall/port_bindings.c
--
lp:hipl
https://code.launchpad.net/~hipl-core/hipl/trunk
Your team HIPL core team is subscribed to branch lp:hipl.
To unsubscribe from this branch go to
https://code.launchpad.net/~hipl-core/hipl/trunk/+edit-subscription
=== modified file 'firewall/port_bindings.c'
--- firewall/port_bindings.c 2010-11-12 17:49:42 +0000
+++ firewall/port_bindings.c 2010-11-15 21:21:47 +0000
@@ -300,11 +300,21 @@
}
/**
- * Look up the port binding from the proc file system.
+ * Look up in the proc file system whether a TCP or UDP port is bound under
+ * IPv6.
+ * It iterates over the lines in /proc/net/{udp,tcp}6 via a line parser object
+ * and returns whether a match was found.
*
- * @param protocol protocol type
- * @param port the port number of the socket
- * @return the traffic type associated with the given port.
+ * @param protocol the protocol to check the port binding for.
+ * The values are equivalent to those found in the 'Protocol' field of the
+ * IPv4 header and the 'Next Header' field of the IPv6 header.
+ * The only supported values are those for TCP (6) and UDP (17).
+ * The effect of calling this function with an unsupported value is undefined.
+ * @param port the port to look up.
+ * The value is expected in host byte order.
+ * @return HIP_PORT_INFO_IPV6BOUND if the given port is bound under the given
+ * protocol to an IPv6 address.
+ * HIP_PORT_INFO_IPV6UNBOUND if it is not.
*/
static enum hip_port_binding hip_port_bindings_get_from_proc(const uint8_t
protocol,
const uint16_t
port)
Other related posts:
- » [hipl-dev] [Branch ~hipl-core/hipl/trunk] Rev 5160: Fixed missing function documentation. - noreply
