← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/net-snmp/intrepid-updates

« back to all changes in this revision

Viewing changes to man/netsnmp_netsnmp_iterator_info_s.3

  • Committer: Bazaar Package Importer
  • Author(s): Scott James Remnant
  • Date: 2006-11-28 12:29:34 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20061128122934-82xxzy2zcvypnvy7
Tags: 5.2.3-4ubuntu1
* Merge from debian unstable, remaining changes:
  - remove stop links from rc0 and rc6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_netsnmp_iterator_info_s.3
1
 
.TH "netsnmp_iterator_info_s" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" \" -*- nroff -*-
 
1
.TH "netsnmp_iterator_info_s" 3 "14 Jul 2006" "Version 5.2.3" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
20
20
.ti -1c
21
21
.RI "\fBNetsnmp_Next_Data_Point\fP * \fBget_next_data_point\fP"
22
22
.br
23
 
.RI "\fIGiven the previous loop context, this should return the next loop context, assiocated index set and optionally a data context. \fP"
 
23
.RI "\fIGiven the previous loop context, this should return the next loop context, associated index set and optionally a data context. \fP"
24
24
.ti -1c
25
25
.RI "\fBNetsnmp_Make_Data_Context\fP * \fBmake_data_context\fP"
26
26
.br
53
53
.PP 
54
54
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. 
55
55
 
56
 
The netsnmp_iterator_info typedef can be used instead of directly calling this struct if you would prefer.
 
56
The netsnmp_iterator_info typedef can be used instead of directly calling this struct if you would prefer. 
57
57
.PP
58
58
Definition at line 67 of file table_iterator.h.
59
59
.SH "Field Documentation"
65
65
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. 
66
66
.PP
67
67
Definition at line 96 of file table_iterator.h.
68
 
.PP
69
 
Referenced by netsnmp_table_iterator_helper_handler().
70
68
.SS "\fBNetsnmp_Free_Loop_Context\fP* \fBnetsnmp_iterator_info_s::free_loop_context\fP"
71
69
.PP
72
70
A function which should free the loop context. 
74
72
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. 
75
73
.PP
76
74
Definition at line 89 of file table_iterator.h.
77
 
.PP
78
 
Referenced by netsnmp_table_iterator_helper_handler().
79
75
.SS "\fBNetsnmp_Free_Loop_Context\fP* \fBnetsnmp_iterator_info_s::free_loop_context_at_end\fP"
80
76
.PP
81
77
Frees a loop context at the end of the entire iteration sequence. 
83
79
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 
84
80
.PP
85
81
Definition at line 104 of file table_iterator.h.
86
 
.PP
87
 
Referenced by netsnmp_table_iterator_helper_handler().
88
82
.SS "\fBNetsnmp_First_Data_Point\fP* \fBnetsnmp_iterator_info_s::get_first_data_point\fP"
89
83
.PP
90
84
Responsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer. 
94
88
Referenced by netsnmp_table_iterator_helper_handler().
95
89
.SS "\fBNetsnmp_Next_Data_Point\fP* \fBnetsnmp_iterator_info_s::get_next_data_point\fP"
96
90
.PP
97
 
Given the previous loop context, this should return the next loop context, assiocated index set and optionally a data context. 
 
91
Given the previous loop context, this should return the next loop context, associated index set and optionally a data context. 
98
92
.PP
99
93
Definition at line 76 of file table_iterator.h.
100
94
.PP