← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/netsnmp_row_merge.3

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-03-31 04:21:37 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050331042137-z0vw1grslj6cek9k
Tags: 5.1.2-6ubuntu2
Apply safe-but-hackish patch by Henrique de Moraes Holschuh to
fix the libdir in libsnmp5-dev's .la files (Ubuntu bug #8393)

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_row_merge.3
1
 
.TH "row_merge: Calls sub handlers with request for one row at a time." 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
 
1
.TH "row_merge: Calls sub handlers with request for one row at a time." 3 "7 Aug 2004" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
row_merge: Calls sub handlers with request for one row at a time. \- This helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers. 
6
 
More...
 
5
row_merge: Calls sub handlers with request for one row at a time. \- This helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers.  
 
6
 
 
7
.PP
 
8
.SS "Defines"
 
9
 
 
10
.in +1c
 
11
.ti -1c
 
12
.RI "#define \fBROW_MERGE_WAITING\fP   0"
 
13
.br
 
14
.ti -1c
 
15
.RI "#define \fBROW_MERGE_ACTIVE\fP   1"
 
16
.br
 
17
.ti -1c
 
18
.RI "#define \fBROW_MERGE_DONE\fP   2"
 
19
.br
 
20
.in -1c
7
21
.SS "Functions"
8
22
 
9
23
.in +1c
10
24
.ti -1c
11
25
.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_row_merge_handler\fP (int prefix_len)"
12
26
.br
13
 
.RI "\fIreturns a row_merge handler that can be injected into a given handler chain.\fP"
 
27
.RI "\fIreturns a row_merge handler that can be injected into a given handler chain. \fP"
14
28
.ti -1c
15
29
.RI "int \fBnetsnmp_register_row_merge\fP (\fBnetsnmp_handler_registration\fP *reginfo)"
16
30
.br
17
 
.RI "\fIfunctionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a row_merge handler at the same time for you.\fP"
 
31
.RI "\fIfunctionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a row_merge handler at the same time for you. \fP"
18
32
.ti -1c
19
 
.RI "int \fBnetsnmp_row_merge_helper_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)"
 
33
.RI "int \fBnetsnmp_row_merge_helper_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
20
34
.br
21
 
.RI "\fIImplements the row_merge handler.\fP"
 
35
.RI "\fIImplements the row_merge handler. \fP"
22
36
.ti -1c
23
37
.RI "void \fBnetsnmp_init_row_merge\fP (void)"
24
38
.br
25
 
.RI "\fIinitializes the row_merge helper which then registers a row_merge handler as a run-time injectable handler for configuration file use.\fP"
 
39
.RI "\fIinitializes the row_merge helper which then registers a row_merge handler as a run-time injectable handler for configuration file use. \fP"
26
40
.in -1c
27
 
.SH "DETAILED DESCRIPTION"
 
41
.SH "Detailed Description"
28
42
.PP 
29
 
This helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers.
30
 
.PP
31
 
This is useful for handlers that don't want to process multiple rows at the same time, but are happy to iterate through the request list for a single row. 
32
 
.SH "FUNCTION DOCUMENTATION"
 
43
This helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers. This is useful for handlers that don't want to process multiple rows at the same time, but are happy to iterate through the request list for a single row. 
 
44
.SH "Function Documentation"
33
45
.PP 
34
46
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_row_merge_handler (int prefix_len)"
35
47
.PP
36
 
returns a row_merge handler that can be injected into a given handler chain.
37
 
.PP
38
 
Definition at line 31 of file row_merge.c.
39
 
.PP
40
 
References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), and netsnmp_row_merge_helper_handler().
 
48
returns a row_merge handler that can be injected into a given handler chain. Definition at line 31 of file row_merge.c.
 
49
.PP
 
50
References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), and netsnmp_mib_handler.
41
51
.PP
42
52
Referenced by netsnmp_init_row_merge(), and netsnmp_register_row_merge().
43
53
.SS "void netsnmp_init_row_merge (void)"
44
54
.PP
45
 
initializes the row_merge helper which then registers a row_merge handler as a run-time injectable handler for configuration file use.
46
 
.PP
47
 
Definition at line 188 of file row_merge.c.
 
55
initializes the row_merge helper which then registers a row_merge handler as a run-time injectable handler for configuration file use. Definition at line 188 of file row_merge.c.
48
56
.PP
49
57
References netsnmp_get_row_merge_handler(), and netsnmp_register_handler_by_name().
50
58
.SS "int netsnmp_register_row_merge (\fBnetsnmp_handler_registration\fP * reginfo)"
51
59
.PP
52
 
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a row_merge handler at the same time for you.
53
 
.PP
54
 
Definition at line 45 of file row_merge.c.
55
 
.PP
56
 
References netsnmp_get_row_merge_handler(), netsnmp_inject_handler(), netsnmp_register_handler(), and netsnmp_handler_registration_s::rootoid_len.
57
 
.SS "int netsnmp_row_merge_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, netsnmp_agent_request_info * reqinfo, netsnmp_request_info * requests)"
58
 
.PP
59
 
Implements the row_merge handler.
60
 
.PP
61
 
Definition at line 58 of file row_merge.c.
62
 
.PP
63
 
References netsnmp_mib_handler_s::myvoid, variable_list::name, variable_list::name_length, netsnmp_call_next_handler(), netsnmp_request_info_s::next, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and snmp_oid_compare().
64
 
.PP
65
 
Referenced by netsnmp_get_row_merge_handler().
 
60
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a row_merge handler at the same time for you. Definition at line 45 of file row_merge.c.
 
61
.PP
 
62
References netsnmp_get_row_merge_handler(), netsnmp_handler_registration, netsnmp_inject_handler(), netsnmp_register_handler(), and netsnmp_handler_registration_s::rootoid_len.
 
63
.SS "int netsnmp_row_merge_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
 
64
.PP
 
65
Implements the row_merge handler. Definition at line 58 of file row_merge.c.
 
66
.PP
 
67
References netsnmp_mib_handler_s::myvoid, variable_list::name, variable_list::name_length, netsnmp_call_next_handler(), netsnmp_handler_registration, netsnmp_mib_handler, netsnmp_request_info_s::next, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and snmp_oid_compare().