and added files
[bcm963xx.git] / userapps / opensource / net-snmp / man / netsnmp_multiplexer.3
1 .TH "multiplexer: splits mode requests into calls to different handlers." 3 "10 Jan 2003" "net-snmp" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 multiplexer: splits mode requests into calls to different handlers. \- The multiplexer helper lets you split the calling chain depending on the calling mode (get vs getnext vs set). 
6 More...
7 .SS "Functions"
8
9 .in +1c
10 .ti -1c
11 .RI "netsnmp_mib_handler * \fBnetsnmp_get_multiplexer_handler\fP (netsnmp_mib_handler_methods *req)"
12 .br
13 .RI "\fIreturns a multiplixer handler given a netsnmp_mib_handler_methods structure of subhandlers.\fP"
14 .ti -1c
15 .RI "int \fBnetsnmp_multiplexer_helper_handler\fP (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)"
16 .br
17 .RI "\fIimplements the multiplexer helper.\fP"
18 .in -1c
19 .SH "DETAILED DESCRIPTION"
20 .PP 
21 The multiplexer helper lets you split the calling chain depending on the calling mode (get vs getnext vs set).
22 .PP
23 Useful if you want different routines to handle different aspects of SNMP requests, which is very common for GET vs SET type actions.
24 .PP
25 Functionally:
26 .PP
27 .TP
28 GET requests call the get_method
29 .TP
30 GETNEXT requests call the getnext_method, or if not present, the get_method.
31 .TP
32 GETBULK requests call the getbulk_method, or if not present, the getnext_method, or if even that isn't present the get_method.
33 .TP
34 SET requests call the set_method, or if not present return a SNMP_ERR_NOTWRITABLE error. 
35 .PP
36 .SH "FUNCTION DOCUMENTATION"
37 .PP 
38 .SS "netsnmp_mib_handler* netsnmp_get_multiplexer_handler (netsnmp_mib_handler_methods * req)"
39 .PP
40 returns a multiplixer handler given a netsnmp_mib_handler_methods structure of subhandlers.
41 .PP
42 Definition at line 36 of file multiplexer.c.
43 .SS "int netsnmp_multiplexer_helper_handler (netsnmp_mib_handler * handler, netsnmp_handler_registration * reginfo, netsnmp_agent_request_info * reqinfo, netsnmp_request_info * requests)"
44 .PP
45 implements the multiplexer helper.
46 .PP
47 Definition at line 57 of file multiplexer.c.