diff options
author | Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-05 12:12:21 +0200 |
---|---|---|
committer | Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-06 16:44:34 +0200 |
commit | 485474ec0bcd5fd73743a040cbad326a458e6390 (patch) | |
tree | bca81977a66d96f9e0a29e2e522a64f93d7767f0 /hicn-plugin/src/faces/face_node.h | |
parent | 43d0ecbb1a1f7e1f72bf85441547b1678aed4350 (diff) |
[HICN-606] Added doxygen documentation
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54
Diffstat (limited to 'hicn-plugin/src/faces/face_node.h')
-rw-r--r-- | hicn-plugin/src/faces/face_node.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/hicn-plugin/src/faces/face_node.h b/hicn-plugin/src/faces/face_node.h index 932ee40f5..f5a8bf5ae 100644 --- a/hicn-plugin/src/faces/face_node.h +++ b/hicn-plugin/src/faces/face_node.h @@ -19,6 +19,23 @@ #include <vlib/vlib.h> #include <vnet/vnet.h> +/** + * @file face_node.h + * + * Implements the input and output face nodes. Input face nodes + * process incoming data while output face nodes process outgoing + * interests packets. + * + * Input face nodes follow hicn-face-input nodes and their purpose + * is to retrieve the list of possible incoming faces for each the data packet. + * The following node to the input face nodes is the hicn-data-pcslookup. + * Output face nodes follow the strategy and the hicn-interest-hitpit nodes and + * they perform the src nat on each interest packet. The node following the + * output face nodes depends on the adjacency type. In case of ip, the following + * node is the ip-rewrite, in case of tunnels the next node is the one implementing + * the tunnel encapsulation (udp-encap, mpls, etc). + */ + extern vlib_node_registration_t hicn4_face_input_node; extern vlib_node_registration_t hicn4_face_output_node; extern vlib_node_registration_t hicn6_face_input_node; |