user/net-snmp/man/netsnmp_netsnmp_iterator_info_s.3

   1 .TH "netsnmp_iterator_info_s" 3 "23 Sep 2009" "Version 5.5" "net-snmp" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 netsnmp_iterator_info_s \-
   6 .PP
   7 Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 .PP
  13 \fC#include <table_iterator.h>\fP
  14 .SS "Data Fields"
  15
  16 .in +1c
  17 .ti -1c
  18 .RI "Netsnmp_First_Data_Point * \fBget_first_data_point\fP"
  19 .br
  20 .RI "\fIResponsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer. \fP"
  21 .ti -1c
  22 .RI "Netsnmp_Next_Data_Point * \fBget_next_data_point\fP"
  23 .br
  24 .RI "\fIGiven the previous loop context, this should return the next loop context, associated index set and optionally a data context. \fP"
  25 .ti -1c
  26 .RI "Netsnmp_Make_Data_Context * \fBmake_data_context\fP"
  27 .br
  28 .RI "\fIIf a data context wasn't supplied by the get_first_data_point or get_next_data_point functions and the make_data_context pointer is defined, it will be called to convert a loop context into a data context. \fP"
  29 .ti -1c
  30 .RI "Netsnmp_Free_Loop_Context * \fBfree_loop_context\fP"
  31 .br
  32 .RI "\fIA function which should free the loop context. \fP"
  33 .ti -1c
  34 .RI "Netsnmp_Free_Data_Context * \fBfree_data_context\fP"
  35 .br
  36 .RI "\fIFrees a data context. \fP"
  37 .ti -1c
  38 .RI "Netsnmp_Free_Loop_Context * \fBfree_loop_context_at_end\fP"
  39 .br
  40 .RI "\fIFrees a loop context at the end of the entire iteration sequence. \fP"
  41 .ti -1c
  42 .RI "void * \fBmyvoid\fP"
  43 .br
  44 .RI "\fIThis can be used by client handlers to store any information they need. \fP"
  45 .ti -1c
  46 .RI "int \fBflags\fP"
  47 .br
  48 .ti -1c
  49 .RI "\fBnetsnmp_table_registration_info\fP * \fBtable_reginfo\fP"
  50 .br
  51 .RI "\fIA pointer to the netsnmp_table_registration_info object this iterator is registered along with. \fP"
  52 .ti -1c
  53 .RI "Netsnmp_First_Data_Point * \fBget_row_indexes\fP"
  54 .br
  55 .ti -1c
  56 .RI "\fBnetsnmp_variable_list\fP * \fBindexes\fP"
  57 .br
  58 .in -1c
  59 .SH "Detailed Description"
  60 .PP
  61 Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
  62
  63 The netsnmp_iterator_info typedef can be used instead of directly calling this struct if you would prefer.
  64 .PP
  65 Definition at line 53 of file table_iterator.h.
  66 .SH "Field Documentation"
  67 .PP
  68 .SS "Netsnmp_Free_Data_Context* \fBnetsnmp_iterator_info_s::free_data_context\fP"
  69 .PP
  70 Frees a data context. This will be called at any time a data context needs to be freed. This may be at the same time as a correspondng loop context is freed, or much much later. Multiple data contexts may be kept in existence at any time.
  71 .PP
  72 Definition at line 82 of file table_iterator.h.
  73 .SS "Netsnmp_Free_Loop_Context* \fBnetsnmp_iterator_info_s::free_loop_context\fP"
  74 .PP
  75 A function which should free the loop context. This function is called at *each* iteration step, which is not-optimal for speed purposes. The use of free_loop_context_at_end instead is strongly encouraged. This can be set to NULL to avoid its usage.
  76 .PP
  77 Definition at line 75 of file table_iterator.h.
  78 .SS "Netsnmp_Free_Loop_Context* \fBnetsnmp_iterator_info_s::free_loop_context_at_end\fP"
  79 .PP
  80 Frees a loop context at the end of the entire iteration sequence. Generally, this would free the loop context allocated by the get_first_data_point function (which would then be updated by each call to the get_next_data_point function). It is not called until the get_next_data_point function returns a NULL
  81 .PP
  82 Definition at line 90 of file table_iterator.h.
  83 .SS "Netsnmp_First_Data_Point* \fBnetsnmp_iterator_info_s::get_first_data_point\fP"
  84 .PP
  85 Responsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer.
  86 .PP
  87 Definition at line 57 of file table_iterator.h.
  88 .SS "Netsnmp_Next_Data_Point* \fBnetsnmp_iterator_info_s::get_next_data_point\fP"
  89 .PP
  90 Given the previous loop context, this should return the next loop context, associated index set and optionally a data context.
  91 .PP
  92 Definition at line 62 of file table_iterator.h.
  93 .SS "Netsnmp_Make_Data_Context* \fBnetsnmp_iterator_info_s::make_data_context\fP"
  94 .PP
  95 If a data context wasn't supplied by the get_first_data_point or get_next_data_point functions and the make_data_context pointer is defined, it will be called to convert a loop context into a data context.
  96 .PP
  97 Definition at line 68 of file table_iterator.h.
  98 .SS "void* \fBnetsnmp_iterator_info_s::myvoid\fP"
  99 .PP
 100 This can be used by client handlers to store any information they need.
 101 .PP
 102 Definition at line 94 of file table_iterator.h.
 103 .SS "\fBnetsnmp_table_registration_info\fP* \fBnetsnmp_iterator_info_s::table_reginfo\fP"
 104 .PP
 105 A pointer to the netsnmp_table_registration_info object this iterator is registered along with.
 106 .PP
 107 Definition at line 100 of file table_iterator.h.
 108
 109 .SH "Author"
 110 .PP
 111 Generated automatically by Doxygen for net-snmp from the source code.