1mode_end_call(3)                   net-snmp                   mode_end_call(3)
2
3
4

NAME

6       mode_end_call - At the end of a series of requests, call another
7       handler hook.
8
9
10   Functions
11       netsnmp_mib_handler * netsnmp_get_mode_end_call_handler
12           (netsnmp_mode_handler_list *endlist)
13           returns a mode_end_call handler that can be injected into a given
14           handler chain.
15       netsnmp_mode_handler_list * netsnmp_mode_end_call_add_mode_callback
16           (netsnmp_mode_handler_list *endlist, int mode, netsnmp_mib_handler
17           *callbackh)
18           adds a mode specific callback to the callback list.
19       int netsnmp_mode_end_call_helper (netsnmp_mib_handler *handler,
20           netsnmp_handler_registration *reginfo, netsnmp_agent_request_info
21           *reqinfo, netsnmp_request_info *requests)
22

Detailed Description

24       At the end of a series of requests, call another handler hook.
25
26       Handlers that want to loop through a series of requests and then
27       receive a callback at the end of a particular MODE can use this helper
28       to make this possible. For most modules, this is not needed as the
29       handler itself could perform a for() loop around the request list and
30       then perform its actions afterwards. However, if something like the
31       serialize helper is in use this isn't possible because not all the
32       requests for a given handler are being passed downward in a single
33       group. Thus, this helper *must* be added above other helpers like the
34       serialize helper to be useful.
35
36       Multiple mode specific handlers can be registered and will be called in
37       the order they were regestered in. Callbacks regesterd with a mode of
38       NETSNMP_MODE_END_ALL_MODES will be called for all modes.
39

Function Documentation

41   netsnmp_mib_handler* netsnmp_get_mode_end_call_handler
42       (netsnmp_mode_handler_list * endlist)
43       returns a mode_end_call handler that can be injected into a given
44       handler chain.
45
46       Parameters:
47           endlist The callback list for the handler to make use of.
48
49       Returns:
50           An injectable Net-SNMP handler.
51
52       Definition at line 45 of file mode_end_call.c.
53
54       References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(),
55       netsnmp_mode_end_call_helper(), and NULL.
56
57   netsnmp_mode_handler_list* netsnmp_mode_end_call_add_mode_callback
58       (netsnmp_mode_handler_list * endlist, int mode, netsnmp_mib_handler *
59       callbackh)
60       adds a mode specific callback to the callback list.
61
62       Parameters:
63           endlist the information structure for the mode_end_call helper. Can
64           be NULL to create a new list.
65           mode the mode to be called upon. A mode of
66           NETSNMP_MODE_END_ALL_MODES = all modes.
67           callbackh the netsnmp_mib_handler callback to call.
68
69       Returns:
70           the new registration information list upon success.
71
72       Definition at line 65 of file mode_end_call.c.
73
74       References netsnmp_mode_handler_list_s::callback_handler,
75       netsnmp_mode_handler_list_s::mode, netsnmp_mode_handler_list_s::next,
76       NULL, and SNMP_MALLOC_TYPEDEF.
77
78
79
80Version 5.4                       24 Nov 2006                 mode_end_call(3)
Impressum