summaryrefslogtreecommitdiffstats
path: root/src/vnet/bfd/bfd_udp.h
diff options
context:
space:
mode:
authorKlement Sekera <ksekera@cisco.com>2017-02-28 11:56:48 +0100
committerDamjan Marion <dmarion.lists@gmail.com>2017-03-06 19:56:12 +0000
commitb16bfe3f94739821c7382bd0849630b21e03a8b7 (patch)
tree5ceaf72bda74fbfed692d3a495100d02ef174c4f /src/vnet/bfd/bfd_udp.h
parentcc078488b4464b4de118c2cde1eb908f5802ae2b (diff)
BFD: documentation
Change-Id: I06a23d24340c5527f3848177d2178bf3e55f7614 Signed-off-by: Klement Sekera <ksekera@cisco.com>
Diffstat (limited to 'src/vnet/bfd/bfd_udp.h')
-rw-r--r--src/vnet/bfd/bfd_udp.h39
1 files changed, 30 insertions, 9 deletions
diff --git a/src/vnet/bfd/bfd_udp.h b/src/vnet/bfd/bfd_udp.h
index e33b7407d56..5080ec98f75 100644
--- a/src/vnet/bfd/bfd_udp.h
+++ b/src/vnet/bfd/bfd_udp.h
@@ -13,7 +13,7 @@
*/
/**
* @file
- * @brief BFD global declarations
+ * @brief BFD UDP transport layer declarations
*/
#ifndef __included_bfd_udp_h__
@@ -25,23 +25,27 @@
#include <vnet/bfd/bfd_api.h>
/* *INDENT-OFF* */
+/** identifier of BFD session based on UDP transport only */
typedef CLIB_PACKED (struct {
-
+ /** interface to which the session is tied */
u32 sw_if_index;
+ /** local address */
ip46_address_t local_addr;
+ /** peer address */
ip46_address_t peer_addr;
-
}) bfd_udp_key_t;
/* *INDENT-ON* */
+/** UDP transport specific data embedded in bfd_session's union */
typedef struct
{
+ /** key identifying this session */
bfd_udp_key_t key;
-
+ /** adjacency index returned from adj lock call */
adj_index_t adj_index;
} bfd_udp_session_t;
-/* bfd udp echo packet trace capture */
+/** bfd udp echo packet trace capture */
typedef struct
{
u32 len;
@@ -50,8 +54,23 @@ typedef struct
struct bfd_session_s;
+/**
+ * @brief add the necessary transport layer by prepending it to existing data
+ *
+ * @param is_echo 1 if this is echo packet, 0 if control frame
+ *
+ * @return 1 on success, 0 on failure
+ */
int bfd_add_udp4_transport (vlib_main_t * vm, vlib_buffer_t * b,
const struct bfd_session_s *bs, int is_echo);
+
+/**
+ * @brief add the necessary transport layer by prepending it to existing data
+ *
+ * @param is_echo 1 if this is echo packet, 0 if control frame
+ *
+ * @return 1 on success, 0 on failure
+ */
int bfd_add_udp6_transport (vlib_main_t * vm, vlib_buffer_t * b,
const struct bfd_session_s *bs, int is_echo);
@@ -62,10 +81,12 @@ int bfd_add_udp6_transport (vlib_main_t * vm, vlib_buffer_t * b,
*/
int bfd_udp_is_echo_available (bfd_transport_e transport);
-void
-bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index, int *have_usable_ip4,
- ip4_address_t * ip4, int *have_usable_ip6,
- ip6_address_t * ip6);
+/**
+ * @brief get echo source information - used by CLI
+ */
+void bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index,
+ int *have_usable_ip4, ip4_address_t * ip4,
+ int *have_usable_ip6, ip6_address_t * ip6);
#endif /* __included_bfd_udp_h__ */