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

« back to all changes in this revision

Viewing changes to man/netsnmp_variable_list.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
* 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:
1
 
.TH "variable_list" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "variable_list" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
variable_list \- The netsnmp variable list binding structure, it's typedef'd to netsnmp_variable_list.  
 
5
variable_list \- 
 
6
.PP
 
7
The netsnmp \fBvariable\fP list binding structure, it's typedef'd to netsnmp_variable_list.  
6
8
 
7
 
.PP
8
9
.SH SYNOPSIS
9
10
.br
10
11
.PP
 
12
.PP
11
13
\fC#include <snmp_api.h>\fP
12
 
.PP
13
14
.SS "Data Fields"
14
15
 
15
16
.in +1c
16
17
.ti -1c
17
 
.RI "\fBvariable_list\fP * \fBnext_variable\fP"
 
18
.RI "struct \fBvariable_list\fP * \fBnext_variable\fP"
18
19
.br
19
 
.RI "\fINULL for last variable. \fP"
 
20
.RI "\fINULL for last \fBvariable\fP. \fP"
20
21
.ti -1c
21
22
.RI "oid * \fBname\fP"
22
23
.br
23
 
.RI "\fIObject identifier of variable. \fP"
 
24
.RI "\fIObject identifier of \fBvariable\fP. \fP"
24
25
.ti -1c
25
26
.RI "size_t \fBname_length\fP"
26
27
.br
28
29
.ti -1c
29
30
.RI "u_char \fBtype\fP"
30
31
.br
31
 
.RI "\fIASN type of variable. \fP"
 
32
.RI "\fIASN type of \fBvariable\fP. \fP"
32
33
.ti -1c
33
34
.RI "\fBnetsnmp_vardata\fP \fBval\fP"
34
35
.br
35
 
.RI "\fIvalue of variable \fP"
 
36
.RI "\fIvalue of \fBvariable\fP \fP"
36
37
.ti -1c
37
38
.RI "size_t \fBval_len\fP"
38
39
.br
40
41
.ti -1c
41
42
.RI "oid \fBname_loc\fP [MAX_OID_LEN]"
42
43
.br
43
 
.RI "\fI90 percentile < 24. \fP"
 
44
.RI "\fIbuffer to hold the OID \fP"
44
45
.ti -1c
45
46
.RI "u_char \fBbuf\fP [40]"
46
47
.br
59
60
.in -1c
60
61
.SH "Detailed Description"
61
62
.PP 
62
 
The netsnmp variable list binding structure, it's typedef'd to netsnmp_variable_list. 
 
63
The netsnmp \fBvariable\fP list binding structure, it's typedef'd to netsnmp_variable_list. 
63
64
.PP
64
65
\fBExamples: \fP
65
66
.in +1c
69
70
Definition at line 522 of file snmp_api.h.
70
71
.SH "Field Documentation"
71
72
.PP 
72
 
.SS "struct \fBvariable_list\fP* \fBvariable_list::next_variable\fP"
73
 
.PP
74
 
NULL for last variable. 
75
 
.PP
76
 
Definition at line 524 of file snmp_api.h.
77
 
.PP
78
 
Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_noalloc(), check_acm(), convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), count_varbinds(), count_varbinds_of_type(), find_varbind_in_list(), find_varbind_of_type(), handle_getnext_loop(), handle_pdu(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_config_parse_add_row(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_query_walk(), netsnmp_send_traps(), netsnmp_wrap_up_request(), parse_oid_indexes(), snmp_clone_var(), snmp_free_varbind(), snmp_pdu_build(), snmp_pdu_parse(), snmp_replace_var_types(), snmp_reset_var_buffers(), snmp_varbind_len(), snmp_varlist_add_variable(), and table_helper_handler().
 
73
.SS "u_char \fBvariable_list::buf\fP[40]"
 
74
.PP
 
75
90 percentile < 40. 
 
76
.PP
 
77
Definition at line 538 of file snmp_api.h.
 
78
.SS "void* \fBvariable_list::data\fP"
 
79
.PP
 
80
(Opaque) hook for additional data 
 
81
.PP
 
82
Definition at line 540 of file snmp_api.h.
 
83
.SS "void(* \fBvariable_list::dataFreeHook\fP)(void *)"
 
84
.PP
 
85
callback to free above 
79
86
.SS "oid* \fBvariable_list::name\fP"
80
87
.PP
81
 
Object identifier of variable. 
 
88
Object identifier of \fBvariable\fP. 
82
89
.PP
83
90
Definition at line 526 of file snmp_api.h.
84
 
.PP
85
 
Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), dump_idx_registry(), find_varbind_in_list(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_bulk_to_next_helper(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_old_api_helper(), netsnmp_query_walk(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_build_result(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), snmp_clone_var(), snmp_free_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_objid(), and snmpv3_get_report_type().
86
91
.SS "size_t \fBvariable_list::name_length\fP"
87
92
.PP
88
93
number of subid's in name 
89
94
.PP
90
95
Definition at line 528 of file snmp_api.h.
91
 
.PP
92
 
Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), dump_idx_registry(), find_varbind_in_list(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_bulk_to_next_helper(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_old_api_helper(), netsnmp_query_walk(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), snmp_clone_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_objid(), and snmpv3_get_report_type().
 
96
.SS "oid \fBvariable_list::name_loc\fP[MAX_OID_LEN]"
 
97
.PP
 
98
buffer to hold the OID 
 
99
.PP
 
100
Definition at line 536 of file snmp_api.h.
 
101
.SS "struct \fBvariable_list\fP* \fBvariable_list::next_variable\fP\fC [read]\fP"
 
102
.PP
 
103
NULL for last \fBvariable\fP. 
 
104
.PP
 
105
Definition at line 524 of file snmp_api.h.
93
106
.SS "u_char \fBvariable_list::type\fP"
94
107
.PP
95
 
ASN type of variable. 
 
108
ASN type of \fBvariable\fP. 
96
109
.PP
97
110
\fBExamples: \fP
98
111
.in +1c
99
112
\fBdelayed_instance.c\fP.
100
113
.PP
101
114
Definition at line 530 of file snmp_api.h.
102
 
.PP
103
 
Referenced by _fix_endofmibview(), _request_set_error(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), count_varbinds_of_type(), dump_idx_registry(), find_varbind_of_type(), handle_pdu(), netsnmp_add_varbind_to_cache(), netsnmp_bulk_to_next_fix_requests(), netsnmp_check_getnext_reply(), netsnmp_config_parse_add_row(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_reassign_requests(), netsnmp_scalar_group_helper_handler(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), parse_one_oid_index(), snmp_pdu_build(), snmp_pdu_parse(), snmp_replace_var_types(), snmp_set_var_typed_integer(), snmp_set_var_typed_value(), snmp_set_var_value(), snmp_varlist_add_variable(), sprint_realloc_bitstring(), sprint_realloc_by_type(), sprint_realloc_counter(), sprint_realloc_counter64(), sprint_realloc_gauge(), sprint_realloc_integer(), sprint_realloc_ipaddress(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_null(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), sprint_realloc_uinteger(), sprint_realloc_value(), sprint_realloc_variable(), and table_helper_handler().
104
115
.SS "\fBnetsnmp_vardata\fP \fBvariable_list::val\fP"
105
116
.PP
106
 
value of variable 
 
117
value of \fBvariable\fP 
107
118
.PP
108
119
\fBExamples: \fP
109
120
.in +1c
110
121
\fBdelayed_instance.c\fP.
111
122
.PP
112
123
Definition at line 532 of file snmp_api.h.
113
 
.PP
114
 
Referenced by build_oid_segment(), convert_v2pdu_to_v1(), dump_idx_registry(), netsnmp_check_getnext_reply(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), parse_one_oid_index(), snmp_clone_var(), snmp_free_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_value(), sprint_realloc_bitstring(), sprint_realloc_counter(), sprint_realloc_counter64(), sprint_realloc_gauge(), sprint_realloc_integer(), sprint_realloc_ipaddress(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), and sprint_realloc_uinteger().
115
124
.SS "size_t \fBvariable_list::val_len\fP"
116
125
.PP
117
126
the length of the value to be copied into buf 
118
127
.PP
119
128
Definition at line 534 of file snmp_api.h.
120
 
.PP
121
 
Referenced by build_oid_segment(), convert_v2pdu_to_v1(), dump_idx_registry(), netsnmp_check_getnext_reply(), netsnmp_stash_cache_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), parse_one_oid_index(), snmp_clone_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_value(), sprint_realloc_bitstring(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), and sprint_realloc_opaque().
122
 
.SS "oid \fBvariable_list::name_loc\fP[MAX_OID_LEN]"
123
 
.PP
124
 
90 percentile < 24. 
125
 
.PP
126
 
Definition at line 536 of file snmp_api.h.
127
 
.PP
128
 
Referenced by build_oid_segment(), netsnmp_table_build_oid_from_index(), netsnmp_table_build_result(), snmp_free_var(), snmp_reset_var_buffers(), and snmp_set_var_objid().
129
 
.SS "u_char \fBvariable_list::buf\fP[40]"
130
 
.PP
131
 
90 percentile < 40. 
132
 
.PP
133
 
Definition at line 538 of file snmp_api.h.
134
 
.PP
135
 
Referenced by snmp_clone_var(), snmp_free_var(), snmp_pdu_parse(), snmp_reset_var_buffers(), and snmp_set_var_value().
136
 
.SS "void* \fBvariable_list::data\fP"
137
 
.PP
138
 
(Opaque) hook for additional data 
139
 
.PP
140
 
Definition at line 540 of file snmp_api.h.
141
 
.PP
142
 
Referenced by snmp_clone_var(), snmp_free_var(), and snmp_pdu_parse().
143
 
.SS "void(* \fBvariable_list::dataFreeHook\fP)(void *)"
144
 
.PP
145
 
callback to free above 
146
 
.PP
147
 
Referenced by snmp_clone_var(), snmp_free_var(), and snmp_pdu_parse().
148
129
 
149
130
.SH "Author"
150
131
.PP