开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Internet/网络编程 > SNMP编程 > 查看源码
netsnmp_agent_registry.3
资源名称：net-snmp-5.2.2.rar　[点击查看]
上传用户：wxp200602
上传日期：2007-10-30
资源大小：4028k
文件大小：12k
源码类别：

SNMP编程

开发平台：

Unix_Linux

netsnmp_agent_registry.3：源码内容
  1. .TH "Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc - 
  6. .SS "Data Structures"
  8. .in +1c
  9. .ti -1c
  10. .RI "struct fBlookup_cache_sfP"
  11. .br
  12. .ti -1c
  13. .RI "struct fBlookup_cache_context_sfP"
  14. .br
  15. .in -1c
  16. .SS "Defines"
  18. .in +1c
  19. .ti -1c
  20. .RI "#define fBIN_SNMP_VARS_CfP"
  21. .br
  22. .ti -1c
  23. .RI "#define fBSUBTREE_DEFAULT_CACHE_SIZEfP   8"
  24. .br
  25. .ti -1c
  26. .RI "#define fBSUBTREE_MAX_CACHE_SIZEfP   32"
  27. .br
  28. .in -1c
  29. .SS "Typedefs"
  31. .in +1c
  32. .ti -1c
  33. .RI "typedef fBlookup_cache_sfP fBlookup_cachefP"
  34. .br
  35. .ti -1c
  36. .RI "typedef fBlookup_cache_context_sfP fBlookup_cache_contextfP"
  37. .br
  38. .in -1c
  39. .SS "Functions"
  41. .in +1c
  42. .ti -1c
  43. .RI "NETSNMP_STATIC_INLINE void fBinvalidate_lookup_cachefP (const char *context)"
  44. .br
  45. .ti -1c
  46. .RI "void fBnetsnmp_set_lookup_cache_sizefP (int newsize)"
  47. .br
  48. .RI "fIset the lookup cache size for optimized agent registration performance. fP"
  49. .ti -1c
  50. .RI "int fBnetsnmp_get_lookup_cache_sizefP (void)"
  51. .br
  52. .RI "fIretrieves the current value of the lookup cache size fP"
  53. .ti -1c
  54. .RI "void fBnetsnmp_subtree_freefP (fBnetsnmp_subtreefP *a)"
  55. .br
  56. .ti -1c
  57. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_deepcopyfP (fBnetsnmp_subtreefP *a)"
  58. .br
  59. .ti -1c
  60. .RI "fBsubtree_context_cachefP * fBget_top_context_cachefP (void)"
  61. .br
  62. .ti -1c
  63. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_find_firstfP (const char *context_name)"
  64. .br
  65. .ti -1c
  66. .RI "fBnetsnmp_subtreefP * fBadd_subtreefP (fBnetsnmp_subtreefP *new_tree, const char *context_name)"
  67. .br
  68. .ti -1c
  69. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_replace_firstfP (fBnetsnmp_subtreefP *new_tree, const char *context_name)"
  70. .br
  71. .ti -1c
  72. .RI "int fBnetsnmp_subtree_comparefP (const fBnetsnmp_subtreefP *ap, const fBnetsnmp_subtreefP *bp)"
  73. .br
  74. .ti -1c
  75. .RI "void fBnetsnmp_subtree_joinfP (fBnetsnmp_subtreefP *root)"
  76. .br
  77. .ti -1c
  78. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_splitfP (fBnetsnmp_subtreefP *current, oid name[], int name_len)"
  79. .br
  80. .ti -1c
  81. .RI "int fBnetsnmp_subtree_loadfP (fBnetsnmp_subtreefP *new_sub, const char *context_name)"
  82. .br
  83. .ti -1c
  84. .RI "int fBnetsnmp_register_mibfP (const char *moduleName, struct fBvariablefP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority, int range_subid, oid range_ubound, fBnetsnmp_sessionfP *ss, const char *context, int timeout, int flags, fBnetsnmp_handler_registrationfP *reginfo, int perform_callback)"
  85. .br
  86. .ti -1c
  87. .RI "void fBregister_mib_reattachfP (void)"
  88. .br
  89. .ti -1c
  90. .RI "void fBregister_mib_detachfP (void)"
  91. .br
  92. .ti -1c
  93. .RI "int fBregister_mib_contextfP (const char *moduleName, struct fBvariablefP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority, int range_subid, oid range_ubound, fBnetsnmp_sessionfP *ss, const char *context, int timeout, int flags)"
  94. .br
  95. .ti -1c
  96. .RI "int fBregister_mib_rangefP (const char *moduleName, struct fBvariablefP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority, int range_subid, oid range_ubound, fBnetsnmp_sessionfP *ss)"
  97. .br
  98. .ti -1c
  99. .RI "int fBregister_mib_priorityfP (const char *moduleName, struct fBvariablefP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority)"
  100. .br
  101. .ti -1c
  102. .RI "int fBregister_mibfP (const char *moduleName, struct fBvariablefP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen)"
  103. .br
  104. .ti -1c
  105. .RI "void fBnetsnmp_subtree_unloadfP (fBnetsnmp_subtreefP *sub, fBnetsnmp_subtreefP *prev, const char *context)"
  106. .br
  107. .ti -1c
  108. .RI "int fBunregister_mib_contextfP (oid *name, size_t len, int priority, int range_subid, oid range_ubound, const char *context)"
  109. .br
  110. .RI "fIUnregisters an OID that has an associated context name value. fP"
  111. .ti -1c
  112. .RI "int fBnetsnmp_unregister_mib_table_rowfP (oid *name, size_t len, int priority, int var_subid, oid range_ubound, const char *context)"
  113. .br
  114. .ti -1c
  115. .RI "int fBunregister_mib_rangefP (oid *name, size_t len, int priority, int range_subid, oid range_ubound)"
  116. .br
  117. .ti -1c
  118. .RI "int fBunregister_mib_priorityfP (oid *name, size_t len, int priority)"
  119. .br
  120. .ti -1c
  121. .RI "int fBunregister_mibfP (oid *name, size_t len)"
  122. .br
  123. .ti -1c
  124. .RI "void fBunregister_mibs_by_sessionfP (fBnetsnmp_sessionfP *ss)"
  125. .br
  126. .ti -1c
  127. .RI "int fBin_a_viewfP (oid *name, size_t *namelen, fBnetsnmp_pdufP *pdu, int type)"
  128. .br
  129. .ti -1c
  130. .RI "int fBcheck_accessfP (fBnetsnmp_pdufP *pdu)"
  131. .br
  132. .ti -1c
  133. .RI "int fBnetsnmp_acm_check_subtreefP (fBnetsnmp_pdufP *pdu, oid *name, size_t namelen)"
  134. .br
  135. .RI "fIchecks to see if everything within a given subtree is either: in view, not in view, or possibly both. fP"
  136. .ti -1c
  137. .RI "NETSNMP_STATIC_INLINE fBlookup_cache_contextfP * fBget_context_lookup_cachefP (const char *context)"
  138. .br
  139. .ti -1c
  140. .RI "NETSNMP_STATIC_INLINE void fBlookup_cache_addfP (const char *context, fBnetsnmp_subtreefP *next, fBnetsnmp_subtreefP *previous)"
  141. .br
  142. .ti -1c
  143. .RI "NETSNMP_STATIC_INLINE void fBlookup_cache_replacefP (fBlookup_cachefP *ptr, fBnetsnmp_subtreefP *next, fBnetsnmp_subtreefP *previous)"
  144. .br
  145. .ti -1c
  146. .RI "NETSNMP_STATIC_INLINE fBlookup_cachefP * fBlookup_cache_findfP (const char *context, oid *name, size_t name_len, int *retcmp)"
  147. .br
  148. .ti -1c
  149. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_find_prevfP (oid *name, size_t len, fBnetsnmp_subtreefP *subtree, const char *context_name)"
  150. .br
  151. .ti -1c
  152. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_find_nextfP (oid *name, size_t len, fBnetsnmp_subtreefP *subtree, const char *context_name)"
  153. .br
  154. .ti -1c
  155. .RI "fBnetsnmp_subtreefP * fBnetsnmp_subtree_findfP (oid *name, size_t len, fBnetsnmp_subtreefP *subtree, const char *context_name)"
  156. .br
  157. .ti -1c
  158. .RI "fBnetsnmp_sessionfP * fBget_session_for_oidfP (oid *name, size_t len, const char *context_name)"
  159. .br
  160. .ti -1c
  161. .RI "void fBsetup_treefP (void)"
  162. .br
  163. .ti -1c
  164. .RI "int fBremove_tree_entryfP (oid *name, size_t len)"
  165. .br
  166. .ti -1c
  167. .RI "void fBshutdown_treefP (void)"
  168. .br
  169. .ti -1c
  170. .RI "void fBclear_subtreefP (fBnetsnmp_subtreefP *sub)"
  171. .br
  172. .ti -1c
  173. .RI "void fBclear_lookup_cachefP (void)"
  174. .br
  175. .ti -1c
  176. .RI "void fBclear_contextfP (void)"
  177. .br
  178. .ti -1c
  179. .RI "void fBdump_idx_registryfP (void)"
  180. .br
  181. .ti -1c
  182. .RI "void fBdump_registryfP (void)"
  183. .br
  184. .ti -1c
  185. .RI "int fBregister_readfdfP (int fd, void(*func)(int, void *), void *data)"
  186. .br
  187. .ti -1c
  188. .RI "int fBregister_writefdfP (int fd, void(*func)(int, void *), void *data)"
  189. .br
  190. .ti -1c
  191. .RI "int fBregister_exceptfdfP (int fd, void(*func)(int, void *), void *data)"
  192. .br
  193. .ti -1c
  194. .RI "int fBunregister_readfdfP (int fd)"
  195. .br
  196. .ti -1c
  197. .RI "int fBunregister_writefdfP (int fd)"
  198. .br
  199. .ti -1c
  200. .RI "int fBunregister_exceptfdfP (int fd)"
  201. .br
  202. .ti -1c
  203. .RI "RETSIGTYPE fBagent_SIGCHLD_handlerfP (int sig)"
  204. .br
  205. .ti -1c
  206. .RI "int fBregister_signalfP (int sig, void(*func)(int))"
  207. .br
  208. .ti -1c
  209. .RI "int fBunregister_signalfP (int sig)"
  210. .br
  211. .in -1c
  212. .SS "Variables"
  214. .in +1c
  215. .ti -1c
  216. .RI "fBsubtree_context_cachefP * fBcontext_subtreesfP = NULL"
  217. .br
  218. .ti -1c
  219. .RI "int fBlookup_cache_sizefP = 0"
  220. .br
  221. .ti -1c
  222. .RI "fBnetsnmp_subtreefP * fBlookup_cache_s::previousfP"
  223. .br
  224. .ti -1c
  225. .RI "fBlookup_cache_context_sfP * fBlookup_cache_context_s::nextfP"
  226. .br
  227. .ti -1c
  228. .RI "int fBlookup_cache_context_s::thecachecountfP"
  229. .br
  230. .ti -1c
  231. .RI "int fBlookup_cache_context_s::currentposfP"
  232. .br
  233. .ti -1c
  234. .RI "fBlookup_cachefP fBlookup_cache_context_s::cachefP [SUBTREE_MAX_CACHE_SIZE]"
  235. .br
  236. .ti -1c
  237. .RI "int fBexternal_readfdfP [NUM_EXTERNAL_FDS]"
  238. .br
  239. .ti -1c
  240. .RI "int fBexternal_readfdlenfP = 0"
  241. .br
  242. .ti -1c
  243. .RI "int fBexternal_writefdfP [NUM_EXTERNAL_FDS]"
  244. .br
  245. .ti -1c
  246. .RI "int fBexternal_writefdlenfP = 0"
  247. .br
  248. .ti -1c
  249. .RI "int fBexternal_exceptfdfP [NUM_EXTERNAL_FDS]"
  250. .br
  251. .ti -1c
  252. .RI "int fBexternal_exceptfdlenfP = 0"
  253. .br
  254. .ti -1c
  255. .RI "void(* fBexternal_readfdfuncfP [NUM_EXTERNAL_FDS])(int, void *)"
  256. .br
  257. .ti -1c
  258. .RI "void(* fBexternal_writefdfuncfP [NUM_EXTERNAL_FDS])(int, void *)"
  259. .br
  260. .ti -1c
  261. .RI "void(* fBexternal_exceptfdfuncfP [NUM_EXTERNAL_FDS])(int, void *)"
  262. .br
  263. .ti -1c
  264. .RI "void * fBexternal_readfd_datafP [NUM_EXTERNAL_FDS]"
  265. .br
  266. .ti -1c
  267. .RI "void * fBexternal_writefd_datafP [NUM_EXTERNAL_FDS]"
  268. .br
  269. .ti -1c
  270. .RI "void * fBexternal_exceptfd_datafP [NUM_EXTERNAL_FDS]"
  271. .br
  272. .ti -1c
  273. .RI "int fBexternal_signal_scheduledfP [NUM_EXTERNAL_SIGS]"
  274. .br
  275. .ti -1c
  276. .RI "void(* fBexternal_signal_handlerfP [NUM_EXTERNAL_SIGS])(int)"
  277. .br
  278. .in -1c
  279. .SH "Function Documentation"
  280. .PP 
  281. .SS "int netsnmp_acm_check_subtree (fBnetsnmp_pdufP * pdu, oid * name, size_t namelen)"
  282. .PP
  283. checks to see if everything within a given subtree is either: in view, not in view, or possibly both. 
  284. .PP
  285. If the entire subtree is not-in-view we can use this information to skip calling the sub-handlers entirely. 
  286. .PP
  287. fBReturns:fP
  288. .RS 4
  289. 0 if entire subtree is accessible, 5 if not and 7 if portions are both. 1 on error (illegal pdu version).
  290. .RE
  291. .PP
  293. .PP
  294. Definition at line 1265 of file agent_registry.c.
  295. .PP
  296. 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.
  297. .PP
  298. Referenced by netsnmp_add_varbind_to_cache().
  299. .SS "int netsnmp_get_lookup_cache_size (void)"
  300. .PP
  301. retrieves the current value of the lookup cache size 
  302. .PP
  303. fBReturns:fP
  304. .RS 4
  305. the current lookup cache size
  306. .RE
  307. .PP
  309. .PP
  310. Definition at line 1338 of file agent_registry.c.
  311. .PP
  312. Referenced by netsnmp_register_mib(), and unregister_mib_context().
  313. .SS "void netsnmp_set_lookup_cache_size (int newsize)"
  314. .PP
  315. set the lookup cache size for optimized agent registration performance. 
  316. .PP
  317. fBParameters:fP
  318. .RS 4
  319. fInewsizefP 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.
  320. .RE
  321. .PP
  323. .PP
  324. Definition at line 1325 of file agent_registry.c.
  325. .PP
  326. References SUBTREE_DEFAULT_CACHE_SIZE, and SUBTREE_MAX_CACHE_SIZE.
  327. .PP
  328. Referenced by init_master_agent(), netsnmp_register_mib(), and unregister_mib_context().
  329. .SS "int unregister_mib_context (oid * name, size_t len, int priority, int range_subid, oid range_ubound, const char * context)"
  330. .PP
  331. Unregisters an OID that has an associated context name value. 
  332. .PP
  333. 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.
  334. .PP
  335. fBParameters:fP
  336. .RS 4
  337. fInamefP the specific OID to unregister if it conatins the associated context.
  338. .br
  339. fIlenfP the length of the OID, use OID_LENGTH macro.
  340. .br
  341. fIpriorityfP a value between 1 and 255, used to achieve a desired configuration when different sessions register identical or overlapping regions. Subagents with no particular knowledge of priority should register with the default value of 127.
  342. .br
  343. fIrange_subidfP permits specifying a range in place of one of a subtree sub-identifiers. When this value is zero, no range is being specified.
  344. .br
  345. fIrange_uboundfP the upper bound of a sub-identifier's range. This field is present only if range_subid is not 0.
  346. .br
  347. fIcontextfP a context name that has been created
  348. .RE
  349. .PP
  350. fBReturns:fP
  351. .RS 4
  352. .RE
  353. .PP
  355. .PP
  356. Definition at line 937 of file agent_registry.c.
  357. .PP
  358. References netsnmp_subtree_s::children, invalidate_lookup_cache(), netsnmp_subtree_s::name_a, netsnmp_subtree_s::namelen, 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, NULL, netsnmp_subtree_s::priority, and snmp_call_callbacks().
  359. .PP
  360. Referenced by netsnmp_register_mib(), netsnmp_unregister_handler(), remove_tree_entry(), and unregister_mib_range().