and added files
[bcm963xx.git] / userapps / opensource / net-snmp / man / netsnmp_debug.3
1 .TH "debug: print out debugging information about the handler chain being called." 3 "10 Jan 2003" "net-snmp" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 debug: print out debugging information about the handler chain being called. \- This is a useful module for run-time debugging of requests as the pass this handler in a calling chain. 
6 More...
7 .SS "handler"
8
9 .in +1c
10 .ti -1c
11 .RI "void \fBnetsnmp_init_serialize\fP (void)"
12 .br
13 .RI "\fIinitializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.\fP"
14 .ti -1c
15 .RI "void \fBnetsnmp_init_read_only_helper\fP (void)"
16 .br
17 .RI "\fIinitializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.\fP"
18 .ti -1c
19 .RI "void \fBnetsnmp_init_bulk_to_next_helper\fP (void)"
20 .br
21 .RI "\fIinitializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.\fP"
22 .ti -1c
23 .RI "void \fBnetsnmp_init_helpers\fP (void)"
24 .br
25 .RI "\fIcall the initialization sequence for all handlers with init_ routines.\fP"
26 .in -1c
27 .SS "Functions"
28
29 .in +1c
30 .ti -1c
31 .RI "netsnmp_mib_handler * \fBnetsnmp_get_debug_handler\fP (void)"
32 .br
33 .RI "\fIreturns a debug handler that can be injected into a given handler chain.\fP"
34 .ti -1c
35 .RI "void \fBdebug_print_requests\fP (netsnmp_request_info *requests)"
36 .br
37 .ti -1c
38 .RI "int \fBnetsnmp_debug_helper\fP (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)"
39 .br
40 .ti -1c
41 .RI "void \fBnetsnmp_init_debug_helper\fP (void)"
42 .br
43 .RI "\fIinitializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.\fP"
44 .in -1c
45 .SH "DETAILED DESCRIPTION"
46 .PP 
47 This is a useful module for run-time debugging of requests as the pass this handler in a calling chain.
48 .PP
49 All debugging output is done via the standard debugging routines with a token name of 'helper:debug', so use the -Dhelper:debug command line flag to see the output when running the snmpd demon. It's not recommended you compile this into a handler chain during compile time, but instead use the 'injectHandler' token in the snmpd.conf file (or similar) to add it to the chain later:
50 .PP
51 injectHandler debug my_module_name
52 .PP
53 to see an example output, try:
54 .PP
55 injectHandler debug mibII/system
56 .PP
57 and then run snmpwalk on the 'system' group. 
58 .SH "FUNCTION DOCUMENTATION"
59 .PP 
60 .SS "netsnmp_mib_handler* netsnmp_get_debug_handler (void)"
61 .PP
62 returns a debug handler that can be injected into a given handler chain.
63 .PP
64 Definition at line 44 of file debug_handler.c.
65 .SS "void netsnmp_init_bulk_to_next_helper (void)"
66 .PP
67 initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.
68 .PP
69 Definition at line 95 of file bulk_to_next.c.
70 .SS "void netsnmp_init_debug_helper (void)"
71 .PP
72 initializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.
73 .PP
74 Definition at line 147 of file debug_handler.c.
75 .SS "void netsnmp_init_helpers (void)"
76 .PP
77 call the initialization sequence for all handlers with init_ routines.
78 .PP
79 Definition at line 31 of file all_helpers.c.
80 .SS "void netsnmp_init_read_only_helper (void)"
81 .PP
82 initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.
83 .PP
84 Definition at line 71 of file read_only.c.
85 .SS "void netsnmp_init_serialize (void)"
86 .PP
87 initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.
88 .PP
89 Definition at line 96 of file serialize.c.