userapps/opensource/net-snmp/man/netsnmp_mode_end_call.3

   1 .TH "mode_end_call: at the end of a series of requests, call another handler hook." 3 "10 Jan 2003" "net-snmp" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 mode_end_call: 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.
   6 More...
   7 .SS "Functions"
   8
   9 .in +1c
  10 .ti -1c
  11 .RI "netsnmp_mib_handler * \fBnetsnmp_get_mode_end_call_handler\fP (netsnmp_mode_handler_list *endlist)"
  12 .br
  13 .RI "\fIreturns a mode_end_call handler that can be injected into a given handler chain.\fP"
  14 .ti -1c
  15 .RI "netsnmp_mode_handler_list * \fBnetsnmp_mode_end_call_add_mode_callback\fP (netsnmp_mode_handler_list *endlist, int mode, netsnmp_mib_handler *callbackh)"
  16 .br
  17 .RI "\fIadds a mode specific callback to the callback list.\fP"
  18 .ti -1c
  19 .RI "int \fBnetsnmp_mode_end_call_helper\fP (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)"
  20 .br
  21 .in -1c
  22 .SH "DETAILED DESCRIPTION"
  23 .PP
  24 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.
  25 .PP
  26 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.
  27 .PP
  28 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.
  29 .SH "FUNCTION DOCUMENTATION"
  30 .PP
  31 .SS "netsnmp_mib_handler* netsnmp_get_mode_end_call_handler (netsnmp_mode_handler_list * endlist)"
  32 .PP
  33 returns a mode_end_call handler that can be injected into a given handler chain.
  34 .PP
  35 Parameters: \fP
  36 .in +1c
  37 .TP
  38 \fB\fIendlist\fP\fP
  39 The callback list for the handler to make use of.
  40 .PP
  41 \fBReturns: \fP
  42 .in +1c
  43 An injectable Net-SNMP handler.
  44 .PP
  45 Definition at line 38 of file mode_end_call.c.
  46 .SS "netsnmp_mode_handler_list* netsnmp_mode_end_call_add_mode_callback (netsnmp_mode_handler_list * endlist, int mode, netsnmp_mib_handler * callbackh)"
  47 .PP
  48 adds a mode specific callback to the callback list.
  49 .PP
  50 Parameters: \fP
  51 .in +1c
  52 .TP
  53 \fB\fIendinfo\fP\fP
  54 the information structure for the mode_end_call helper. Can be NULL to create a new list.
  55 .TP
  56 \fB\fImode\fP\fP
  57 the mode to be called upon. A mode of NETSNMP_MODE_END_ALL_MODES = all modes.
  58 .TP
  59 \fB\fIcallbackh\fP\fP
  60 the netsnmp_mib_handler callback to call.
  61 .PP
  62 \fBReturns: \fP
  63 .in +1c
  64 the new registration information list upon success.
  65 .PP
  66 Definition at line 58 of file mode_end_call.c.