← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/netsnmp_agent_registry.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
https://launchpad.net/bugs/104738
https://launchpad.net/bugs/254261
https://launchpad.net/bugs/250459
https://launchpad.net/bugs/589056
https://launchpad.net/bugs/573391
https://launchpad.net/bugs/533603
* 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:
man/netsnmp_agent_registry.3
1
 
.TH "Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
30
30
 
31
31
.in +1c
32
32
.ti -1c
33
 
.RI "typedef \fBlookup_cache_s\fP \fBlookup_cache\fP"
 
33
.RI "typedef struct \fBlookup_cache_s\fP \fBlookup_cache\fP"
34
34
.br
35
35
.ti -1c
36
 
.RI "typedef \fBlookup_cache_context_s\fP \fBlookup_cache_context\fP"
 
36
.RI "typedef struct \fBlookup_cache_context_s\fP \fBlookup_cache_context\fP"
37
37
.br
38
38
.in -1c
39
39
.SS "Functions"
210
210
.RI "int \fBexternal_signal_scheduled\fP [NUM_EXTERNAL_SIGS]"
211
211
.br
212
212
.ti -1c
213
 
.RI "void(*[NUM_EXTERNAL_SIGS]) \fBexternal_signal_handler\fP (int)"
 
213
.RI "void(* \fBexternal_signal_handler\fP [NUM_EXTERNAL_SIGS])(int)"
214
214
.br
215
215
.in -1c
216
216
.SH "Function Documentation"
217
217
.PP 
218
218
.SS "int netsnmp_acm_check_subtree (\fBnetsnmp_pdu\fP * pdu, oid * name, size_t namelen)"
219
219
.PP
220
 
checks to see if everything within a given subtree is either: in view, not in view, or possibly both. 
221
 
.PP
222
 
If the entire subtree is not-in-view we can use this information to skip calling the sub-handlers entirely. 
 
220
checks to see if everything within a given subtree is either: in view, not in view, or possibly both. If the entire subtree is not-in-view we can use this information to skip calling the sub-handlers entirely. 
223
221
.PP
224
222
\fBReturns:\fP
225
223
.RS 4
229
227
 
230
228
.PP
231
229
Definition at line 1323 of file agent_registry.c.
232
 
.PP
233
 
References view_parameters::check_subtree, view_parameters::errorcode, snmp_pdu::flags, view_parameters::name, view_parameters::namelen, view_parameters::pdu, snmp_call_callbacks(), and snmp_pdu::version.
234
 
.PP
235
 
Referenced by netsnmp_add_varbind_to_cache().
236
230
.SS "int netsnmp_get_lookup_cache_size (void)"
237
231
.PP
238
 
retrieves the current value of the lookup cache size 
239
 
.PP
240
 
\fBReturns:\fP
 
232
retrieves the current value of the lookup cache size \fBReturns:\fP
241
233
.RS 4
242
234
the current lookup cache size 
243
235
.RE
245
237
 
246
238
.PP
247
239
Definition at line 1396 of file agent_registry.c.
248
 
.PP
249
 
References lookup_cache_size.
250
 
.PP
251
 
Referenced by netsnmp_register_mib(), and unregister_mib_context().
252
240
.SS "void netsnmp_set_lookup_cache_size (int newsize)"
253
241
.PP
254
 
set the lookup cache size for optimized agent registration performance. 
255
 
.PP
256
 
\fBParameters:\fP
 
242
set the lookup cache size for optimized agent registration performance. \fBParameters:\fP
257
243
.RS 4
258
244
\fInewsize\fP set to the maximum size of a cache for a given context. Set to 0 to completely disable caching, or to -1 to set to the default cache size (8), or to a number of your chosing. The rough guide is that it should be equal to the maximum number of simultanious managers you expect to talk to the agent (M) times 80% (or so, he says randomly) the average number (N) of varbinds you expect to receive in a given request for a manager. ie, M times N. Bigger does NOT necessarily mean better. Certainly 16 should be an upper limit. 32 is the hard coded limit. 
259
245
.RE
261
247
 
262
248
.PP
263
249
Definition at line 1383 of file agent_registry.c.
264
 
.PP
265
 
References lookup_cache_size, SUBTREE_DEFAULT_CACHE_SIZE, and SUBTREE_MAX_CACHE_SIZE.
266
 
.PP
267
 
Referenced by init_master_agent(), netsnmp_register_mib(), and unregister_mib_context().
268
250
.SS "int unregister_mib_context (oid * name, size_t len, int priority, int range_subid, oid range_ubound, const char * context)"
269
251
.PP
270
 
Unregisters an OID that has an associated context name value. 
271
 
.PP
272
 
Typically used when a module has multiple contexts defined. The parameters priority, range_subid, and range_ubound should be used in conjunction with agentx, see RFC 2741, otherwise these values should always be 0.
 
252
Unregisters an OID that has an associated context name value. Typically used when a \fBmodule\fP has multiple contexts defined. The parameters priority, range_subid, and range_ubound should be used in conjunction with agentx, see RFC 2741, otherwise these values should always be 0.
273
253
.PP
274
254
\fBParameters:\fP
275
255
.RS 4
293
273
 
294
274
.PP
295
275
Definition at line 969 of file agent_registry.c.
296
 
.PP
297
 
References netsnmp_subtree_s::children, netsnmp_get_lookup_cache_size(), netsnmp_oid_equals(), netsnmp_set_lookup_cache_size(), netsnmp_subtree_find(), netsnmp_subtree_find_first(), netsnmp_subtree_free(), netsnmp_subtree_unload(), netsnmp_subtree_s::next, and NULL.
298
 
.PP
299
 
Referenced by netsnmp_register_mib(), netsnmp_unregister_handler(), remove_tree_entry(), and unregister_mib_range().
 
276
.SH "Author"
 
277
.PP 
 
278
Generated automatically by Doxygen for net-snmp from the source code.