← Back to branch summary

~ubuntu-branches/ubuntu/edgy/net-snmp/edgy-updates

« back to all changes in this revision

Viewing changes to man/netsnmp_stash_cache.3

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-03-31 04:21:37 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050331042137-z0vw1grslj6cek9k
Tags: 5.1.2-6ubuntu2
Apply safe-but-hackish patch by Henrique de Moraes Holschuh to
fix the libdir in libsnmp5-dev's .la files (Ubuntu bug #8393)

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_stash_cache.3
1
 
.TH "stash_cache: automatically caches data for certain handlers." 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
 
1
.TH "stash_cache: automatically caches data for certain handlers." 3 "7 Aug 2004" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
stash_cache: automatically caches data for certain handlers. \- This handler caches data in an optimized way which may aleviate the need for the lower level handlers to perform as much optimization. 
6
 
More...
7
 
.SS "handler"
 
5
stash_cache: automatically caches data for certain handlers. \- This handler caches data in an optimized way which may aleviate the need for the lower level handlers to perform as much optimization.  
8
6
 
9
 
.in +1c
10
 
.ti -1c
11
 
.RI "void \fBnetsnmp_init_stash_cache_helper\fP (void)"
12
 
.br
13
 
.RI "\fIinitializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use.\fP"
14
 
.in -1c
 
7
.PP
15
8
.SS "Functions"
16
9
 
17
10
.in +1c
18
11
.ti -1c
 
12
.RI "netsnmp_stash_cache_info * \fBnetsnmp_get_new_stash_cache\fP (void)"
 
13
.br
 
14
.ti -1c
19
15
.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_stash_cache_handler\fP (void)"
20
16
.br
21
 
.RI "\fIreturns a stash_cache handler that can be injected into a given handler chain.\fP"
22
 
.ti -1c
23
 
.RI "netsnmp_oid_stash_node ** \fBnetsnmp_extract_stash_cache\fP (netsnmp_agent_request_info *reqinfo)"
24
 
.br
25
 
.RI "\fIextracts a pointer to the stash_cache info from the reqinfo structure.\fP"
26
 
.ti -1c
27
 
.RI "int \fBnetsnmp_stash_cache_update\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests, netsnmp_stash_cache_info *cinfo)"
28
 
.br
29
 
.RI "\fIupdates a given cache depending on whether it needs to or not.\fP"
 
17
.RI "\fIreturns a stash_cache handler that can be injected into a given handler chain. \fP"
 
18
.ti -1c
 
19
.RI "netsnmp_oid_stash_node ** \fBnetsnmp_extract_stash_cache\fP (\fBnetsnmp_agent_request_info\fP *reqinfo)"
 
20
.br
 
21
.RI "\fIextracts a pointer to the stash_cache info from the reqinfo structure. \fP"
 
22
.ti -1c
 
23
.RI "int \fBnetsnmp_stash_cache_helper\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
 
24
.br
 
25
.ti -1c
 
26
.RI "int \fBnetsnmp_stash_cache_update\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests, netsnmp_stash_cache_info *cinfo)"
 
27
.br
 
28
.RI "\fIupdates a given cache depending on whether it needs to or not. \fP"
 
29
.ti -1c
 
30
.RI "void \fBnetsnmp_init_stash_cache_helper\fP (void)"
 
31
.br
 
32
.RI "\fIinitializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. \fP"
30
33
.in -1c
31
 
.SH "DETAILED DESCRIPTION"
32
 
.PP 
33
 
This handler caches data in an optimized way which may aleviate the need for the lower level handlers to perform as much optimization.
34
 
.PP
35
 
Specifically, somewhere in the lower level handlers must be a handler that supports the MODE_GET_STASH operation. Note that the table_iterator helper supports this. 
36
 
.SH "FUNCTION DOCUMENTATION"
37
 
.PP 
38
 
.SS "netsnmp_oid_stash_node** netsnmp_extract_stash_cache (netsnmp_agent_request_info * reqinfo)"
39
 
.PP
40
 
extracts a pointer to the stash_cache info from the reqinfo structure.
41
 
.PP
42
 
Definition at line 64 of file stash_cache.c.
 
34
.SH "Detailed Description"
 
35
.PP 
 
36
This handler caches data in an optimized way which may aleviate the need for the lower level handlers to perform as much optimization. Specifically, somewhere in the lower level handlers must be a handler that supports the MODE_GET_STASH operation. Note that the table_iterator helper supports this. 
 
37
.SH "Function Documentation"
 
38
.PP 
 
39
.SS "netsnmp_oid_stash_node** netsnmp_extract_stash_cache (\fBnetsnmp_agent_request_info\fP * reqinfo)"
 
40
.PP
 
41
extracts a pointer to the stash_cache info from the reqinfo structure. Definition at line 64 of file stash_cache.c.
43
42
.PP
44
43
Referenced by netsnmp_table_iterator_helper_handler().
45
44
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_stash_cache_handler (void)"
46
45
.PP
47
 
returns a stash_cache handler that can be injected into a given handler chain.
48
 
.PP
49
 
Definition at line 42 of file stash_cache.c.
50
 
.PP
51
 
References netsnmp_mib_handler_s::myvoid, and netsnmp_create_handler().
 
46
returns a stash_cache handler that can be injected into a given handler chain. Definition at line 42 of file stash_cache.c.
 
47
.PP
 
48
References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), and netsnmp_mib_handler.
52
49
.PP
53
50
Referenced by netsnmp_init_stash_cache_helper().
54
51
.SS "void netsnmp_init_stash_cache_helper (void)"
55
52
.PP
56
 
initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use.
57
 
.PP
58
 
Definition at line 188 of file stash_cache.c.
 
53
initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. Definition at line 188 of file stash_cache.c.
59
54
.PP
60
55
References netsnmp_get_stash_cache_handler(), and netsnmp_register_handler_by_name().
61
56
.PP
62
57
Referenced by netsnmp_init_helpers().
63
 
.SS "int netsnmp_stash_cache_update (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, netsnmp_agent_request_info * reqinfo, netsnmp_request_info * requests, netsnmp_stash_cache_info * cinfo)"
64
 
.PP
65
 
updates a given cache depending on whether it needs to or not.
66
 
.PP
67
 
Definition at line 143 of file stash_cache.c.
68
 
.PP
69
 
References atime_newMarker(), atime_ready(), atime_setMarker(), netsnmp_agent_request_info_s::mode, netsnmp_call_next_handler(), netsnmp_create_data_list(), and netsnmp_oid_stash_free().
 
58
.SS "int netsnmp_stash_cache_update (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests, netsnmp_stash_cache_info * cinfo)"
 
59
.PP
 
60
updates a given cache depending on whether it needs to or not. Definition at line 143 of file stash_cache.c.
 
61
.PP
 
62
References atime_newMarker(), atime_ready(), atime_setMarker(), netsnmp_agent_request_info_s::mode, netsnmp_call_next_handler(), netsnmp_create_data_list(), netsnmp_handler_registration, netsnmp_mib_handler, and netsnmp_oid_stash_free().