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

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

SNMP编程

开发平台：

Unix_Linux

netsnmp_library.3：源码内容
  1. .TH "The Net-SNMP library" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. The Net-SNMP library - 
  6. .SS "Modules"
  8. .in +1c
  9. .ti -1c
  10. .RI "fBasn1 parsing and datatype manipulation routines.fP"
  11. .br
  12. .RI "fINote on. fP"
  13. .PP
  14. .in +1c
  16. .ti -1c
  17. .RI "fBA generic callback mechanismfP"
  18. .br
  19. .ti -1c
  20. .RI "fBgeneric linked-list data handling with a string as a key.fP"
  21. .br
  22. .ti -1c
  23. .RI "fBstorage space for defaultsfP"
  24. .br
  25. .RI "fIThe purpose of the default storage is three-fold:. fP"
  26. .PP
  27. .in +1c
  29. .ti -1c
  30. .RI "fBmib parsing and datatype manipulation routines.fP"
  31. .br
  32. .ti -1c
  33. .RI "fBStore and retrieve data referenced by an OID.fP"
  34. .br
  35. .RI "fIThis is essentially a way of storing data associated with a given OID. fP"
  36. .PP
  37. .in +1c
  39. .ti -1c
  40. .RI "fBparsing various configuration files at run timefP"
  41. .br
  42. .RI "fIThe read_config related functions are a fairly extensible system of parsing various configuration files at the run time. fP"
  43. .PP
  44. .in +1c
  46. .ti -1c
  47. .RI "fBgeneric library based alarm timers for various parts of an applicationfP"
  48. .br
  49. .ti -1c
  50. .RI "fBvarious PDU processing routinesfP"
  51. .br
  52. .ti -1c
  53. .RI "fBgeneric logging for net-snmpfP"
  54. .br
  55. .ti -1c
  56. .RI "fBMemory Utility RoutinesfP"
  57. .br
  58. .in -1c
  59. .SS "Data Structures"
  61. .in +1c
  62. .ti -1c
  63. .RI "struct fBsnmp_internal_sessionfP"
  64. .br
  65. .ti -1c
  66. .RI "struct fBsession_listfP"
  67. .br
  68. .in -1c
  69. .SS "Defines"
  71. .in +1c
  72. .ti -1c
  73. .RI "#define fBMINfP(a, b)   (((a) < (b)) ? (a) : (b))"
  74. .br
  75. .ti -1c
  76. .RI "#define fBMIB_CLIENTS_ARE_EVILfP   1"
  77. .br
  78. .ti -1c
  79. .RI "#define fB_init_agent_callback_transportfP()"
  80. .br
  81. .ti -1c
  82. .RI "#define fBSNMP_NEED_REQUEST_LISTfP"
  83. .br
  84. .ti -1c
  85. .RI "#define fBtimercmpfP(tvp, uvp, cmp)"
  86. .br
  87. .ti -1c
  88. .RI "#define fBtimerclearfP(tvp)   (tvp)->tv_sec = (tvp)->tv_usec = 0"
  89. .br
  90. .ti -1c
  91. .RI "#define fBMAX_PACKET_LENGTHfP   (0x7fffffff)"
  92. .br
  93. .ti -1c
  94. .RI "#define fBNETSNMP_STREAM_QUEUE_LENfP   5"
  95. .br
  96. .ti -1c
  97. .RI "#define fBBSD4_2fP"
  98. .br
  99. .ti -1c
  100. .RI "#define fBNFDBITSfP   (sizeof(fBfd_maskfP) * NBBY)"
  101. .br
  102. .ti -1c
  103. .RI "#define fBFD_SETfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))"
  104. .br
  105. .ti -1c
  106. .RI "#define fBFD_CLRfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))"
  107. .br
  108. .ti -1c
  109. .RI "#define fBFD_ISSETfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))"
  110. .br
  111. .ti -1c
  112. .RI "#define fBFD_ZEROfP(p)   memset((p), 0, sizeof(*(p)))"
  113. .br
  114. .ti -1c
  115. .RI "#define fBDEFAULT_COMMUNITYfP   'public'"
  116. .br
  117. .ti -1c
  118. .RI "#define fBDEFAULT_RETRIESfP   5"
  119. .br
  120. .ti -1c
  121. .RI "#define fBDEFAULT_TIMEOUTfP   1000000L"
  122. .br
  123. .ti -1c
  124. .RI "#define fBDEFAULT_REMPORTfP   SNMP_PORT"
  125. .br
  126. .ti -1c
  127. .RI "#define fBDEFAULT_ENTERPRISEfP   default_enterprise"
  128. .br
  129. .ti -1c
  130. .RI "#define fBDEFAULT_TIMEfP   0"
  131. .br
  132. .ti -1c
  133. .RI "#define fBMAXIMUM_PACKET_SIZEfP   0x7fffffff"
  134. .br
  135. .ti -1c
  136. .RI "#define fBDEBUGPRINTPDUTYPEfP(token, type)   DEBUGDUMPSECTION(token, snmp_pdu_type(type))"
  137. .br
  138. .ti -1c
  139. .RI "#define fBERROR_STAT_LENGTHfP   11"
  140. .br
  141. .in -1c
  142. .SS "Typedefs"
  144. .in +1c
  145. .ti -1c
  146. .RI "typedef long fBfd_maskfP"
  147. .br
  148. .in -1c
  149. .SS "Functions"
  151. .in +1c
  152. .ti -1c
  153. .RI "int fBinit_agentfP (const char *app)"
  154. .br
  155. .RI "fIInitialize the agent. fP"
  156. .ti -1c
  157. .RI "void fBshutdown_agentfP (void)"
  158. .br
  159. .ti -1c
  160. .RI "void fBadd_to_init_listfP (char *module_list)"
  161. .br
  162. .ti -1c
  163. .RI "int fBshould_initfP (const char *module_name)"
  164. .br
  165. .ti -1c
  166. .RI "int fBsnmp_buildfP (u_char **pkt, size_t *pkt_len, size_t *offset, fBnetsnmp_sessionfP *pss, fBnetsnmp_pdufP *pdu)"
  167. .br
  168. .ti -1c
  169. .RI "int fBsnmp_get_errnofP (void)"
  170. .br
  171. .ti -1c
  172. .RI "void fBsnmp_synch_resetfP (fBnetsnmp_sessionfP *notused)"
  173. .br
  174. .ti -1c
  175. .RI "void fBsnmp_synch_setupfP (fBnetsnmp_sessionfP *notused)"
  176. .br
  177. .ti -1c
  178. .RI "const char * fBstrerrorfP (int err)"
  179. .br
  180. .ti -1c
  181. .RI "const char * fBsnmp_pdu_typefP (int type)"
  182. .br
  183. .ti -1c
  184. .RI "long fBsnmp_get_next_reqidfP (void)"
  185. .br
  186. .ti -1c
  187. .RI "long fBsnmp_get_next_msgidfP (void)"
  188. .br
  189. .ti -1c
  190. .RI "long fBsnmp_get_next_sessidfP (void)"
  191. .br
  192. .ti -1c
  193. .RI "long fBsnmp_get_next_transidfP (void)"
  194. .br
  195. .ti -1c
  196. .RI "void fBsnmp_perrorfP (const char *prog_string)"
  197. .br
  198. .ti -1c
  199. .RI "void fBsnmp_set_detailfP (const char *detail_string)"
  200. .br
  201. .ti -1c
  202. .RI "const char * fBsnmp_api_errstringfP (int snmp_errnumber)"
  203. .br
  204. .ti -1c
  205. .RI "void fBsnmp_errorfP (fBnetsnmp_sessionfP *psess, int *p_errno, int *p_snmp_errno, char **p_str)"
  206. .br
  207. .ti -1c
  208. .RI "void fBsnmp_sess_errorfP (void *sessp, int *p_errno, int *p_snmp_errno, char **p_str)"
  209. .br
  210. .ti -1c
  211. .RI "void fBnetsnmp_sess_log_errorfP (int priority, const char *prog_string, fBnetsnmp_sessionfP *ss)"
  212. .br
  213. .ti -1c
  214. .RI "void fBsnmp_sess_perrorfP (const char *prog_string, fBnetsnmp_sessionfP *ss)"
  215. .br
  216. .ti -1c
  217. .RI "void fBsnmp_sess_initfP (fBnetsnmp_sessionfP *session)"
  218. .br
  219. .ti -1c
  220. .RI "void fBinit_snmp_enumsfP (void)"
  221. .br
  222. .ti -1c
  223. .RI "void fBinit_snmpfP (const char *type)"
  224. .br
  225. .RI "fICalls the functions to do config file loading and mib module parsing in the correct order. fP"
  226. .ti -1c
  227. .RI "void fBsnmp_storefP (const char *type)"
  228. .br
  229. .ti -1c
  230. .RI "void fBsnmp_shutdownfP (const char *type)"
  231. .br
  232. .RI "fIShuts down the application, saving any needed persistent storage, and appropriate clean up. fP"
  233. .ti -1c
  234. .RI "fBnetsnmp_sessionfP * fBsnmp_openfP (fBnetsnmp_sessionfP *session)"
  235. .br
  236. .ti -1c
  237. .RI "fBnetsnmp_sessionfP * fBsnmp_open_exfP (fBnetsnmp_sessionfP *session, int(*fpre_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int), int(*fparse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t), int(*fpost_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int), int(*fbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t *), int(*frbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char **, size_t *, size_t *), int(*fcheck)(u_char *, size_t))"
  238. .br
  239. .ti -1c
  240. .RI "int fBsnmpv3_engineID_probefP (struct fBsession_listfP *slp, fBnetsnmp_sessionfP *in_session)"
  241. .br
  242. .RI "fIprobe for peer engineID fP"
  243. .ti -1c
  244. .RI "fBnetsnmp_sessionfP * fBsnmp_addfP (fBnetsnmp_sessionfP *in_session, fBnetsnmp_transportfP *transport, int(*fpre_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int), int(*fpost_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int))"
  245. .br
  246. .ti -1c
  247. .RI "fBnetsnmp_sessionfP * fBsnmp_add_fullfP (fBnetsnmp_sessionfP *in_session, fBnetsnmp_transportfP *transport, int(*fpre_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int), int(*fparse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t), int(*fpost_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int), int(*fbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t *), int(*frbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char **, size_t *, size_t *), int(*fcheck)(u_char *, size_t), fBnetsnmp_pdufP *(*fcreate_pdu)(fBnetsnmp_transportfP *, void *, size_t))"
  248. .br
  249. .ti -1c
  250. .RI "void * fBsnmp_sess_add_exfP (fBnetsnmp_sessionfP *in_session, fBnetsnmp_transportfP *transport, int(*fpre_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int), int(*fparse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t), int(*fpost_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int), int(*fbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t *), int(*frbuild)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char **, size_t *, size_t *), int(*fcheck)(u_char *, size_t), fBnetsnmp_pdufP *(*fcreate_pdu)(fBnetsnmp_transportfP *, void *, size_t))"
  251. .br
  252. .ti -1c
  253. .RI "void * fBsnmp_sess_addfP (fBnetsnmp_sessionfP *in_session, fBnetsnmp_transportfP *transport, int(*fpre_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int), int(*fpost_parse)(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int))"
  254. .br
  255. .ti -1c
  256. .RI "void * fBsnmp_sess_openfP (fBnetsnmp_sessionfP *pss)"
  257. .br
  258. .ti -1c
  259. .RI "int fBcreate_user_from_sessionfP (fBnetsnmp_sessionfP *session)"
  260. .br
  261. .ti -1c
  262. .RI "int fBsnmp_sess_closefP (void *sessp)"
  263. .br
  264. .ti -1c
  265. .RI "int fBsnmp_closefP (fBnetsnmp_sessionfP *session)"
  266. .br
  267. .ti -1c
  268. .RI "int fBsnmp_close_sessionsfP (void)"
  269. .br
  270. .ti -1c
  271. .RI "int fBsnmpv3_packet_buildfP (fBnetsnmp_sessionfP *session, fBnetsnmp_pdufP *pdu, u_char *packet, size_t *out_length, u_char *pdu_data, size_t pdu_data_len)"
  272. .br
  273. .ti -1c
  274. .RI "u_char * fBsnmp_pdu_buildfP (fBnetsnmp_pdufP *pdu, u_char *cp, size_t *out_length)"
  275. .br
  276. .ti -1c
  277. .RI "int fBsnmpv3_parsefP (fBnetsnmp_pdufP *pdu, u_char *data, size_t *length, u_char **after_header, fBnetsnmp_sessionfP *sess)"
  278. .br
  279. .ti -1c
  280. .RI "int fBsnmpv3_make_reportfP (fBnetsnmp_pdufP *pdu, int error)"
  281. .br
  282. .ti -1c
  283. .RI "int fBsnmpv3_get_report_typefP (fBnetsnmp_pdufP *pdu)"
  284. .br
  285. .ti -1c
  286. .RI "int fBsnmp_pdu_parsefP (fBnetsnmp_pdufP *pdu, u_char *data, size_t *length)"
  287. .br
  288. .ti -1c
  289. .RI "u_char * fBsnmpv3_scopedPDU_parsefP (fBnetsnmp_pdufP *pdu, u_char *cp, size_t *length)"
  290. .br
  291. .ti -1c
  292. .RI "int fBsnmp_sendfP (fBnetsnmp_sessionfP *session, fBnetsnmp_pdufP *pdu)"
  293. .br
  294. .ti -1c
  295. .RI "int fBsnmp_sess_sendfP (void *sessp, fBnetsnmp_pdufP *pdu)"
  296. .br
  297. .ti -1c
  298. .RI "int fBsnmp_async_sendfP (fBnetsnmp_sessionfP *session, fBnetsnmp_pdufP *pdu, snmp_callback callback, void *cb_data)"
  299. .br
  300. .ti -1c
  301. .RI "int fBsnmp_sess_async_sendfP (void *sessp, fBnetsnmp_pdufP *pdu, snmp_callback callback, void *cb_data)"
  302. .br
  303. .ti -1c
  304. .RI "void fBsnmp_free_varfP (fBnetsnmp_variable_listfP *var)"
  305. .br
  306. .ti -1c
  307. .RI "void fBsnmp_free_varbindfP (fBnetsnmp_variable_listfP *var)"
  308. .br
  309. .ti -1c
  310. .RI "void fBsnmp_free_pdufP (fBnetsnmp_pdufP *pdu)"
  311. .br
  312. .ti -1c
  313. .RI "fBnetsnmp_pdufP * fBsnmp_create_sess_pdufP (fBnetsnmp_transportfP *transport, void *opaque, size_t olength)"
  314. .br
  315. .ti -1c
  316. .RI "void fBsnmp_readfP (fd_set *fdset)"
  317. .br
  318. .ti -1c
  319. .RI "int fB_sess_readfP (void *sessp, fd_set *fdset)"
  320. .br
  321. .ti -1c
  322. .RI "int fBsnmp_sess_readfP (void *sessp, fd_set *fdset)"
  323. .br
  324. .ti -1c
  325. .RI "int fBsnmp_select_infofP (int *numfds, fd_set *fdset, struct timeval *timeout, int *block)"
  326. .br
  327. .ti -1c
  328. .RI "int fBsnmp_sess_select_infofP (void *sessp, int *numfds, fd_set *fdset, struct timeval *timeout, int *block)"
  329. .br
  330. .ti -1c
  331. .RI "void fBsnmp_timeoutfP (void)"
  332. .br
  333. .ti -1c
  334. .RI "void fBsnmp_sess_timeoutfP (void *sessp)"
  335. .br
  336. .ti -1c
  337. .RI "int fBsnmp_oid_ncomparefP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2, size_t max_len)"
  338. .br
  339. .ti -1c
  340. .RI "int fBsnmp_oid_comparefP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
  341. .br
  342. .RI "fIlexicographical compare two object identifiers. fP"
  343. .ti -1c
  344. .RI "int fBsnmp_oidtree_comparefP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
  345. .br
  346. .RI "fICompares 2 OIDs to determine if they are equal up until the shortest length. fP"
  347. .ti -1c
  348. .RI "int fBnetsnmp_oid_equalsfP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
  349. .br
  350. .RI "fICompares 2 OIDs to determine if they are exactly equal. fP"
  351. .ti -1c
  352. .RI "int fBnetsnmp_oid_is_subtreefP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
  353. .br
  354. .RI "fIIdentical to netsnmp_oid_equals, except only the length up to len1 is compared. fP"
  355. .ti -1c
  356. .RI "int fBnetsnmp_oid_find_prefixfP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
  357. .br
  358. .RI "fIGiven two OIDs, determine the common prefix to them both. fP"
  359. .ti -1c
  360. .RI "fBnetsnmp_variable_listfP * fBsnmp_pdu_add_variablefP (fBnetsnmp_pdufP *pdu, const oid *name, size_t name_length, u_char type, const u_char *value, size_t len)"
  361. .br
  362. .ti -1c
  363. .RI "fBnetsnmp_variable_listfP * fBsnmp_varlist_add_variablefP (fBnetsnmp_variable_listfP **varlist, const oid *name, size_t name_length, u_char type, const u_char *value, size_t len)"
  364. .br
  365. .ti -1c
  366. .RI "int fBsnmp_add_varfP (fBnetsnmp_pdufP *pdu, const oid *name, size_t name_length, char type, const char *value)"
  367. .br
  368. .ti -1c
  369. .RI "void * fBsnmp_sess_pointerfP (fBnetsnmp_sessionfP *session)"
  370. .br
  371. .ti -1c
  372. .RI "fBnetsnmp_sessionfP * fBsnmp_sess_sessionfP (void *sessp)"
  373. .br
  374. .ti -1c
  375. .RI "fBnetsnmp_transportfP * fBsnmp_sess_transportfP (void *sessp)"
  376. .br
  377. .ti -1c
  378. .RI "void fBsnmp_sess_transport_setfP (void *sp, fBnetsnmp_transportfP *t)"
  379. .br
  380. .ti -1c
  381. .RI "oid * fBsnmp_duplicate_objidfP (const oid *objToCopy, size_t objToCopyLen)"
  382. .br
  383. .ti -1c
  384. .RI "u_int fBsnmp_increment_statisticfP (int which)"
  385. .br
  386. .ti -1c
  387. .RI "u_int fBsnmp_increment_statistic_byfP (int which, int count)"
  388. .br
  389. .ti -1c
  390. .RI "u_int fBsnmp_get_statisticfP (int which)"
  391. .br
  392. .ti -1c
  393. .RI "void fBsnmp_init_statisticsfP (void)"
  394. .br
  395. .in -1c
  396. .SS "Variables"
  398. .in +1c
  399. .ti -1c
  400. .RI "fBmodule_init_listfP * fBinitlistfP = NULL"
  401. .br
  402. .ti -1c
  403. .RI "fBmodule_init_listfP * fBnoinitlistfP = NULL"
  404. .br
  405. .ti -1c
  406. .RI "fBnetsnmp_subtreefP * fBsubtreesfP"
  407. .br
  408. .ti -1c
  409. .RI "long fBlong_returnfP"
  410. .br
  411. .ti -1c
  412. .RI "u_char fBreturn_buffP [258]"
  413. .br
  414. .ti -1c
  415. .RI "timeval fBstarttimefP"
  416. .br
  417. .ti -1c
  418. .RI "int fBcallback_master_numfP = -1"
  419. .br
  420. .ti -1c
  421. .RI "oid fBnullOidfP [] = { 0, 0 }"
  422. .br
  423. .ti -1c
  424. .RI "int fBnullOidLenfP = sizeof(fBnullOidfP)"
  425. .br
  426. .ti -1c
  427. .RI "netsnmp_request_list * fBsnmp_internal_session::requestsEndfP"
  428. .br
  429. .ti -1c
  430. .RI "int(* fBsnmp_internal_session::hook_prefP )(fBnetsnmp_sessionfP *, fBnetsnmp_transportfP *, void *, int)"
  431. .br
  432. .ti -1c
  433. .RI "int(* fBsnmp_internal_session::hook_parsefP )(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t)"
  434. .br
  435. .ti -1c
  436. .RI "int(* fBsnmp_internal_session::hook_postfP )(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, int)"
  437. .br
  438. .ti -1c
  439. .RI "int(* fBsnmp_internal_session::hook_buildfP )(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char *, size_t *)"
  440. .br
  441. .ti -1c
  442. .RI "int(* fBsnmp_internal_session::hook_realloc_buildfP )(fBnetsnmp_sessionfP *, fBnetsnmp_pdufP *, u_char **, size_t *, size_t *)"
  443. .br
  444. .ti -1c
  445. .RI "int(* fBsnmp_internal_session::check_packetfP )(u_char *, size_t)"
  446. .br
  447. .ti -1c
  448. .RI "fBnetsnmp_pdufP *(* fBsnmp_internal_session::hook_create_pdufP )(fBnetsnmp_transportfP *, void *, size_t)"
  449. .br
  450. .ti -1c
  451. .RI "u_char * fBsnmp_internal_session::packetfP"
  452. .br
  453. .ti -1c
  454. .RI "size_t fBsnmp_internal_session::packet_lenfP"
  455. .br
  456. .ti -1c
  457. .RI "size_t fBsnmp_internal_session::packet_sizefP"
  458. .br
  459. .ti -1c
  460. .RI "fBnetsnmp_sessionfP * fBsession_list::sessionfP"
  461. .br
  462. .ti -1c
  463. .RI "fBnetsnmp_transportfP * fBsession_list::transportfP"
  464. .br
  465. .ti -1c
  466. .RI "fBsnmp_internal_sessionfP * fBsession_list::internalfP"
  467. .br
  468. .ti -1c
  469. .RI "fBsession_listfP * fBSessionsfP = NULL"
  470. .br
  471. .ti -1c
  472. .RI "int fBsnmp_errnofP = 0"
  473. .br
  474. .in -1c
  475. .SH "Define Documentation"
  476. .PP 
  477. .SS "#define timercmp(tvp, uvp, cmp)"
  478. .PP
  479. fBValue:fP
  480. .PP
  481. .nf
  482. /* CSTYLED */ 
  483.         ((tvp)->tv_sec cmp (uvp)->tv_sec || 
  484.         ((tvp)->tv_sec == (uvp)->tv_sec && 
  485.         /* CSTYLED */ 
  486.         (tvp)->tv_usec cmp (uvp)->tv_usec))
  487. .fi
  488. .PP
  489. Definition at line 146 of file snmp_api.c.
  490. .PP
  491. Referenced by netsnmp_addrcache_add(), snmp_sess_select_info(), and snmp_sess_timeout().
  492. .SH "Function Documentation"
  493. .PP 
  494. .SS "int _sess_read (void * sessp, fd_set * fdset)"
  495. .PP
  496. XXX-rks: why no SNMP_FREE(isp->packet); ??
  497. .PP
  498. XXX-rks: why no SNMP_FREE(isp->packet); ?? 
  499. .PP
  500. Definition at line 5340 of file snmp_api.c.
  501. .PP
  502. References asn_check_packet(), snmp_session::callback, snmp_session::callback_magic, snmp_internal_session::check_packet, netsnmp_transport_s::f_accept, netsnmp_transport_s::f_close, netsnmp_transport_s::f_recv, FD_ISSET, netsnmp_transport_s::flags, snmp_internal_session::hook_build, snmp_internal_session::hook_create_pdu, snmp_internal_session::hook_parse, snmp_internal_session::hook_post, snmp_internal_session::hook_pre, snmp_internal_session::hook_realloc_build, session_list::internal, MAX_PACKET_LENGTH, MAXIMUM_PACKET_SIZE, session_list::next, NULL, snmp_internal_session::packet, snmp_internal_session::packet_len, snmp_internal_session::packet_size, snmp_session::s_errno, snmp_session::s_snmp_errno, session_list::session, SNMP_FREE, snmp_log(), snmp_sess_add_ex(), snmp_set_detail(), netsnmp_transport_s::sock, strerror(), and session_list::transport.
  503. .PP
  504. Referenced by snmp_sess_read().
  505. .SS "int init_agent (const char * app)"
  506. .PP
  507. Initialize the agent. 
  508. .PP
  509. Calls into init_agent_read_config to set tha app's configuration file in the appropriate default storage space, NETSNMP_DS_LIB_APPTYPE. Need to call init_agent before calling init_snmp.
  510. .PP
  511. fBParameters:fP
  512. .RS 4
  513. fIappfP the configuration file to be read in, gets stored in default storage
  514. .RE
  515. .PP
  516. fBReturns:fP
  517. .RS 4
  518. Returns non-zero on failure and zero on success.
  519. .RE
  520. .PP
  521. fBSee also:fP
  522. .RS 4
  523. fBinit_snmpfP
  524. .RE
  525. .PP
  527. .PP
  528. Definition at line 272 of file snmp_vars.c.
  529. .PP
  530. References _init_agent_callback_transport, init_traps(), netsnmp_ds_get_boolean(), netsnmp_ds_set_boolean(), netsnmp_init_helpers(), NULL, setup_tree(), snmp_log(), and starttime.
  531. .SS "void init_snmp (const char * type)"
  532. .PP
  533. Calls the functions to do config file loading and mib module parsing in the correct order. 
  534. .PP
  535. fBParameters:fP
  536. .RS 4
  537. fItypefP label for the config file 'type'
  538. .RE
  539. .PP
  540. fBReturns:fP
  541. .RS 4
  542. void
  543. .RE
  544. .PP
  545. fBSee also:fP
  546. .RS 4
  547. fBinit_agentfP
  548. .RE
  549. .PP
  551. .PP
  552. Definition at line 788 of file snmp_api.c.
  553. .PP
  554. References init_callbacks(), init_mib(), init_snmp_alarm(), init_snmp_enums(), init_snmp_logging(), netsnmp_ds_get_string(), netsnmp_ds_set_string(), read_configs(), read_premib_configs(), register_mib_handlers(), and snmp_init_statistics().
  555. .SS "int netsnmp_oid_equals (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
  556. .PP
  557. Compares 2 OIDs to determine if they are exactly equal. 
  558. .PP
  559. This should be faster than doing a snmp_oid_compare for different length OIDs, since the length is checked first and if != returns immediately. Might be very slighly faster if lengths are ==. 
  560. .PP
  561. fBParameters:fP
  562. .RS 4
  563. fIin_name1fP A pointer to the first oid. 
  564. .br
  565. fIlen1fP length of the first OID (in segments, not bytes) 
  566. .br
  567. fIin_name2fP A pointer to the second oid. 
  568. .br
  569. fIlen2fP length of the second OID (in segments, not bytes) 
  570. .RE
  571. .PP
  572. fBReturns:fP
  573. .RS 4
  574. 0 if they are equal, 1 if they are not.
  575. .RE
  576. .PP
  578. .PP
  579. Definition at line 6280 of file snmp_api.c.
  580. .PP
  581. Referenced by netsnmp_cache_find_by_oid(), netsnmp_old_api_helper(), netsnmp_subtree_free(), netsnmp_subtree_load(), netsnmp_unregister_mib_table_row(), and unregister_mib_context().
  582. .SS "int netsnmp_oid_find_prefix (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
  583. .PP
  584. Given two OIDs, determine the common prefix to them both. 
  585. .PP
  586. fBParameters:fP
  587. .RS 4
  588. fIin_name1fP A pointer to the first oid. 
  589. .br
  590. fIlen1fP Length of the first oid. 
  591. .br
  592. fIin_name2fP A pointer to the second oid. 
  593. .br
  594. fIlen2fP Length of the second oid. 
  595. .RE
  596. .PP
  597. fBReturns:fP
  598. .RS 4
  599. length of largest common index of commonality. 1 = first, 0 if none * or -1 on error.
  600. .RE
  601. .PP
  603. .PP
  604. Definition at line 6336 of file snmp_api.c.
  605. .PP
  606. References SNMP_MIN.
  607. .PP
  608. Referenced by netsnmp_add_varbind_to_cache().
  609. .SS "int netsnmp_oid_is_subtree (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
  610. .PP
  611. Identical to netsnmp_oid_equals, except only the length up to len1 is compared. 
  612. .PP
  613. Functionally, this determines if in_name2 is equal or a subtree of in_name1 
  614. .PP
  615. fBParameters:fP
  616. .RS 4
  617. fIin_name1fP A pointer to the first oid. 
  618. .br
  619. fIlen1fP length of the first OID (in segments, not bytes) 
  620. .br
  621. fIin_name2fP A pointer to the second oid. 
  622. .br
  623. fIlen2fP length of the second OID (in segments, not bytes) 
  624. .RE
  625. .PP
  626. fBReturns:fP
  627. .RS 4
  628. 0 if one is a common prefix of the other.
  629. .RE
  630. .PP
  632. .PP
  633. Definition at line 6316 of file snmp_api.c.
  634. .SS "int snmp_oid_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
  635. .PP
  636. lexicographical compare two object identifiers. 
  637. .PP
  638. Caution: this method is called often by command responder applications (ie, agent).
  639. .PP
  640. fBReturns:fP
  641. .RS 4
  642. -1 if name1 < name2, 0 if name1 = name2, 1 if name1 > name2
  643. .RE
  644. .PP
  646. .PP
  647. Definition at line 6212 of file snmp_api.c.
  648. .PP
  649. Referenced by check_getnext_results(), convert_v2pdu_to_v1(), find_varbind_in_list(), lookup_cache_find(), netsnmp_check_getnext_reply(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_helper_handler(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_subtree_compare(), netsnmp_subtree_find(), netsnmp_subtree_find_next(), netsnmp_subtree_find_prev(), netsnmp_subtree_load(), netsnmp_subtree_split(), netsnmp_table_data_add_row(), netsnmp_table_data_get_from_oid(), netsnmp_table_data_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_oidtree_compare(), and table_helper_handler().
  650. .SS "int snmp_oidtree_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
  651. .PP
  652. Compares 2 OIDs to determine if they are equal up until the shortest length. 
  653. .PP
  654. fBParameters:fP
  655. .RS 4
  656. fIin_name1fP A pointer to the first oid. 
  657. .br
  658. fIlen1fP length of the first OID (in segments, not bytes) 
  659. .br
  660. fIin_name2fP A pointer to the second oid. 
  661. .br
  662. fIlen2fP length of the second OID (in segments, not bytes) 
  663. .RE
  664. .PP
  665. fBReturns:fP
  666. .RS 4
  667. 0 if they are equal, 1 if in_name1 is > in_name2, or -1 if <.
  668. .RE
  669. .PP
  671. .PP
  672. Definition at line 6261 of file snmp_api.c.
  673. .PP
  674. References snmp_oid_compare().
  675. .SS "void snmp_shutdown (const char * type)"
  676. .PP
  677. Shuts down the application, saving any needed persistent storage, and appropriate clean up. 
  678. .PP
  679. fBParameters:fP
  680. .RS 4
  681. fItypefP Label for the config file 'type' used
  682. .RE
  683. .PP
  684. fBReturns:fP
  685. .RS 4
  686. void
  687. .RE
  688. .PP
  690. .PP
  691. Definition at line 856 of file snmp_api.c.
  692. .PP
  693. References clear_callback(), netsnmp_ds_shutdown(), NULL, shutdown_mib(), snmp_alarm_unregister_all(), snmp_call_callbacks(), snmp_close_sessions(), snmp_store(), and unregister_all_config_handlers().
  694. .SS "int snmpv3_engineID_probe (struct fBsession_listfP * slp, fBnetsnmp_sessionfP * in_session)"
  695. .PP
  696. probe for peer engineID 
  697. .PP
  698. fBParameters:fP
  699. .RS 4
  700. fIslpfP session list pointer. 
  701. .br
  702. fIin_sessionfP session for errors
  703. .RE
  704. .PP
  705. fBNote:fP
  706. .RS 4
  707. .IP "(bu" 2
  708. called by _sess_open(), fBsnmp_sess_add_ex()fP
  709. .IP "(bu" 2
  710. in_session is the user supplied session provided to those functions.
  711. .IP "(bu" 2
  712. the first session in slp should the internal allocated copy of in_session
  713. .PP
  714. .RE
  715. .PP
  716. fBReturns:fP
  717. .RS 4
  718. 0 : error 
  719. .PP
  720. 1 : ok
  721. .RE
  722. .PP
  724. .PP
  725. Definition at line 1272 of file snmp_api.c.
  726. .PP
  727. References create_user_from_session(), snmp_session::engineBoots, snmp_session::engineTime, snmp_session::flags, NULL, snmp_session::s_snmp_errno, snmp_session::securityEngineID, snmp_session::securityEngineIDLen, session_list::session, snmp_api_errstring(), snmp_errstring(), snmp_sess_synch_response(), TRUE, and snmp_session::version.
  728. .PP
  729. Referenced by snmp_sess_add_ex().