diff options
author | Luca Muscariello <muscariello@ieee.org> | 2020-05-13 21:25:17 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2020-05-13 21:25:17 +0000 |
commit | 76c0e9a9ac88ffc3df287cfb936d23cccad79a6e (patch) | |
tree | 9d04a10a857936e7e2884799a456eea718f4cdcf /hicn-plugin/src/faces/iface_node.h | |
parent | 7415aeaa213e63caa0bc3e625219996d9c2dc93a (diff) | |
parent | 485474ec0bcd5fd73743a040cbad326a458e6390 (diff) |
Merge "[HICN-606] Added doxygen documentation"
Diffstat (limited to 'hicn-plugin/src/faces/iface_node.h')
-rw-r--r-- | hicn-plugin/src/faces/iface_node.h | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/hicn-plugin/src/faces/iface_node.h b/hicn-plugin/src/faces/iface_node.h index 761721b2f..1a7c4291b 100644 --- a/hicn-plugin/src/faces/iface_node.h +++ b/hicn-plugin/src/faces/iface_node.h @@ -13,16 +13,35 @@ * limitations under the License. */ -#ifndef __HICN_IFACE_IP_NODE_H__ -#define __HICN_IFACE_IP_NODE_H__ +#ifndef __HICN_IFACE_NODE_H__ +#define __HICN_IFACE_NODE_H__ #include <vlib/vlib.h> #include <vnet/vnet.h> /** + * @file iface_node.h + * + * Implements the input and output iface nodes. Input iface nodes + * process incoming interests while output face nodes process outgoing + * data packets. + * + * Input iface nodes follow ip-lookup nodes and their purpose + * is to create (or retrieve if already existing) the list incoming face + * for each the interest packet. + * The following node to the input iface nodes is the hicn-interest-pcslookup. + * Output iface nodes follow the hicn-data-fwd and the hicn-interest-hitcs nodes and + * they perform the dst nat on each data packet. The node following the + * output face nodes depends on the adjacency type. In case of ip, the following + * node is the ip4/6-lookup, in case of tunnels the next node is the one implementing + * the tunnel encapsulation (udp-encap, mpls, etc). + */ + + +/** * @brief Initialize the ip iface module */ -void hicn_iface_ip_init (vlib_main_t * vm); +void hicn_iface_init (vlib_main_t * vm); #endif // __HICN_IFACE_IP_NODE_H__ |