]> git.proxmox.com Git - mirror_frr.git/blob - bfdd/bfdd_nb.h
debian: remove outdated README content
[mirror_frr.git] / bfdd / bfdd_nb.h
1 /*
2 * BFD daemon northbound implementation.
3 *
4 * Copyright (C) 2019 Network Device Education Foundation, Inc. ("NetDEF")
5 * Rafael Zalamena
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 * 02110-1301 USA.
21 */
22
23 #ifndef _FRR_BFDD_NB_H_
24 #define _FRR_BFDD_NB_H_
25
26 extern const struct frr_yang_module_info frr_bfdd_info;
27
28 /* Mandatory callbacks. */
29 int bfdd_bfd_create(enum nb_event event, const struct lyd_node *dnode,
30 union nb_resource *resource);
31 int bfdd_bfd_destroy(enum nb_event event, const struct lyd_node *dnode);
32 int bfdd_bfd_sessions_single_hop_create(enum nb_event event,
33 const struct lyd_node *dnode,
34 union nb_resource *resource);
35 int bfdd_bfd_sessions_single_hop_destroy(enum nb_event event,
36 const struct lyd_node *dnode);
37 const void *bfdd_bfd_sessions_single_hop_get_next(const void *parent_list_entry,
38 const void *list_entry);
39 int bfdd_bfd_sessions_single_hop_get_keys(const void *list_entry,
40 struct yang_list_keys *keys);
41 const void *
42 bfdd_bfd_sessions_single_hop_lookup_entry(const void *parent_list_entry,
43 const struct yang_list_keys *keys);
44 int bfdd_bfd_sessions_single_hop_source_addr_modify(
45 enum nb_event event, const struct lyd_node *dnode,
46 union nb_resource *resource);
47 int bfdd_bfd_sessions_single_hop_source_addr_destroy(
48 enum nb_event event, const struct lyd_node *dnode);
49 int bfdd_bfd_sessions_single_hop_detection_multiplier_modify(
50 enum nb_event event, const struct lyd_node *dnode,
51 union nb_resource *resource);
52 int bfdd_bfd_sessions_single_hop_desired_transmission_interval_modify(
53 enum nb_event event, const struct lyd_node *dnode,
54 union nb_resource *resource);
55 int bfdd_bfd_sessions_single_hop_required_receive_interval_modify(
56 enum nb_event event, const struct lyd_node *dnode,
57 union nb_resource *resource);
58 int bfdd_bfd_sessions_single_hop_administrative_down_modify(
59 enum nb_event event, const struct lyd_node *dnode,
60 union nb_resource *resource);
61 int bfdd_bfd_sessions_single_hop_echo_mode_modify(enum nb_event event,
62 const struct lyd_node *dnode,
63 union nb_resource *resource);
64 int bfdd_bfd_sessions_single_hop_desired_echo_transmission_interval_modify(
65 enum nb_event event, const struct lyd_node *dnode,
66 union nb_resource *resource);
67 struct yang_data *
68 bfdd_bfd_sessions_single_hop_stats_local_discriminator_get_elem(
69 const char *xpath, const void *list_entry);
70 struct yang_data *
71 bfdd_bfd_sessions_single_hop_stats_local_state_get_elem(const char *xpath,
72 const void *list_entry);
73 struct yang_data *bfdd_bfd_sessions_single_hop_stats_local_diagnostic_get_elem(
74 const char *xpath, const void *list_entry);
75 struct yang_data *bfdd_bfd_sessions_single_hop_stats_local_multiplier_get_elem(
76 const char *xpath, const void *list_entry);
77 struct yang_data *
78 bfdd_bfd_sessions_single_hop_stats_remote_discriminator_get_elem(
79 const char *xpath, const void *list_entry);
80 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_state_get_elem(
81 const char *xpath, const void *list_entry);
82 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_diagnostic_get_elem(
83 const char *xpath, const void *list_entry);
84 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_multiplier_get_elem(
85 const char *xpath, const void *list_entry);
86 struct yang_data *
87 bfdd_bfd_sessions_single_hop_stats_negotiated_transmission_interval_get_elem(
88 const char *xpath, const void *list_entry);
89 struct yang_data *
90 bfdd_bfd_sessions_single_hop_stats_negotiated_receive_interval_get_elem(
91 const char *xpath, const void *list_entry);
92 struct yang_data *bfdd_bfd_sessions_single_hop_stats_detection_mode_get_elem(
93 const char *xpath, const void *list_entry);
94 struct yang_data *bfdd_bfd_sessions_single_hop_stats_last_down_time_get_elem(
95 const char *xpath, const void *list_entry);
96 struct yang_data *bfdd_bfd_sessions_single_hop_stats_last_up_time_get_elem(
97 const char *xpath, const void *list_entry);
98 struct yang_data *
99 bfdd_bfd_sessions_single_hop_stats_session_down_count_get_elem(
100 const char *xpath, const void *list_entry);
101 struct yang_data *bfdd_bfd_sessions_single_hop_stats_session_up_count_get_elem(
102 const char *xpath, const void *list_entry);
103 struct yang_data *
104 bfdd_bfd_sessions_single_hop_stats_control_packet_input_count_get_elem(
105 const char *xpath, const void *list_entry);
106 struct yang_data *
107 bfdd_bfd_sessions_single_hop_stats_control_packet_output_count_get_elem(
108 const char *xpath, const void *list_entry);
109 struct yang_data *
110 bfdd_bfd_sessions_single_hop_stats_negotiated_echo_transmission_interval_get_elem(
111 const char *xpath, const void *list_entry);
112 struct yang_data *
113 bfdd_bfd_sessions_single_hop_stats_echo_packet_input_count_get_elem(
114 const char *xpath, const void *list_entry);
115 struct yang_data *
116 bfdd_bfd_sessions_single_hop_stats_echo_packet_output_count_get_elem(
117 const char *xpath, const void *list_entry);
118 int bfdd_bfd_sessions_multi_hop_create(enum nb_event event,
119 const struct lyd_node *dnode,
120 union nb_resource *resource);
121 int bfdd_bfd_sessions_multi_hop_destroy(enum nb_event event,
122 const struct lyd_node *dnode);
123 const void *bfdd_bfd_sessions_multi_hop_get_next(const void *parent_list_entry,
124 const void *list_entry);
125 int bfdd_bfd_sessions_multi_hop_get_keys(const void *list_entry,
126 struct yang_list_keys *keys);
127 const void *
128 bfdd_bfd_sessions_multi_hop_lookup_entry(const void *parent_list_entry,
129 const struct yang_list_keys *keys);
130 int bfdd_bfd_sessions_multi_hop_detection_multiplier_modify(
131 enum nb_event event, const struct lyd_node *dnode,
132 union nb_resource *resource);
133 int bfdd_bfd_sessions_multi_hop_desired_transmission_interval_modify(
134 enum nb_event event, const struct lyd_node *dnode,
135 union nb_resource *resource);
136 int bfdd_bfd_sessions_multi_hop_required_receive_interval_modify(
137 enum nb_event event, const struct lyd_node *dnode,
138 union nb_resource *resource);
139 int bfdd_bfd_sessions_multi_hop_administrative_down_modify(
140 enum nb_event event, const struct lyd_node *dnode,
141 union nb_resource *resource);
142 struct yang_data *
143 bfdd_bfd_sessions_multi_hop_stats_local_discriminator_get_elem(
144 const char *xpath, const void *list_entry);
145 struct yang_data *
146 bfdd_bfd_sessions_multi_hop_stats_local_state_get_elem(const char *xpath,
147 const void *list_entry);
148 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_local_diagnostic_get_elem(
149 const char *xpath, const void *list_entry);
150 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_local_multiplier_get_elem(
151 const char *xpath, const void *list_entry);
152 struct yang_data *
153 bfdd_bfd_sessions_multi_hop_stats_remote_discriminator_get_elem(
154 const char *xpath, const void *list_entry);
155 struct yang_data *
156 bfdd_bfd_sessions_multi_hop_stats_remote_state_get_elem(const char *xpath,
157 const void *list_entry);
158 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_remote_diagnostic_get_elem(
159 const char *xpath, const void *list_entry);
160 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_remote_multiplier_get_elem(
161 const char *xpath, const void *list_entry);
162 struct yang_data *
163 bfdd_bfd_sessions_multi_hop_stats_negotiated_transmission_interval_get_elem(
164 const char *xpath, const void *list_entry);
165 struct yang_data *
166 bfdd_bfd_sessions_multi_hop_stats_negotiated_receive_interval_get_elem(
167 const char *xpath, const void *list_entry);
168 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_detection_mode_get_elem(
169 const char *xpath, const void *list_entry);
170 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_last_down_time_get_elem(
171 const char *xpath, const void *list_entry);
172 struct yang_data *
173 bfdd_bfd_sessions_multi_hop_stats_last_up_time_get_elem(const char *xpath,
174 const void *list_entry);
175 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_session_down_count_get_elem(
176 const char *xpath, const void *list_entry);
177 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_session_up_count_get_elem(
178 const char *xpath, const void *list_entry);
179 struct yang_data *
180 bfdd_bfd_sessions_multi_hop_stats_control_packet_input_count_get_elem(
181 const char *xpath, const void *list_entry);
182 struct yang_data *
183 bfdd_bfd_sessions_multi_hop_stats_control_packet_output_count_get_elem(
184 const char *xpath, const void *list_entry);
185 struct yang_data *
186 bfdd_bfd_sessions_multi_hop_stats_negotiated_echo_transmission_interval_get_elem(
187 const char *xpath, const void *list_entry);
188 struct yang_data *
189 bfdd_bfd_sessions_multi_hop_stats_echo_packet_input_count_get_elem(
190 const char *xpath, const void *list_entry);
191 struct yang_data *
192 bfdd_bfd_sessions_multi_hop_stats_echo_packet_output_count_get_elem(
193 const char *xpath, const void *list_entry);
194
195 /* Optional 'cli_show' callbacks. */
196 void bfd_cli_show_header(struct vty *vty, struct lyd_node *dnode,
197 bool show_defaults);
198 void bfd_cli_show_header_end(struct vty *vty, struct lyd_node *dnode);
199 void bfd_cli_show_single_hop_peer(struct vty *vty, struct lyd_node *dnode,
200 bool show_defaults);
201 void bfd_cli_show_multi_hop_peer(struct vty *vty, struct lyd_node *dnode,
202 bool show_defaults);
203 void bfd_cli_show_peer_end(struct vty *vty, struct lyd_node *dnode);
204 void bfd_cli_show_mult(struct vty *vty, struct lyd_node *dnode,
205 bool show_defaults);
206 void bfd_cli_show_tx(struct vty *vty, struct lyd_node *dnode,
207 bool show_defaults);
208 void bfd_cli_show_rx(struct vty *vty, struct lyd_node *dnode,
209 bool show_defaults);
210 void bfd_cli_show_shutdown(struct vty *vty, struct lyd_node *dnode,
211 bool show_defaults);
212 void bfd_cli_show_echo(struct vty *vty, struct lyd_node *dnode,
213 bool show_defaults);
214 void bfd_cli_show_echo_interval(struct vty *vty, struct lyd_node *dnode,
215 bool show_defaults);
216
217 #endif /* _FRR_BFDD_NB_H_ */