table_iterator.h

Introduction

@addtogroup table_iterator @{

Typedefs

struct netsnmp_iterator_info_s netsnmp_iterator_info

/** @struct netsnmp_iterator_info_s

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.

The netsnmp_iterator_info typedef can be used instead of directly calling this struct if you would prefer.
    */
typedef struct netsnmp_iterator_info_s { 
    /** Responsible for: returning the first set of "index" data, a
loop-context pointer, and optionally a data context
        */
    Netsnmp_First_Data_Point *get_first_data_point;  
    /** Given the previous loop context, this should return the
next loop context, assiocated index set and optionally a
        */
    Netsnmp_Next_Data_Point *get_next_data_point;  
    /** 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
        */
    Netsnmp_Make_Data_Context *make_data_context;  
    /** 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
        */
    Netsnmp_Free_Loop_Context *free_loop_context;  
    /** 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
        */
    Netsnmp_Free_Data_Context *free_data_context;  
    /** 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
        */
    Netsnmp_Free_Loop_Context *free_loop_context_at_end;  
    /** This can be used by client handlers to store any
        */
    void *myvoid; 
    int flags; 
    #define NETSNMP_ITERATOR_FLAG_SORTED 0x01  /** A pointer to the netsnmp_table_registration_info object
        */
    netsnmp_table_registration_info *table_reginfo; 
} netsnmp_iterator_info;  

Discussion

* Typedefs the netsnmp_iterator_info_s struct into netsnmp_iterator_info

netsnmp_iterator_info

/** @struct netsnmp_iterator_info_s

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.

The netsnmp_iterator_info typedef can be used instead of directly calling this struct if you would prefer.
    */
typedef struct netsnmp_iterator_info_s { 
    /** Responsible for: returning the first set of "index" data, a
loop-context pointer, and optionally a data context
        */
    Netsnmp_First_Data_Point *get_first_data_point;  
    /** Given the previous loop context, this should return the
next loop context, assiocated index set and optionally a
        */
    Netsnmp_Next_Data_Point *get_next_data_point;  
    /** 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
        */
    Netsnmp_Make_Data_Context *make_data_context;  
    /** 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
        */
    Netsnmp_Free_Loop_Context *free_loop_context;  
    /** 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
        */
    Netsnmp_Free_Data_Context *free_data_context;  
    /** 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
        */
    Netsnmp_Free_Loop_Context *free_loop_context_at_end;  
    /** This can be used by client handlers to store any
        */
    void *myvoid; 
    int flags; 
    #define NETSNMP_ITERATOR_FLAG_SORTED 0x01  /** A pointer to the netsnmp_table_registration_info object
        */
    netsnmp_table_registration_info *table_reginfo; 
} netsnmp_iterator_info;  

Discussion

* Typedefs the netsnmp_iterator_info_s struct into netsnmp_iterator_info