Debian Codegraph @

agent/mibgroup/ip-forward-mib/inetCidrRouteTable/inetCidrRouteTable.h

raw
1 /*
2 * Note: this file originally auto-generated by mib2c using
3 * version : 1.48 $ of : mfd-top.m2c,v $
4 *
5 * $Id$
6 */
7 #ifndef INETCIDRROUTETABLE_H
8 #define INETCIDRROUTETABLE_H
9
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13
14
15 /** @addtogroup misc misc: Miscellaneous routines
16 *
17 * @{
18 */
19 #include <net-snmp/library/asn1.h>
20 #include <net-snmp/data_access/route.h>
21
22 /*
23 * other required module components
24 */
25 /* *INDENT-OFF* */
26 config_require(ip-forward-mib/data_access/route);
27 config_require(ip-forward-mib/inetCidrRouteTable/inetCidrRouteTable_interface);
28 config_require(ip-forward-mib/inetCidrRouteTable/inetCidrRouteTable_data_access);
29 /* *INDENT-ON* */
30
31 /*
32 * OID, column number and enum definions for inetCidrRouteTable
33 */
34 #include "inetCidrRouteTable_constants.h"
35
36 /*
37 *********************************************************************
38 * function declarations
39 */
40 void init_inetCidrRouteTable(void);
41 void shutdown_inetCidrRouteTable(void);
42
43 /*
44 *********************************************************************
45 * Table declarations
46 */
47 /**********************************************************************
48 **********************************************************************
49 ***
50 *** Table inetCidrRouteTable
51 ***
52 **********************************************************************
53 **********************************************************************/
54 /*
55 * IP-FORWARD-MIB::inetCidrRouteTable is subid 7 of ipForward.
56 * Its status is Current.
57 * OID: .1.3.6.1.2.1.4.24.7, length: 9
58 */
59 /*
60 *********************************************************************
61 * When you register your mib, you get to provide a generic
62 * pointer that will be passed back to you for most of the
63 * functions calls.
64 *
65 * TODO:100:r: Review all context structures
66 */
67 /*
68 * TODO:101:o: |-> Review inetCidrRouteTable registration context.
69 */
70 typedef netsnmp_data_list inetCidrRouteTable_registration;
71
72 /**********************************************************************/
73 /*
74 * TODO:110:r: |-> Review inetCidrRouteTable data context structure.
75 * This structure is used to represent the data for inetCidrRouteTable.
76 */
77 typedef netsnmp_route_entry inetCidrRouteTable_data;
78
79
80 /*
81 *********************************************************************
82 * TODO:115:o: |-> Review inetCidrRouteTable undo context.
83 * We're just going to use the same data structure for our
84 * undo_context. If you want to do something more efficent,
85 * define your typedef here.
86 */
87 typedef inetCidrRouteTable_data inetCidrRouteTable_undo_data;
88
89 /*
90 * TODO:120:r: |-> Review inetCidrRouteTable mib index.
91 * This structure is used to represent the index for inetCidrRouteTable.
92 */
93 typedef struct inetCidrRouteTable_mib_index_s {
94
95 /*
96 * inetCidrRouteDestType(1)/InetAddressType/ASN_INTEGER/long(u_long)//l/a/w/E/r/d/h
97 */
98 u_long inetCidrRouteDestType;
99
100 /*
101 * inetCidrRouteDest(2)/InetAddress/ASN_OCTET_STR/char(char)//L/a/w/e/R/d/h
102 */
103 char
104 inetCidrRouteDest[NETSNMP_ACCESS_ROUTE_ADDR_BUF_SIZE];
105 size_t inetCidrRouteDest_len;
106
107 /*
108 * inetCidrRoutePfxLen(3)/InetAddressPrefixLength/ASN_UNSIGNED/u_long(u_long)//l/a/w/e/R/d/H
109 */
110 u_long inetCidrRoutePfxLen;
111
112 /*
113 * inetCidrRoutePolicy(4)/OBJECTID/ASN_OBJECT_ID/oid(oid)//L/a/w/e/r/d/h
114 */
115 oid inetCidrRoutePolicy[NETSNMP_POLICY_OID_MAX_LEN];
116 size_t inetCidrRoutePolicy_len;
117
118 /*
119 * inetCidrRouteNextHopType(5)/InetAddressType/ASN_INTEGER/long(u_long)//l/a/w/E/r/d/h
120 */
121 u_long inetCidrRouteNextHopType;
122
123 /*
124 * inetCidrRouteNextHop(6)/InetAddress/ASN_OCTET_STR/char(char)//L/a/w/e/R/d/h
125 */
126 char
127 inetCidrRouteNextHop[NETSNMP_ACCESS_ROUTE_ADDR_BUF_SIZE];
128 size_t inetCidrRouteNextHop_len;
129
130
131 } inetCidrRouteTable_mib_index;
132
133 /*
134 * TODO:121:r: | |-> Review inetCidrRouteTable max index length.
135 * If you KNOW that your indexes will never exceed a certain
136 * length, update this macro to that length.
137 *
138 * BE VERY CAREFUL TO TAKE INTO ACCOUNT THE MAXIMUM
139 * POSSIBLE LENGHT FOR EVERY VARIABLE LENGTH INDEX!
140 */
141 #define MAX_inetCidrRouteTable_IDX_LEN (((NETSNMP_ACCESS_ROUTE_ADDR_BUF_SIZE+1)*2)+ 3 + (NETSNMP_POLICY_OID_MAX_LEN + 1))
142
143
144 /*
145 *********************************************************************
146 * TODO:130:o: |-> Review inetCidrRouteTable Row request (rowreq) context.
147 * When your functions are called, you will be passed a
148 * inetCidrRouteTable_rowreq_ctx pointer.
149 */
150 typedef struct inetCidrRouteTable_rowreq_ctx_s {
151
152 /** this must be first for container compare to work */
153 netsnmp_index oid_idx;
154 oid oid_tmp[MAX_inetCidrRouteTable_IDX_LEN];
155
156 inetCidrRouteTable_mib_index tbl_idx;
157
158 inetCidrRouteTable_data *data;
159 inetCidrRouteTable_undo_data *undo;
160 unsigned int column_set_flags; /* flags for set columns */
161
162
163 /*
164 * flags per row. Currently, the first (lower) 8 bits are reserved
165 * for the user. See mfd.h for other flags.
166 */
167 u_int rowreq_flags;
168
169 /*
170 * TODO:131:o: | |-> Add useful data to inetCidrRouteTable rowreq context.
171 */
172 u_char row_status;
173 u_char row_status_undo;
174
175 /*
176 * storage for future expansion
177 */
178 netsnmp_data_list *inetCidrRouteTable_data_list;
179
180 } inetCidrRouteTable_rowreq_ctx;
181
182 typedef struct inetCidrRouteTable_ref_rowreq_ctx_s {
183 inetCidrRouteTable_rowreq_ctx *rowreq_ctx;
184 } inetCidrRouteTable_ref_rowreq_ctx;
185
186 /*
187 *********************************************************************
188 * function prototypes
189 */
190 int
191 inetCidrRouteTable_pre_request(inetCidrRouteTable_registration *
192 user_context);
193 int
194 inetCidrRouteTable_post_request(inetCidrRouteTable_registration *
195 user_context, int rc);
196
197 int
198 inetCidrRouteTable_rowreq_ctx_init(inetCidrRouteTable_rowreq_ctx *
199 rowreq_ctx,
200 void *user_init_ctx);
201 void
202 inetCidrRouteTable_rowreq_ctx_cleanup(inetCidrRouteTable_rowreq_ctx
203 * rowreq_ctx);
204
205 inetCidrRouteTable_data *inetCidrRouteTable_allocate_data(void);
206 void inetCidrRouteTable_release_data(inetCidrRouteTable_data
207 * data);
208 inetCidrRouteTable_rowreq_ctx
209 * inetCidrRouteTable_row_find_by_mib_index
210 (inetCidrRouteTable_mib_index * mib_idx);
211
212 extern const oid inetCidrRouteTable_oid[];
213 extern const int inetCidrRouteTable_oid_size;
214
215
216 #include "inetCidrRouteTable_interface.h"
217 #include "inetCidrRouteTable_data_access.h"
218 /*
219 *********************************************************************
220 * GET function declarations
221 */
222
223 /*
224 *********************************************************************
225 * GET Table declarations
226 */
227 /**********************************************************************
228 **********************************************************************
229 ***
230 *** Table inetCidrRouteTable
231 ***
232 **********************************************************************
233 **********************************************************************/
234 /*
235 * IP-FORWARD-MIB::inetCidrRouteTable is subid 7 of ipForward.
236 * Its status is Current.
237 * OID: .1.3.6.1.2.1.4.24.7, length: 9
238 */
239 /*
240 * indexes
241 */
242
243 int inetCidrRouteIfIndex_get(inetCidrRouteTable_rowreq_ctx
244 * rowreq_ctx, long
245 *inetCidrRouteIfIndex_val_ptr);
246 int inetCidrRouteType_get(inetCidrRouteTable_rowreq_ctx *
247 rowreq_ctx,
248 u_long *
249 inetCidrRouteType_val_ptr);
250 int inetCidrRouteProto_get(inetCidrRouteTable_rowreq_ctx *
251 rowreq_ctx,
252 u_long *
253 inetCidrRouteProto_val_ptr);
254 int inetCidrRouteAge_get(inetCidrRouteTable_rowreq_ctx *
255 rowreq_ctx,
256 u_long *
257 inetCidrRouteAge_val_ptr);
258 int
259 inetCidrRouteNextHopAS_get(inetCidrRouteTable_rowreq_ctx *
260 rowreq_ctx,
261 u_long *
262 inetCidrRouteNextHopAS_val_ptr);
263 int inetCidrRouteMetric1_get(inetCidrRouteTable_rowreq_ctx
264 * rowreq_ctx, long
265 *inetCidrRouteMetric1_val_ptr);
266 int inetCidrRouteMetric2_get(inetCidrRouteTable_rowreq_ctx
267 * rowreq_ctx, long
268 *inetCidrRouteMetric2_val_ptr);
269 int inetCidrRouteMetric3_get(inetCidrRouteTable_rowreq_ctx
270 * rowreq_ctx, long
271 *inetCidrRouteMetric3_val_ptr);
272 int inetCidrRouteMetric4_get(inetCidrRouteTable_rowreq_ctx
273 * rowreq_ctx, long
274 *inetCidrRouteMetric4_val_ptr);
275 int inetCidrRouteMetric5_get(inetCidrRouteTable_rowreq_ctx
276 * rowreq_ctx, long
277 *inetCidrRouteMetric5_val_ptr);
278 int inetCidrRouteStatus_get(inetCidrRouteTable_rowreq_ctx *
279 rowreq_ctx,
280 u_long *
281 inetCidrRouteStatus_val_ptr);
282
283
284 int
285 inetCidrRouteTable_indexes_set_tbl_idx(inetCidrRouteTable_mib_index
286 * tbl_idx,
287 u_long
288 inetCidrRouteDestType_val,
289 char
290 *inetCidrRouteDest_val_ptr,
291 size_t
292 inetCidrRouteDest_val_ptr_len,
293 u_long
294 inetCidrRoutePfxLen_val,
295 oid *
296 inetCidrRoutePolicy_val_ptr,
297 size_t
298 inetCidrRoutePolicy_val_ptr_len,
299 u_long
300 inetCidrRouteNextHopType_val,
301 char
302 *inetCidrRouteNextHop_val_ptr,
303 size_t
304 inetCidrRouteNextHop_val_ptr_len);
305 int
306 inetCidrRouteTable_indexes_set(inetCidrRouteTable_rowreq_ctx *
307 rowreq_ctx,
308 u_long inetCidrRouteDestType_val,
309 char *inetCidrRouteDest_val_ptr,
310 size_t
311 inetCidrRouteDest_val_ptr_len,
312 u_long inetCidrRoutePfxLen_val,
313 oid * inetCidrRoutePolicy_val_ptr,
314 size_t
315 inetCidrRoutePolicy_val_ptr_len,
316 u_long inetCidrRouteNextHopType_val,
317 char *inetCidrRouteNextHop_val_ptr,
318 size_t
319 inetCidrRouteNextHop_val_ptr_len);
320
321
322
323 /*
324 *********************************************************************
325 * SET function declarations
326 */
327
328 /*
329 *********************************************************************
330 * SET Table declarations
331 */
332 /**********************************************************************
333 **********************************************************************
334 ***
335 *** Table inetCidrRouteTable
336 ***
337 **********************************************************************
338 **********************************************************************/
339 /*
340 * IP-FORWARD-MIB::inetCidrRouteTable is subid 7 of ipForward.
341 * Its status is Current.
342 * OID: .1.3.6.1.2.1.4.24.7, length: 9
343 */
344
345
346 int
347 inetCidrRouteTable_undo_setup(inetCidrRouteTable_rowreq_ctx *
348 rowreq_ctx);
349 int
350 inetCidrRouteTable_undo_cleanup(inetCidrRouteTable_rowreq_ctx *
351 rowreq_ctx);
352 int inetCidrRouteTable_undo(inetCidrRouteTable_rowreq_ctx *
353 rowreq_ctx);
354 int inetCidrRouteTable_commit(inetCidrRouteTable_rowreq_ctx
355 * rowreq_ctx);
356 int
357 inetCidrRouteTable_undo_commit(inetCidrRouteTable_rowreq_ctx *
358 rowreq_ctx);
359
360
361 int
362 inetCidrRouteIfIndex_check_value(inetCidrRouteTable_rowreq_ctx *
363 rowreq_ctx,
364 long inetCidrRouteIfIndex_val);
365 int
366 inetCidrRouteIfIndex_undo_setup(inetCidrRouteTable_rowreq_ctx *
367 rowreq_ctx);
368 int inetCidrRouteIfIndex_set(inetCidrRouteTable_rowreq_ctx
369 * rowreq_ctx, long
370 inetCidrRouteIfIndex_val);
371 int inetCidrRouteIfIndex_undo(inetCidrRouteTable_rowreq_ctx
372 * rowreq_ctx);
373
374 int
375 inetCidrRouteType_check_value(inetCidrRouteTable_rowreq_ctx *
376 rowreq_ctx,
377 u_long inetCidrRouteType_val);
378 int
379 inetCidrRouteType_undo_setup(inetCidrRouteTable_rowreq_ctx *
380 rowreq_ctx);
381 int inetCidrRouteType_set(inetCidrRouteTable_rowreq_ctx *
382 rowreq_ctx,
383 u_long inetCidrRouteType_val);
384 int inetCidrRouteType_undo(inetCidrRouteTable_rowreq_ctx *
385 rowreq_ctx);
386
387 int
388 inetCidrRouteProto_check_value(inetCidrRouteTable_rowreq_ctx *
389 rowreq_ctx,
390 u_long inetCidrRouteProto_val);
391 int
392 inetCidrRouteProto_undo_setup(inetCidrRouteTable_rowreq_ctx *
393 rowreq_ctx);
394 int inetCidrRouteProto_set(inetCidrRouteTable_rowreq_ctx *
395 rowreq_ctx,
396 u_long inetCidrRouteProto_val);
397 int inetCidrRouteProto_undo(inetCidrRouteTable_rowreq_ctx *
398 rowreq_ctx);
399
400 int
401 inetCidrRouteAge_check_value(inetCidrRouteTable_rowreq_ctx *
402 rowreq_ctx,
403 u_long inetCidrRouteAge_val);
404 int
405 inetCidrRouteAge_undo_setup(inetCidrRouteTable_rowreq_ctx *
406 rowreq_ctx);
407 int inetCidrRouteAge_set(inetCidrRouteTable_rowreq_ctx *
408 rowreq_ctx,
409 u_long inetCidrRouteAge_val);
410 int inetCidrRouteAge_undo(inetCidrRouteTable_rowreq_ctx *
411 rowreq_ctx);
412
413 int
414 inetCidrRouteNextHopAS_check_value(inetCidrRouteTable_rowreq_ctx *
415 rowreq_ctx,
416 u_long
417 inetCidrRouteNextHopAS_val);
418 int
419 inetCidrRouteNextHopAS_undo_setup(inetCidrRouteTable_rowreq_ctx *
420 rowreq_ctx);
421 int
422 inetCidrRouteNextHopAS_set(inetCidrRouteTable_rowreq_ctx *
423 rowreq_ctx,
424 u_long inetCidrRouteNextHopAS_val);
425 int
426 inetCidrRouteNextHopAS_undo(inetCidrRouteTable_rowreq_ctx *
427 rowreq_ctx);
428
429 int
430 inetCidrRouteMetric1_check_value(inetCidrRouteTable_rowreq_ctx *
431 rowreq_ctx,
432 long inetCidrRouteMetric1_val);
433 int
434 inetCidrRouteMetric1_undo_setup(inetCidrRouteTable_rowreq_ctx *
435 rowreq_ctx);
436 int inetCidrRouteMetric1_set(inetCidrRouteTable_rowreq_ctx
437 * rowreq_ctx, long
438 inetCidrRouteMetric1_val);
439 int inetCidrRouteMetric1_undo(inetCidrRouteTable_rowreq_ctx
440 * rowreq_ctx);
441
442 int
443 inetCidrRouteMetric2_check_value(inetCidrRouteTable_rowreq_ctx *
444 rowreq_ctx,
445 long inetCidrRouteMetric2_val);
446 int
447 inetCidrRouteMetric2_undo_setup(inetCidrRouteTable_rowreq_ctx *
448 rowreq_ctx);
449 int inetCidrRouteMetric2_set(inetCidrRouteTable_rowreq_ctx
450 * rowreq_ctx, long
451 inetCidrRouteMetric2_val);
452 int inetCidrRouteMetric2_undo(inetCidrRouteTable_rowreq_ctx
453 * rowreq_ctx);
454
455 int
456 inetCidrRouteMetric3_check_value(inetCidrRouteTable_rowreq_ctx *
457 rowreq_ctx,
458 long inetCidrRouteMetric3_val);
459 int
460 inetCidrRouteMetric3_undo_setup(inetCidrRouteTable_rowreq_ctx *
461 rowreq_ctx);
462 int inetCidrRouteMetric3_set(inetCidrRouteTable_rowreq_ctx
463 * rowreq_ctx, long
464 inetCidrRouteMetric3_val);
465 int inetCidrRouteMetric3_undo(inetCidrRouteTable_rowreq_ctx
466 * rowreq_ctx);
467
468 int
469 inetCidrRouteMetric4_check_value(inetCidrRouteTable_rowreq_ctx *
470 rowreq_ctx,
471 long inetCidrRouteMetric4_val);
472 int
473 inetCidrRouteMetric4_undo_setup(inetCidrRouteTable_rowreq_ctx *
474 rowreq_ctx);
475 int inetCidrRouteMetric4_set(inetCidrRouteTable_rowreq_ctx
476 * rowreq_ctx, long
477 inetCidrRouteMetric4_val);
478 int inetCidrRouteMetric4_undo(inetCidrRouteTable_rowreq_ctx
479 * rowreq_ctx);
480
481 int
482 inetCidrRouteMetric5_check_value(inetCidrRouteTable_rowreq_ctx *
483 rowreq_ctx,
484 long inetCidrRouteMetric5_val);
485 int
486 inetCidrRouteMetric5_undo_setup(inetCidrRouteTable_rowreq_ctx *
487 rowreq_ctx);
488 int inetCidrRouteMetric5_set(inetCidrRouteTable_rowreq_ctx
489 * rowreq_ctx, long
490 inetCidrRouteMetric5_val);
491 int inetCidrRouteMetric5_undo(inetCidrRouteTable_rowreq_ctx
492 * rowreq_ctx);
493
494 int
495 inetCidrRouteStatus_check_value(inetCidrRouteTable_rowreq_ctx *
496 rowreq_ctx,
497 u_long inetCidrRouteStatus_val);
498 int
499 inetCidrRouteStatus_undo_setup(inetCidrRouteTable_rowreq_ctx *
500 rowreq_ctx);
501 int inetCidrRouteStatus_set(inetCidrRouteTable_rowreq_ctx *
502 rowreq_ctx,
503 u_long
504 inetCidrRouteStatus_val);
505 int inetCidrRouteStatus_undo(inetCidrRouteTable_rowreq_ctx
506 * rowreq_ctx);
507
508
509 int
510 inetCidrRouteTable_check_dependencies(inetCidrRouteTable_rowreq_ctx
511 * ctx);
512
513
514 /*
515 * DUMMY markers, ignore
516 *
517 * TODO:099:x: *************************************************************
518 * TODO:199:x: *************************************************************
519 * TODO:299:x: *************************************************************
520 * TODO:399:x: *************************************************************
521 * TODO:499:x: *************************************************************
522 */
523
524 #ifdef __cplusplus
525 }
526 #endif
527 #endif /* INETCIDRROUTETABLE_H */
528 /** @} */
529