~ubuntu-branches/ubuntu/wily/net-snmp/wily-proposed

« back to all changes in this revision

Viewing changes to man/netsnmp_stash_cache.3

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-06-28 14:59:36 UTC
  • mfrom: (1.2.3 upstream) (1.1.12 sid)
  • Revision ID: james.westby@ubuntu.com-20100628145936-cbiallic69pn044g
Tags: 5.4.3~dfsg-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Set Ubuntu maintainer address.
  - net-snmp-config: Use bash. (LP: #104738)
  - Removed multiuser option when calling update-rc.d. (LP: #254261)
  - debian/snmpd.init: LSBify the init script.
  - debian/patches/52_fix_snmpcmd_1_typo.patch: Adjust a typo in snmpcmd.1
    (LP: #250459)
  - debian/snmpd.postinst: source debconf before doing work, LP: #589056
  - debian/snmp.preinst, debian/snmp.prerm: kill any/all processes owned by
    snmp user before install/uninstall, LP: #573391
  - Add apport hook (LP: #533603):
  - debian/{snmp,snmpd}.apport: Added.
  - debian/control: Build-depends on dh-apport.
  - debian/rules: 
    + Add --with apport.
    + override_dh_apport to install hook on snmpd package only.
 * Dropped patches:
   - debian/patches/99-fix-ubuntu-div0.patch: Fix dvision by zero.. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "stash_cache" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "stash_cache" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
stash_cache \- Automatically caches data for certain handlers.  
 
5
stash_cache \- 
 
6
.PP
 
7
Automatically caches data for certain handlers.  
6
8
 
7
 
.PP
8
9
.SS "Functions"
9
10
 
10
11
.in +1c
49
50
.SH "Detailed Description"
50
51
.PP 
51
52
Automatically caches data for certain handlers. 
52
 
.PP
 
53
 
53
54
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. 
54
55
.SH "Function Documentation"
55
56
.PP 
57
58
.PP
58
59
updates a given cache depending on whether it needs to or not. 
59
60
.PP
60
 
Definition at line 194 of file stash_cache.c.
61
 
.PP
62
 
References netsnmp_stash_cache_info_s::cache, netsnmp_cache_s::cache_hint, netsnmp_handler_args_s::handler, netsnmp_cache_s::magic, netsnmp_agent_request_info_s::mode, netsnmp_agent_add_list_data(), netsnmp_call_next_handler(), netsnmp_create_data_list(), netsnmp_get_new_stash_cache(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_args_s::reginfo, netsnmp_handler_args_s::reqinfo, and netsnmp_handler_args_s::requests.
63
 
.PP
64
 
Referenced by netsnmp_get_timed_bare_stash_cache_handler().
 
61
Definition at line 195 of file stash_cache.c.
65
62
.SS "\fBnetsnmp_oid_stash_node\fP** netsnmp_extract_stash_cache (\fBnetsnmp_agent_request_info\fP * reqinfo)"
66
63
.PP
67
64
extracts a pointer to the stash_cache info from the reqinfo structure. 
68
65
.PP
69
 
Definition at line 112 of file stash_cache.c.
70
 
.PP
71
 
References netsnmp_agent_get_list_data().
72
 
.PP
73
 
Referenced by netsnmp_stash_to_next_helper(), and netsnmp_table_iterator_helper_handler().
 
66
Definition at line 113 of file stash_cache.c.
74
67
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_bare_stash_cache_handler (void)"
75
68
.PP
76
69
returns a single stash_cache handler that can be injected into a given handler chain (with a fixed timeout), but *only* if that handler chain explicitly supports stash cache processing. 
77
70
.PP
78
 
Definition at line 78 of file stash_cache.c.
79
 
.PP
80
 
References netsnmp_get_timed_bare_stash_cache_handler(), and NULL.
81
 
.PP
82
 
Referenced by netsnmp_get_stash_cache_handler().
 
71
Definition at line 79 of file stash_cache.c.
83
72
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_stash_cache_handler (void)"
84
73
.PP
85
74
returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a fixed cache timeout. 
86
75
.PP
87
 
Definition at line 87 of file stash_cache.c.
88
 
.PP
89
 
References netsnmp_get_bare_stash_cache_handler(), netsnmp_get_stash_to_next_handler(), and netsnmp_mib_handler_s::next.
90
 
.PP
91
 
Referenced by netsnmp_init_stash_cache_helper().
 
76
Definition at line 88 of file stash_cache.c.
92
77
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_bare_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)"
93
78
.PP
94
79
returns a stash_cache handler that can be injected into a given handler chain (with the specified timeout and root OID values), but *only* if that handler chain explicitly supports stash cache processing. 
95
80
.PP
96
81
Definition at line 44 of file stash_cache.c.
97
 
.PP
98
 
References _netsnmp_stash_cache_free(), _netsnmp_stash_cache_load(), netsnmp_mib_handler_s::myvoid, netsnmp_cache_create(), netsnmp_cache_handler_get(), netsnmp_create_handler(), netsnmp_handler_free(), netsnmp_stash_cache_helper(), netsnmp_mib_handler_s::next, and NULL.
99
 
.PP
100
 
Referenced by netsnmp_get_bare_stash_cache_handler(), and netsnmp_get_timed_stash_cache_handler().
101
82
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)"
102
83
.PP
103
84
returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a configurable cache timeout. 
104
85
.PP
105
 
Definition at line 100 of file stash_cache.c.
106
 
.PP
107
 
References netsnmp_get_stash_to_next_handler(), netsnmp_get_timed_bare_stash_cache_handler(), and netsnmp_mib_handler_s::next.
 
86
Definition at line 101 of file stash_cache.c.
108
87
.SS "void netsnmp_init_stash_cache_helper (void)"
109
88
.PP
110
89
initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. 
111
90
.PP
112
 
Definition at line 237 of file stash_cache.c.
113
 
.PP
114
 
References netsnmp_get_stash_cache_handler(), and netsnmp_register_handler_by_name().
115
 
.PP
116
 
Referenced by netsnmp_init_helpers().
 
91
Definition at line 238 of file stash_cache.c.
 
92
.SH "Author"
 
93
.PP 
 
94
Generated automatically by Doxygen for net-snmp from the source code.