1 /*
2  * Note: this file originally auto-generated by mib2c using
3  *       version : 1.48 $ of : mfd-top.m2c,v $
4  *
5  * Portions of this file are copyrighted by:
6  * Copyright (c) 2016 VMware, Inc. All rights reserved.
7  * Use is subject to license terms specified in the COPYING file
8  * distributed with the Net-SNMP package.
9  */
10 #ifndef SNMPNOTIFYFILTERTABLE_H
11 #define SNMPNOTIFYFILTERTABLE_H
12 
13 #ifdef __cplusplus
14 extern          "C" {
15 #endif
16 
17 
18 /** @addtogroup misc misc: Miscellaneous routines
19  *
20  * @{
21  */
22 #include <net-snmp/library/asn1.h>
23 #include "snmp-notification-mib/snmpNotifyFilterTable/snmpNotifyFilterTable_data_storage.h"
24 
25     /*
26      * other required module components
27      */
28     /* *INDENT-OFF*  */
29 config_require(snmp-notification-mib/snmpNotifyFilterTable/snmpNotifyFilterTable_interface)
30 config_require(snmp-notification-mib/snmpNotifyFilterTable/snmpNotifyFilterTable_data_access)
31     /* *INDENT-ON*  */
32 
33     /*
34      * OID, column number and enum definions for snmpNotifyFilterTable
35      */
36 #include "snmpNotifyFilterTable_constants.h"
37 
38     /*
39      *********************************************************************
40      * function declarations
41      */
42     void            init_snmpNotifyFilterTable(void);
43     void            shutdown_snmpNotifyFilterTable(void);
44 
45     /*
46      *********************************************************************
47      * Table declarations
48      */
49 /**********************************************************************
50  **********************************************************************
51  ***
52  *** Table snmpNotifyFilterTable
53  ***
54  **********************************************************************
55  **********************************************************************/
56     /*
57      * SNMP-NOTIFICATION-MIB::snmpNotifyFilterTable is subid 3 of snmpNotifyObjects.
58      * Its status is Current.
59      * OID: .1.3.6.1.6.3.13.1.3, length: 9
60      */
61     /*
62      *********************************************************************
63      * When you register your mib, you get to provide a generic
64      * pointer that will be passed back to you for most of the
65      * functions calls.
66      *
67      * TODO:100:r: Review all context structures
68      */
69     /*
70      * TODO:101:o: |-> Review snmpNotifyFilterTable registration context.
71      */
72     typedef netsnmp_data_list snmpNotifyFilterTable_registration;
73 
74 /**********************************************************************/
75     /*
76      * TODO:110:r: |-> Review snmpNotifyFilterTable data context structure.
77      * This structure is used to represent the data for snmpNotifyFilterTable.
78      */
79     /*
80      * This structure contains storage for all the columns defined in the
81      * snmpNotifyFilterTable.
82      */
83     typedef struct snmpNotifyFilterTable_data_s {
84 
85         /*
86          * snmpNotifyFilterMask(2)/OCTETSTR/ASN_OCTET_STR/char(char)//L/A/W/e/R/D/h
87          */
88         char            snmpNotifyFilterMask[16];
89         size_t          snmpNotifyFilterMask_len;       /* # of char elements, not bytes */
90 
91         /*
92          * snmpNotifyFilterType(3)/INTEGER/ASN_INTEGER/long(u_long)//l/A/W/E/r/D/h
93          */
94         u_long          snmpNotifyFilterType;
95 
96         /*
97          * snmpNotifyFilterStorageType(4)/StorageType/ASN_INTEGER/long(u_long)//l/A/W/E/r/D/h
98          */
99         u_long          snmpNotifyFilterStorageType;
100 
101         /*
102          * snmpNotifyFilterRowStatus(5)/RowStatus/ASN_INTEGER/long(u_long)//l/A/W/E/r/d/h
103          */
104         u_long          snmpNotifyFilterRowStatus;
105 
106     } snmpNotifyFilterTable_data;
107 
108 
109     /*
110      *********************************************************************
111      * TODO:115:o: |-> Review snmpNotifyFilterTable undo context.
112      * We're just going to use the same data structure for our
113      * undo_context. If you want to do something more efficent,
114      * define your typedef here.
115      */
116     typedef snmpNotifyFilterTable_data snmpNotifyFilterTable_undo_data;
117 
118     /*
119      * TODO:120:r: |-> Review snmpNotifyFilterTable mib index.
120      * This structure is used to represent the index for snmpNotifyFilterTable.
121      */
122     typedef struct snmpNotifyFilterTable_mib_index_s {
123 
124         /*
125          * snmpNotifyFilterProfileName(1)/SnmpAdminString/ASN_OCTET_STR/char(char)//L/A/W/e/R/d/H
126          */
127         char            snmpNotifyFilterProfileName[32];
128         size_t          snmpNotifyFilterProfileName_len;
129 
130         /*
131          * snmpNotifyFilterSubtree(1)/OBJECTID/ASN_OBJECT_ID/oid(oid)//L/a/w/e/r/d/h
132          */
133         /** 128 - 1(other indexes) - oid length(11) = 115 */
134         oid             snmpNotifyFilterSubtree[115];
135         size_t          snmpNotifyFilterSubtree_len;
136 
137 
138     } snmpNotifyFilterTable_mib_index;
139 
140 
141 
142     /*
143      *********************************************************************
144      * TODO:130:o: |-> Review snmpNotifyFilterTable Row request (rowreq) context.
145      * When your functions are called, you will be passed a
146      * snmpNotifyFilterTable_rowreq_ctx pointer.
147      */
148     typedef struct snmpNotifyFilterTable_rowreq_ctx_s {
149 
150     /** this must be first for container compare to work */
151         netsnmp_index   oid_idx;
152         oid             oid_tmp[MAX_snmpNotifyFilterTable_IDX_LEN];
153 
154         snmpNotifyFilterTable_mib_index tbl_idx;
155 
156         snmpNotifyFilterTable_data data;
157         snmpNotifyFilterTable_undo_data *undo;
158         unsigned int    column_set_flags;       /* flags for set columns */
159 
160 
161         /*
162          * flags per row. Currently, the first (lower) 8 bits are reserved
163          * for the user. See mfd.h for other flags.
164          */
165         u_int           rowreq_flags;
166 
167         /*
168          * TODO:131:o: |   |-> Add useful data to snmpNotifyFilterTable rowreq context.
169          */
170 
171         /*
172          * storage for future expansion
173          */
174         netsnmp_data_list *snmpNotifyFilterTable_data_list;
175 
176     } snmpNotifyFilterTable_rowreq_ctx;
177 
178     typedef struct snmpNotifyFilterTable_ref_rowreq_ctx_s {
179         snmpNotifyFilterTable_rowreq_ctx *rowreq_ctx;
180     } snmpNotifyFilterTable_ref_rowreq_ctx;
181 
182     /*
183      *********************************************************************
184      * function prototypes
185      */
186     int
187 
188 
189 
190 
191 
192 
193 
194 
195 
196 
197 
198 
199 
200 
201 
202         snmpNotifyFilterTable_pre_request
203         (snmpNotifyFilterTable_registration * user_context);
204     int
205 
206 
207 
208 
209 
210 
211 
212 
213 
214 
215 
216 
217 
218 
219 
220         snmpNotifyFilterTable_post_request
221         (snmpNotifyFilterTable_registration * user_context, int rc);
222 
223     int
224 
225 
226 
227 
228 
229 
230 
231 
232 
233 
234 
235 
236 
237 
238 
239         snmpNotifyFilterTable_rowreq_ctx_init
240         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx,
241          void *user_init_ctx);
242     void
243 
244 
245 
246 
247 
248 
249 
250 
251 
252 
253 
254 
255 
256 
257 
258         snmpNotifyFilterTable_rowreq_ctx_cleanup
259         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx);
260 
261     int
262 
263 
264 
265 
266 
267 
268 
269 
270 
271 
272 
273 
274 
275 
276 
277         snmpNotifyFilterTable_check_dependencies
278         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx);
279     int
280 
281 
282 
283 
284 
285 
286 
287 
288 
289 
290 
291 
292 
293 
294 
295         snmpNotifyFilterTable_commit(snmpNotifyFilterTable_rowreq_ctx *
296                                      rowreq_ctx);
297 
298 
299 
300 
301 
302 
303 
304         snmpNotifyFilterTable_rowreq_ctx
305         * snmpNotifyFilterTable_row_find_by_mib_index
306         (snmpNotifyFilterTable_mib_index * mib_idx);
307 
308     extern const oid      snmpNotifyFilterTable_oid[];
309     extern const int      snmpNotifyFilterTable_oid_size;
310 
311 
312 #include "snmpNotifyFilterTable_interface.h"
313 #include "snmpNotifyFilterTable_data_access.h"
314     /*
315      *********************************************************************
316      * GET function declarations
317      */
318 
319     /*
320      *********************************************************************
321      * GET Table declarations
322      */
323 /**********************************************************************
324  **********************************************************************
325  ***
326  *** Table snmpNotifyFilterTable
327  ***
328  **********************************************************************
329  **********************************************************************/
330     /*
331      * SNMP-NOTIFICATION-MIB::snmpNotifyFilterTable is subid 3 of snmpNotifyObjects.
332      * Its status is Current.
333      * OID: .1.3.6.1.6.3.13.1.3, length: 9
334      */
335     /*
336      * indexes
337      */
338 
339     int
340 
341 
342 
343 
344 
345 
346 
347 
348 
349 
350 
351 
352 
353 
354 
355         snmpNotifyFilterMask_get(snmpNotifyFilterTable_rowreq_ctx *
356                                  rowreq_ctx,
357                                  char **snmpNotifyFilterMask_val_ptr_ptr,
358                                  size_t
359                                  * snmpNotifyFilterMask_val_ptr_len_ptr);
360     int
361 
362 
363 
364 
365 
366 
367 
368 
369 
370 
371 
372 
373 
374 
375 
376         snmpNotifyFilterType_get(snmpNotifyFilterTable_rowreq_ctx *
377                                  rowreq_ctx,
378                                  u_long * snmpNotifyFilterType_val_ptr);
379     int
380 
381 
382 
383 
384 
385 
386 
387 
388 
389 
390 
391 
392 
393 
394 
395         snmpNotifyFilterStorageType_get(snmpNotifyFilterTable_rowreq_ctx *
396                                         rowreq_ctx,
397                                         u_long *
398                                         snmpNotifyFilterStorageType_val_ptr);
399     int
400 
401 
402 
403 
404 
405 
406 
407 
408 
409 
410 
411 
412 
413 
414 
415         snmpNotifyFilterRowStatus_get(snmpNotifyFilterTable_rowreq_ctx *
416                                       rowreq_ctx,
417                                       u_long *
418                                       snmpNotifyFilterRowStatus_val_ptr);
419 
420 
421     int
422 
423 
424 
425 
426 
427 
428 
429 
430 
431 
432 
433 
434 
435 
436 
437         snmpNotifyFilterTable_indexes_set_tbl_idx
438         (snmpNotifyFilterTable_mib_index * tbl_idx,
439          char *snmpNotifyFilterProfileName_val_ptr,
440          size_t snmpNotifyFilterProfileName_val_ptr_len,
441          oid * snmpNotifyFilterSubtree_val_ptr,
442          size_t snmpNotifyFilterSubtree_val_ptr_len);
443     int
444 
445 
446 
447 
448 
449 
450 
451 
452 
453 
454 
455 
456 
457 
458 
459         snmpNotifyFilterTable_indexes_set(snmpNotifyFilterTable_rowreq_ctx
460                                           * rowreq_ctx, char
461                                           *snmpNotifyFilterProfileName_val_ptr,
462                                           size_t
463                                           snmpNotifyFilterProfileName_val_ptr_len,
464                                           oid *
465                                           snmpNotifyFilterSubtree_val_ptr,
466                                           size_t
467                                           snmpNotifyFilterSubtree_val_ptr_len);
468 
469 
470 
471     /*
472      *********************************************************************
473      * SET function declarations
474      */
475 
476     /*
477      *********************************************************************
478      * SET Table declarations
479      */
480 /**********************************************************************
481  **********************************************************************
482  ***
483  *** Table snmpNotifyFilterTable
484  ***
485  **********************************************************************
486  **********************************************************************/
487     /*
488      * SNMP-NOTIFICATION-MIB::snmpNotifyFilterTable is subid 3 of snmpNotifyObjects.
489      * Its status is Current.
490      * OID: .1.3.6.1.6.3.13.1.3, length: 9
491      */
492 
493 
494     int
495 
496 
497 
498 
499 
500 
501 
502 
503 
504 
505 
506 
507 
508 
509 
510         snmpNotifyFilterTable_undo_setup(snmpNotifyFilterTable_rowreq_ctx *
511                                          rowreq_ctx);
512     int
513 
514 
515 
516 
517 
518 
519 
520 
521 
522 
523 
524 
525 
526 
527 
528         snmpNotifyFilterTable_undo_cleanup(snmpNotifyFilterTable_rowreq_ctx
529                                            * rowreq_ctx);
530     int
531 
532 
533 
534 
535 
536 
537 
538 
539 
540 
541 
542 
543 
544 
545 
546         snmpNotifyFilterTable_undo(snmpNotifyFilterTable_rowreq_ctx *
547                                    rowreq_ctx);
548     int
549 
550 
551 
552 
553 
554 
555 
556 
557 
558 
559 
560 
561 
562 
563 
564         snmpNotifyFilterTable_commit(snmpNotifyFilterTable_rowreq_ctx *
565                                      rowreq_ctx);
566     int
567 
568 
569 
570 
571 
572 
573 
574 
575 
576 
577 
578 
579 
580 
581 
582         snmpNotifyFilterTable_undo_commit(snmpNotifyFilterTable_rowreq_ctx
583                                           * rowreq_ctx);
584 
585 
586     int
587 
588 
589 
590 
591 
592 
593 
594 
595 
596 
597 
598 
599 
600 
601 
602         snmpNotifyFilterMask_check_value(snmpNotifyFilterTable_rowreq_ctx *
603                                          rowreq_ctx, char
604                                          *snmpNotifyFilterMask_val_ptr,
605                                          size_t
606                                          snmpNotifyFilterMask_val_ptr_len);
607     int
608 
609 
610 
611 
612 
613 
614 
615 
616 
617 
618 
619 
620 
621 
622 
623         snmpNotifyFilterMask_undo_setup(snmpNotifyFilterTable_rowreq_ctx *
624                                         rowreq_ctx);
625     int
626 
627 
628 
629 
630 
631 
632 
633 
634 
635 
636 
637 
638 
639 
640 
641         snmpNotifyFilterMask_set(snmpNotifyFilterTable_rowreq_ctx *
642                                  rowreq_ctx,
643                                  char *snmpNotifyFilterMask_val_ptr,
644                                  size_t snmpNotifyFilterMask_val_ptr_len);
645     int
646 
647 
648 
649 
650 
651 
652 
653 
654 
655 
656 
657 
658 
659 
660 
661         snmpNotifyFilterMask_undo(snmpNotifyFilterTable_rowreq_ctx *
662                                   rowreq_ctx);
663 
664     int
665 
666 
667 
668 
669 
670 
671 
672 
673 
674 
675 
676 
677 
678 
679 
680         snmpNotifyFilterType_check_value(snmpNotifyFilterTable_rowreq_ctx *
681                                          rowreq_ctx,
682                                          u_long snmpNotifyFilterType_val);
683     int
684 
685 
686 
687 
688 
689 
690 
691 
692 
693 
694 
695 
696 
697 
698 
699         snmpNotifyFilterType_undo_setup(snmpNotifyFilterTable_rowreq_ctx *
700                                         rowreq_ctx);
701     int
702 
703 
704 
705 
706 
707 
708 
709 
710 
711 
712 
713 
714 
715 
716 
717         snmpNotifyFilterType_set(snmpNotifyFilterTable_rowreq_ctx *
718                                  rowreq_ctx,
719                                  u_long snmpNotifyFilterType_val);
720     int
721 
722 
723 
724 
725 
726 
727 
728 
729 
730 
731 
732 
733 
734 
735 
736         snmpNotifyFilterType_undo(snmpNotifyFilterTable_rowreq_ctx *
737                                   rowreq_ctx);
738 
739     int
740 
741 
742 
743 
744 
745 
746 
747 
748 
749 
750 
751 
752 
753 
754 
755         snmpNotifyFilterStorageType_check_value
756         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx,
757          u_long snmpNotifyFilterStorageType_val);
758     int
759 
760 
761 
762 
763 
764 
765 
766 
767 
768 
769 
770 
771 
772 
773 
774         snmpNotifyFilterStorageType_undo_setup
775         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx);
776     int
777 
778 
779 
780 
781 
782 
783 
784 
785 
786 
787 
788 
789 
790 
791 
792         snmpNotifyFilterStorageType_set(snmpNotifyFilterTable_rowreq_ctx *
793                                         rowreq_ctx,
794                                         u_long
795                                         snmpNotifyFilterStorageType_val);
796     int
797 
798 
799 
800 
801 
802 
803 
804 
805 
806 
807 
808 
809 
810 
811 
812         snmpNotifyFilterStorageType_undo(snmpNotifyFilterTable_rowreq_ctx *
813                                          rowreq_ctx);
814 
815     int
816 
817 
818 
819 
820 
821 
822 
823 
824 
825 
826 
827 
828 
829 
830 
831         snmpNotifyFilterRowStatus_check_value
832         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx,
833          u_long snmpNotifyFilterRowStatus_val);
834     int
835 
836 
837 
838 
839 
840 
841 
842 
843 
844 
845 
846 
847 
848 
849 
850         snmpNotifyFilterRowStatus_undo_setup
851         (snmpNotifyFilterTable_rowreq_ctx * rowreq_ctx);
852     int
853 
854 
855 
856 
857 
858 
859 
860 
861 
862 
863 
864 
865 
866 
867 
868         snmpNotifyFilterRowStatus_set(snmpNotifyFilterTable_rowreq_ctx *
869                                       rowreq_ctx,
870                                       u_long
871                                       snmpNotifyFilterRowStatus_val);
872     int
873 
874 
875 
876 
877 
878 
879 
880 
881 
882 
883 
884 
885 
886 
887 
888         snmpNotifyFilterRowStatus_undo(snmpNotifyFilterTable_rowreq_ctx *
889                                        rowreq_ctx);
890 
891 
892     int
893 
894 
895 
896 
897 
898 
899 
900 
901 
902 
903 
904 
905 
906 
907 
908         snmpNotifyFilterTable_check_dependencies
909         (snmpNotifyFilterTable_rowreq_ctx * ctx);
910 
911 
912     /*
913      * DUMMY markers, ignore
914      *
915      * TODO:099:x: *************************************************************
916      * TODO:199:x: *************************************************************
917      * TODO:299:x: *************************************************************
918      * TODO:399:x: *************************************************************
919      * TODO:499:x: *************************************************************
920      */
921 
922 #ifdef __cplusplus
923 }
924 #endif
925 #endif                          /* SNMPNOTIFYFILTERTABLE_H */
926 /**  @} */
927 
928