SNMP编程

开发平台：
Unix_Linux

netsnmp_netsnmp_iterator_info_s.3：源码内容
							.TH "netsnmp_iterator_info_s" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
.ad l
.nh
.SH NAME
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.  
.PP
.SH SYNOPSIS
.br
.PP
fC#include <table_iterator.h>fP
.PP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "fBNetsnmp_First_Data_PointfP * fBget_first_data_pointfP"
.br
.RI "fIResponsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer. fP"
.ti -1c
.RI "fBNetsnmp_Next_Data_PointfP * fBget_next_data_pointfP"
.br
.RI "fIGiven the previous loop context, this should return the next loop context, assiocated index set and optionally a data context. fP"
.ti -1c
.RI "fBNetsnmp_Make_Data_ContextfP * fBmake_data_contextfP"
.br
.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"
.ti -1c
.RI "fBNetsnmp_Free_Loop_ContextfP * fBfree_loop_contextfP"
.br
.RI "fIA function which should free the loop context. fP"
.ti -1c
.RI "fBNetsnmp_Free_Data_ContextfP * fBfree_data_contextfP"
.br
.RI "fIFrees a data context. fP"
.ti -1c
.RI "fBNetsnmp_Free_Loop_ContextfP * fBfree_loop_context_at_endfP"
.br
.RI "fIFrees a loop context at the end of the entire iteration sequence. fP"
.ti -1c
.RI "void * fBmyvoidfP"
.br
.RI "fIThis can be used by client handlers to store any information they need. fP"
.ti -1c
.RI "int fBflagsfP"
.br
.ti -1c
.RI "fBnetsnmp_table_registration_infofP * fBtable_reginfofP"
.br
.RI "fIA pointer to the netsnmp_table_registration_info object this iterator is registered along with. fP"
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
Definition at line 67 of file table_iterator.h.
.SH "Field Documentation"
.PP 
.SS "fBNetsnmp_Free_Data_ContextfP* fBnetsnmp_iterator_info_s::free_data_contextfP"
.PP
Frees a data context. 
.PP
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. 
.PP
Definition at line 96 of file table_iterator.h.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "fBNetsnmp_Free_Loop_ContextfP* fBnetsnmp_iterator_info_s::free_loop_contextfP"
.PP
A function which should free the loop context. 
.PP
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. 
.PP
Definition at line 89 of file table_iterator.h.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "fBNetsnmp_Free_Loop_ContextfP* fBnetsnmp_iterator_info_s::free_loop_context_at_endfP"
.PP
Frees a loop context at the end of the entire iteration sequence. 
.PP
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 
.PP
Definition at line 104 of file table_iterator.h.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "fBNetsnmp_First_Data_PointfP* fBnetsnmp_iterator_info_s::get_first_data_pointfP"
.PP
Responsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer. 
.PP
Definition at line 71 of file table_iterator.h.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "fBNetsnmp_Next_Data_PointfP* fBnetsnmp_iterator_info_s::get_next_data_pointfP"
.PP
Given the previous loop context, this should return the next loop context, assiocated index set and optionally a data context. 
.PP
Definition at line 76 of file table_iterator.h.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "fBNetsnmp_Make_Data_ContextfP* fBnetsnmp_iterator_info_s::make_data_contextfP"
.PP
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. 
.PP
Definition at line 82 of file table_iterator.h.
.SS "void* fBnetsnmp_iterator_info_s::myvoidfP"
.PP
This can be used by client handlers to store any information they need. 
.PP
Definition at line 108 of file table_iterator.h.
.SS "fBnetsnmp_table_registration_infofP* fBnetsnmp_iterator_info_s::table_reginfofP"
.PP
A pointer to the netsnmp_table_registration_info object this iterator is registered along with. 
.PP
Definition at line 114 of file table_iterator.h.
.PP
Referenced by netsnmp_register_table_iterator(), and netsnmp_table_iterator_helper_handler().
.SH "Author"
.PP 
Generated automatically by Doxygen for net-snmp from the source code.

						