2 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 /** \brief Configure BFD feature
17 @param client_index - opaque cookie to identify the sender
18 @param context - sender context, to match reply w/ request
19 @param slow_timer - slow timer (seconds)
20 @param min_tx - desired min tx interval
21 @param min_rx - desired min rx interval
22 @param detect_mult - desired detection multiplier
24 define bfd_set_config {
33 /** \brief Configure BFD feature response
34 @param context - sender context, to match reply w/ request
35 @param retval - return code for the request
37 define bfd_set_config_reply {
42 /** \brief Get BFD configuration
44 define bfd_get_config {
49 /** \brief Get BFD configuration response
50 @param context - sender context, to match reply w/ request
51 @param retval - return code for the request
52 @param slow_timer - slow timer (seconds)
53 @param min_tx - desired min tx interval
54 @param min_rx - desired min rx interval
55 @param detect_mult - desired detection multiplier
57 define bfd_get_config_reply {
66 /** \brief Add UDP BFD session on interface
67 @param client_index - opaque cookie to identify the sender
68 @param context - sender context, to match reply w/ request
69 @param sw_if_index - sw index of the interface
70 @param desired_min_tx - desired min transmit interval (microseconds)
71 @param required_min_rx - required min receive interval (microseconds)
72 @param detect_mult - detect multiplier (# of packets missed between connection goes down)
73 @param local_addr - local address
74 @param peer_addr - peer address
75 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
89 /** \brief Add UDP BFD session response
90 @param context - sender context, to match reply w/ request
91 @param retval - return code for the request
92 @param bs_index - index of the session created
94 define bfd_udp_add_reply {
100 /** \brief Delete UDP BFD session on interface
101 @param client_index - opaque cookie to identify the sender
102 @param context - sender context, to match reply w/ request
103 @param sw_if_index - sw index of the interface
104 @param local_addr - local address
105 @param peer_addr - peer address
106 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
117 /** \brief Delete UDP BFD session response
118 @param context - sender context, to match reply w/ request
119 @param retval - return code for the request
121 define bfd_udp_del_reply {
126 /** \brief Get all BFD sessions
127 @param client_index - opaque cookie to identify the sender
128 @param context - sender context, to match reply w/ request
130 define bfd_udp_session_dump {
135 /** \brief BFD session details structure
136 @param context - sender context, to match reply w/ request
137 @param bs_index - index of the session
138 @param sw_if_index - sw index of the interface
139 @param local_addr - local address
140 @param peer_addr - peer address
141 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
142 @param state - session state
144 define bfd_udp_session_details {
154 /** \brief Set flags of BFD session
155 @param client_index - opaque cookie to identify the sender
156 @param context - sender context, to match reply w/ request
157 @param bs_index - index of the bfd session to set flags on
158 @param admin_up_down - set the admin state, 1 = up, 0 = down
160 define bfd_session_set_flags {
167 /** \brief Reply to bfd_session_set_flags
168 @param context - sender context which was passed in the request
169 @param retval - return code of the set flags request
171 define bfd_session_set_flags_reply
177 /** \brief Register for BFD events
178 @param client_index - opaque cookie to identify the sender
179 @param context - sender context, to match reply w/ request
180 @param enable_disable - 1 => register for events, 0 => cancel registration
181 @param pid - sender's pid
183 define want_bfd_events
191 /** \brief Reply for BFD events registration
192 @param context - returned sender context, to match reply w/ request
193 @param retval - return code
195 define want_bfd_events_reply
203 * eval: (c-set-style "gnu")