← Back to branch summary

~ubuntu-branches/ubuntu/wily/net-snmp/wily-proposed

« back to all changes in this revision

Viewing changes to man/netsnmp_table_container.3

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-06-28 14:59:36 UTC
  • mfrom: (1.2.3 upstream) (1.1.12 sid)
  • Revision ID: james.westby@ubuntu.com-20100628145936-cbiallic69pn044g
Tags: 5.4.3~dfsg-1ubuntu1
https://launchpad.net/bugs/104738
https://launchpad.net/bugs/254261
https://launchpad.net/bugs/250459
https://launchpad.net/bugs/589056
https://launchpad.net/bugs/573391
https://launchpad.net/bugs/533603
* Merge from debian unstable.  Remaining changes:
  - Set Ubuntu maintainer address.
  - net-snmp-config: Use bash. (LP: #104738)
  - Removed multiuser option when calling update-rc.d. (LP: #254261)
  - debian/snmpd.init: LSBify the init script.
  - debian/patches/52_fix_snmpcmd_1_typo.patch: Adjust a typo in snmpcmd.1
    (LP: #250459)
  - debian/snmpd.postinst: source debconf before doing work, LP: #589056
  - debian/snmp.preinst, debian/snmp.prerm: kill any/all processes owned by
    snmp user before install/uninstall, LP: #573391
  - Add apport hook (LP: #533603):
  - debian/{snmp,snmpd}.apport: Added.
  - debian/control: Build-depends on dh-apport.
  - debian/rules: 
    + Add --with apport.
    + override_dh_apport to install hook on snmpd package only.
 * Dropped patches:
   - debian/patches/99-fix-ubuntu-div0.patch: Fix dvision by zero.. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_table_container.3
1
 
.TH "table_container" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "table_container" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
table_container \- Helps you implement a table when data can be found via a netsnmp_container.  
 
5
table_container \- 
 
6
.PP
 
7
Helps you implement a table when data can be found via a netsnmp_container.  
6
8
 
7
 
.PP
8
9
.SS "Functions"
9
10
 
10
11
.in +1c
35
36
.br
36
37
.RI "\fIretrieve the container used by the table_container helper \fP"
37
38
.ti -1c
38
 
.RI "void * \fBnetsnmp_container_table_row_extract\fP (\fBnetsnmp_request_info\fP *request)"
39
 
.br
40
 
.RI "\fIfind the context data used by the table_container helper \fP"
41
 
.ti -1c
42
 
.RI "void * \fBnetsnmp_container_table_extract_context\fP (\fBnetsnmp_request_info\fP *request)"
43
 
.br
44
 
.RI "\fIfind the context data used by the table_container helper \fP"
45
 
.ti -1c
46
39
.RI "void \fBnetsnmp_container_table_row_insert\fP (\fBnetsnmp_request_info\fP *request, \fBnetsnmp_index\fP *row)"
47
40
.br
48
41
.RI "\fIinserts a newly created table_container entry into a request list \fP"
54
47
.SH "Detailed Description"
55
48
.PP 
56
49
Helps you implement a table when data can be found via a netsnmp_container. 
57
 
.PP
 
50
 
58
51
The table_container handler is used (automatically) in conjuntion with the \fBtable\fP handler.
59
52
.PP
60
53
This handler will use the index information provided by the \fBtable\fP handler to find the row needed to process the request.
65
58
.PP
66
59
TABLE_CONTAINER_KEY_NETSNMP_INDEX The container should do comparisons based on a key that may be cast to a netsnmp index (netsnmp_index *). This index contains only the index portion of the OID, not the entire OID.
67
60
.PP
68
 
TABLE_CONTAINER_KEY_VARBIND_INDEX The container should do comparisons based on a key that may be cast to a netsnmp variable list (netsnmp_variable_list *). This variable list will contain one varbind for each index component.
 
61
TABLE_CONTAINER_KEY_VARBIND_INDEX The container should do comparisons based on a key that may be cast to a netsnmp \fBvariable\fP list (netsnmp_variable_list *). This \fBvariable\fP list will contain one varbind for each index component.
69
62
.PP
70
63
TABLE_CONTAINER_KEY_VARBIND_RAW (NOTE: unimplemented) While not yet implemented, future plans include passing the request varbind with the full OID to a container.
71
64
.PP
95
88
retrieve the container used by the table_container helper 
96
89
.PP
97
90
Definition at line 320 of file table_container.c.
98
 
.PP
99
 
References netsnmp_request_get_list_data().
100
 
.SS "void* netsnmp_container_table_extract_context (\fBnetsnmp_request_info\fP * request)"
101
 
.PP
102
 
find the context data used by the table_container helper 
103
 
.PP
104
 
Definition at line 339 of file table_container.c.
105
 
.PP
106
 
References netsnmp_request_get_list_data().
107
91
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_container_table_handler_get (\fBnetsnmp_table_registration_info\fP * tabreg, \fBnetsnmp_container\fP * container, char key_type)"
108
92
.PP
109
93
returns a netsnmp_mib_handler object for the table_container helper 
110
94
.PP
111
95
Definition at line 254 of file table_container.c.
112
 
.PP
113
 
References netsnmp_container_s::compare, netsnmp_mib_handler_s::flags, container_table_data_s::key_type, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_container_s::ncompare, netsnmp_create_handler(), NULL, snmp_log(), SNMP_MALLOC_TYPEDEF, container_table_data_s::table, and container_table_data_s::tblreg_info.
114
 
.PP
115
 
Referenced by netsnmp_container_table_register().
116
 
.SS "void* netsnmp_container_table_row_extract (\fBnetsnmp_request_info\fP * request)"
117
 
.PP
118
 
find the context data used by the table_container helper 
119
 
.PP
120
 
Definition at line 329 of file table_container.c.
121
 
.PP
122
 
References netsnmp_request_get_list_data().
123
 
.PP
124
 
Referenced by _netsnmp_tdata_helper_handler(), and netsnmp_tdata_extract_row().
125
96
.SS "void netsnmp_container_table_row_insert (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_index\fP * row)"
126
97
.PP
127
98
inserts a newly created table_container entry into a request list 
128
99
.PP
129
100
Definition at line 351 of file table_container.c.
130
 
.PP
131
 
References build_oid_noalloc(), netsnmp_table_request_info_s::indexes, netsnmp_create_data_list(), netsnmp_extract_table_info(), netsnmp_request_add_list_data(), netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::prev, netsnmp_request_info_s::processed, and snmp_oid_compare().
132
 
.PP
133
 
Referenced by netsnmp_insert_tdata_row().
134
101
.SS "\fBnetsnmp_index\fP* netsnmp_table_index_find_next_row (\fBnetsnmp_container\fP * c, \fBnetsnmp_table_request_info\fP * tblreq)"
135
102
.PP
136
 
deprecated, backwards compatability only 
137
 
.PP
138
 
expected impact to remove: none
 
103
deprecated, backwards compatability only expected impact to remove: none
139
104
.IP "\(bu" 2
140
105
used between helpers, shouldn't have been used by end users
141
106
.PP
147
112
 
148
113
.PP
149
114
Definition at line 721 of file table_container.c.
150
 
.PP
151
 
References NULL.
 
115
.SH "Author"
 
116
.PP 
 
117
Generated automatically by Doxygen for net-snmp from the source code.