← Back to branch summary

~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/netsnmp_mode_end_call.3

  • Committer: Bazaar Package Importer
  • Author(s): Jochen Friedrich
  • Date: 2010-06-10 18:02:54 UTC
  • mto: (1.4.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: james.westby@ubuntu.com-20100610180254-6ezvupl2clicwdqf
Import upstream version 5.4.3~dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_mode_end_call.3
1
 
.TH "mode_end_call" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "mode_end_call" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
mode_end_call \- At the end of a series of requests, call another handler hook.  
 
5
mode_end_call \- 
 
6
.PP
 
7
At the end of a series of requests, call another handler hook.  
6
8
 
7
 
.PP
8
9
.SS "Functions"
9
10
 
10
11
.in +1c
23
24
.SH "Detailed Description"
24
25
.PP 
25
26
At the end of a series of requests, call another handler hook. 
26
 
.PP
 
27
 
27
28
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.
28
29
.PP
29
30
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. 
31
32
.PP 
32
33
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_mode_end_call_handler (\fBnetsnmp_mode_handler_list\fP * endlist)"
33
34
.PP
34
 
returns a mode_end_call handler that can be injected into a given handler chain. 
35
 
.PP
36
 
\fBParameters:\fP
 
35
returns a mode_end_call handler that can be injected into a given handler chain. \fBParameters:\fP
37
36
.RS 4
38
37
\fIendlist\fP The callback list for the handler to make use of. 
39
38
.RE
46
45
 
47
46
.PP
48
47
Definition at line 45 of file mode_end_call.c.
49
 
.PP
50
 
References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_mode_end_call_helper(), and NULL.
51
48
.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)"
52
49
.PP
53
 
adds a mode specific callback to the callback list. 
54
 
.PP
55
 
\fBParameters:\fP
 
50
adds a mode specific callback to the callback list. \fBParameters:\fP
56
51
.RS 4
57
52
\fIendlist\fP the information structure for the mode_end_call helper. Can be NULL to create a new list. 
58
53
.br
69
64
 
70
65
.PP
71
66
Definition at line 65 of file mode_end_call.c.
72
 
.PP
73
 
References netsnmp_mode_handler_list_s::callback_handler, netsnmp_mode_handler_list_s::mode, netsnmp_mode_handler_list_s::next, NULL, and SNMP_MALLOC_TYPEDEF.
 
67
.SH "Author"
 
68
.PP 
 
69
Generated automatically by Doxygen for net-snmp from the source code.