| .TH "stash_cache" 3 "24 Jun 2011" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*- |
| .ad l |
| .nh |
| .SH NAME |
| stash_cache \- |
| .PP |
| Automatically caches data for certain handlers. |
| |
| .SS "Functions" |
| |
| .in +1c |
| .ti -1c |
| .RI "\fBnetsnmp_stash_cache_info\fP * \fBnetsnmp_get_new_stash_cache\fP (void)" |
| .br |
| .ti -1c |
| .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_timed_bare_stash_cache_handler\fP (int timeout, oid *rootoid, size_t rootoid_len)" |
| .br |
| .RI "\fIreturns 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. \fP" |
| .ti -1c |
| .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_bare_stash_cache_handler\fP (void)" |
| .br |
| .RI "\fIreturns 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. \fP" |
| .ti -1c |
| .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_stash_cache_handler\fP (void)" |
| .br |
| .RI "\fIreturns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a fixed cache timeout. \fP" |
| .ti -1c |
| .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_timed_stash_cache_handler\fP (int timeout, oid *rootoid, size_t rootoid_len)" |
| .br |
| .RI "\fIreturns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a configurable cache timeout. \fP" |
| .ti -1c |
| .RI "\fBnetsnmp_oid_stash_node\fP ** \fBnetsnmp_extract_stash_cache\fP (\fBnetsnmp_agent_request_info\fP *reqinfo)" |
| .br |
| .RI "\fIextracts a pointer to the stash_cache info from the reqinfo structure. \fP" |
| .ti -1c |
| .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)" |
| .br |
| .ti -1c |
| .RI "int \fB_netsnmp_stash_cache_load\fP (\fBnetsnmp_cache\fP *cache, void *magic)" |
| .br |
| .RI "\fIupdates a given cache depending on whether it needs to or not. \fP" |
| .ti -1c |
| .RI "void \fB_netsnmp_stash_cache_free\fP (\fBnetsnmp_cache\fP *cache, void *magic)" |
| .br |
| .ti -1c |
| .RI "void \fBnetsnmp_init_stash_cache_helper\fP (void)" |
| .br |
| .RI "\fIinitializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. \fP" |
| .in -1c |
| .SH "Detailed Description" |
| .PP |
| Automatically caches data for certain handlers. |
| |
| This handler caches data in an optimized way which may alleviate 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. |
| .SH "Function Documentation" |
| .PP |
| .SS "int _netsnmp_stash_cache_load (\fBnetsnmp_cache\fP * cache, void * magic)" |
| .PP |
| updates a given cache depending on whether it needs to or not. |
| .PP |
| Definition at line 195 of file stash_cache.c. |
| .SS "\fBnetsnmp_oid_stash_node\fP** netsnmp_extract_stash_cache (\fBnetsnmp_agent_request_info\fP * reqinfo)" |
| .PP |
| extracts a pointer to the stash_cache info from the reqinfo structure. |
| .PP |
| Definition at line 113 of file stash_cache.c. |
| .SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_bare_stash_cache_handler (void)" |
| .PP |
| 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. |
| .PP |
| Definition at line 79 of file stash_cache.c. |
| .SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_stash_cache_handler (void)" |
| .PP |
| returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a fixed cache timeout. |
| .PP |
| Definition at line 88 of file stash_cache.c. |
| .SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_bare_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)" |
| .PP |
| 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. |
| .PP |
| Definition at line 44 of file stash_cache.c. |
| .SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)" |
| .PP |
| returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a configurable cache timeout. |
| .PP |
| Definition at line 101 of file stash_cache.c. |
| .SS "void netsnmp_init_stash_cache_helper (void)" |
| .PP |
| initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. |
| .PP |
| Definition at line 238 of file stash_cache.c. |
| .SH "Author" |
| .PP |
| Generated automatically by Doxygen for net-snmp from the source code. |
