| .TH "mode_end_call" 3 "31 May 2012" "Version 5.5.2.rc2" "net-snmp" \" -*- nroff -*- |
| .ad l |
| .nh |
| .SH NAME |
| mode_end_call \- |
| .PP |
| At the end of a series of requests, call another handler hook. |
| |
| .SS "Functions" |
| |
| .in +1c |
| .ti -1c |
| .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_mode_end_call_handler\fP (\fBnetsnmp_mode_handler_list\fP *endlist)" |
| .br |
| .RI "\fIreturns a mode_end_call handler that can be injected into a given handler chain. \fP" |
| .ti -1c |
| .RI "\fBnetsnmp_mode_handler_list\fP * \fBnetsnmp_mode_end_call_add_mode_callback\fP (\fBnetsnmp_mode_handler_list\fP *endlist, int mode, \fBnetsnmp_mib_handler\fP *callbackh)" |
| .br |
| .RI "\fIadds a mode specific callback to the callback list. \fP" |
| .ti -1c |
| .RI "int \fBnetsnmp_mode_end_call_helper\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)" |
| .br |
| .in -1c |
| .SH "Detailed Description" |
| .PP |
| At the end of a series of requests, call another handler hook. |
| |
| Handlers that want to loop through a series of requests and then receive a callback at the end of a particular MODE can use this helper to make this possible. For most modules, this is not needed as the handler itself could perform a for() loop around the request list and then perform its actions afterwards. However, if something like the serialize helper is in use this isn't possible because not all the requests for a given handler are being passed downward in a single group. Thus, this helper *must* be added above other helpers like the serialize helper to be useful. |
| .PP |
| Multiple mode specific handlers can be registered and will be called in the order they were regestered in. Callbacks regesterd with a mode of NETSNMP_MODE_END_ALL_MODES will be called for all modes. |
| .SH "Function Documentation" |
| .PP |
| .SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_mode_end_call_handler (\fBnetsnmp_mode_handler_list\fP * endlist)" |
| .PP |
| returns a mode_end_call handler that can be injected into a given handler chain. \fBParameters:\fP |
| .RS 4 |
| \fIendlist\fP The callback list for the handler to make use of. |
| .RE |
| .PP |
| \fBReturns:\fP |
| .RS 4 |
| An injectable Net-SNMP handler. |
| .RE |
| .PP |
| |
| .PP |
| Definition at line 45 of file mode_end_call.c. |
| .SS "\fBnetsnmp_mode_handler_list\fP* netsnmp_mode_end_call_add_mode_callback (\fBnetsnmp_mode_handler_list\fP * endlist, int mode, \fBnetsnmp_mib_handler\fP * callbackh)" |
| .PP |
| adds a mode specific callback to the callback list. \fBParameters:\fP |
| .RS 4 |
| \fIendlist\fP the information structure for the mode_end_call helper. Can be NULL to create a new list. |
| .br |
| \fImode\fP the mode to be called upon. A mode of NETSNMP_MODE_END_ALL_MODES = all modes. |
| .br |
| \fIcallbackh\fP the netsnmp_mib_handler callback to call. |
| .RE |
| .PP |
| \fBReturns:\fP |
| .RS 4 |
| the new registration information list upon success. |
| .RE |
| .PP |
| |
| .PP |
| Definition at line 65 of file mode_end_call.c. |
| .SH "Author" |
| .PP |
| Generated automatically by Doxygen for net-snmp from the source code. |
