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

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

SNMP编程

开发平台：

Unix_Linux

netsnmp_snmp_pdu.3：源码内容
  1. .TH "snmp_pdu" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. snmp_pdu - The snmp protocol data unit.  
  7. .PP
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. fC#include <snmp_api.h>fP
  12. .PP
  13. .SS "Data Fields"
  15. .in +1c
  16. .ti -1c
  17. .RI "long fBversionfP"
  18. .br
  19. .RI "fIsnmp version fP"
  20. .ti -1c
  21. .RI "int fBcommandfP"
  22. .br
  23. .RI "fIType of this PDU. fP"
  24. .ti -1c
  25. .RI "long fBreqidfP"
  26. .br
  27. .RI "fIRequest id - note: not incremented on retries. fP"
  28. .ti -1c
  29. .RI "long fBmsgidfP"
  30. .br
  31. .RI "fIMessage id for V3 messages note: incremented for each retry. fP"
  32. .ti -1c
  33. .RI "long fBtransidfP"
  34. .br
  35. .RI "fIUnique ID for incoming transactions. fP"
  36. .ti -1c
  37. .RI "long fBsessidfP"
  38. .br
  39. .RI "fISession id for AgentX messages. fP"
  40. .ti -1c
  41. .RI "long fBerrstatfP"
  42. .br
  43. .RI "fIError status (non_repeaters in GetBulk). fP"
  44. .ti -1c
  45. .RI "long fBerrindexfP"
  46. .br
  47. .RI "fIError index (max_repetitions in GetBulk). fP"
  48. .ti -1c
  49. .RI "u_long fBtimefP"
  50. .br
  51. .RI "fIUptime. fP"
  52. .ti -1c
  53. .RI "u_long fBflagsfP"
  54. .br
  55. .ti -1c
  56. .RI "int fBsecurityModelfP"
  57. .br
  58. .ti -1c
  59. .RI "int fBsecurityLevelfP"
  60. .br
  61. .RI "fInoAuthNoPriv, authNoPriv, authPriv fP"
  62. .ti -1c
  63. .RI "int fBmsgParseModelfP"
  64. .br
  65. .ti -1c
  66. .RI "void * fBtransport_datafP"
  67. .br
  68. .RI "fITransport-specific opaque data. fP"
  69. .ti -1c
  70. .RI "int fBtransport_data_lengthfP"
  71. .br
  72. .ti -1c
  73. .RI "const oid * fBtDomainfP"
  74. .br
  75. .RI "fIThe actual transport domain. fP"
  76. .ti -1c
  77. .RI "size_t fBtDomainLenfP"
  78. .br
  79. .ti -1c
  80. .RI "fBnetsnmp_variable_listfP * fBvariablesfP"
  81. .br
  82. .ti -1c
  83. .RI "u_char * fBcommunityfP"
  84. .br
  85. .RI "fIcommunity for outgoing requests. fP"
  86. .ti -1c
  87. .RI "size_t fBcommunity_lenfP"
  88. .br
  89. .RI "fIlength of community name. fP"
  90. .ti -1c
  91. .RI "oid * fBenterprisefP"
  92. .br
  93. .RI "fISystem OID. fP"
  94. .ti -1c
  95. .RI "size_t fBenterprise_lengthfP"
  96. .br
  97. .ti -1c
  98. .RI "long fBtrap_typefP"
  99. .br
  100. .RI "fItrap type fP"
  101. .ti -1c
  102. .RI "long fBspecific_typefP"
  103. .br
  104. .RI "fIspecific type fP"
  105. .ti -1c
  106. .RI "unsigned char fBagent_addrfP [4]"
  107. .br
  108. .RI "fIThis is ONLY used for v1 TRAPs. fP"
  109. .ti -1c
  110. .RI "u_char * fBcontextEngineIDfP"
  111. .br
  112. .RI "fIcontext snmpEngineID fP"
  113. .ti -1c
  114. .RI "size_t fBcontextEngineIDLenfP"
  115. .br
  116. .RI "fILength of contextEngineID. fP"
  117. .ti -1c
  118. .RI "char * fBcontextNamefP"
  119. .br
  120. .RI "fIauthoritative contextName fP"
  121. .ti -1c
  122. .RI "size_t fBcontextNameLenfP"
  123. .br
  124. .RI "fILength of contextName. fP"
  125. .ti -1c
  126. .RI "u_char * fBsecurityEngineIDfP"
  127. .br
  128. .RI "fIauthoritative snmpEngineID for security fP"
  129. .ti -1c
  130. .RI "size_t fBsecurityEngineIDLenfP"
  131. .br
  132. .RI "fILength of securityEngineID. fP"
  133. .ti -1c
  134. .RI "char * fBsecurityNamefP"
  135. .br
  136. .RI "fIon behalf of this principal fP"
  137. .ti -1c
  138. .RI "size_t fBsecurityNameLenfP"
  139. .br
  140. .RI "fILength of securityName. fP"
  141. .ti -1c
  142. .RI "int fBpriorityfP"
  143. .br
  144. .ti -1c
  145. .RI "int fBrange_subidfP"
  146. .br
  147. .ti -1c
  148. .RI "void * fBsecurityStateReffP"
  149. .br
  150. .in -1c
  151. .SH "Detailed Description"
  152. .PP 
  153. The snmp protocol data unit. 
  154. .PP
  155. Definition at line 75 of file snmp_api.h.
  156. .SH "Field Documentation"
  157. .PP 
  158. .SS "unsigned char fBsnmp_pdu::agent_addrfP[4]"
  159. .PP
  160. This is ONLY used for v1 TRAPs. 
  161. .PP
  162. Definition at line 142 of file snmp_api.h.
  163. .PP
  164. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
  165. .SS "int fBsnmp_pdu::commandfP"
  166. .PP
  167. Type of this PDU. 
  168. .PP
  169. Definition at line 83 of file snmp_api.h.
  170. .PP
  171. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), handle_pdu(), handle_snmp_packet(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_check_outstanding_agent_requests(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_send_traps(), netsnmp_wrap_up_request(), save_set_cache(), send_trap_to_sess(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
  172. .SS "u_char* fBsnmp_pdu::communityfP"
  173. .PP
  174. community for outgoing requests. 
  175. .PP
  176. Definition at line 127 of file snmp_api.h.
  177. .PP
  178. Referenced by convert_v1pdu_to_v2(), and snmp_free_pdu().
  179. .SS "size_t fBsnmp_pdu::community_lenfP"
  180. .PP
  181. length of community name. 
  182. .PP
  183. Definition at line 129 of file snmp_api.h.
  184. .PP
  185. Referenced by convert_v1pdu_to_v2().
  186. .SS "u_char* fBsnmp_pdu::contextEngineIDfP"
  187. .PP
  188. context snmpEngineID 
  189. .PP
  190. Definition at line 148 of file snmp_api.h.
  191. .PP
  192. Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
  193. .SS "size_t fBsnmp_pdu::contextEngineIDLenfP"
  194. .PP
  195. Length of contextEngineID. 
  196. .PP
  197. Definition at line 150 of file snmp_api.h.
  198. .PP
  199. Referenced by snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
  200. .SS "char* fBsnmp_pdu::contextNamefP"
  201. .PP
  202. authoritative contextName 
  203. .PP
  204. Definition at line 152 of file snmp_api.h.
  205. .PP
  206. Referenced by netsnmp_create_subtree_cache(), snmp_free_pdu(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
  207. .SS "size_t fBsnmp_pdu::contextNameLenfP"
  208. .PP
  209. Length of contextName. 
  210. .PP
  211. Definition at line 154 of file snmp_api.h.
  212. .PP
  213. Referenced by snmp_pdu_create(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
  214. .SS "oid* fBsnmp_pdu::enterprisefP"
  215. .PP
  216. System OID. 
  217. .PP
  218. Definition at line 135 of file snmp_api.h.
  219. .PP
  220. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_free_pdu(), snmp_pdu_build(), and snmp_pdu_parse().
  221. .SS "long fBsnmp_pdu::errindexfP"
  222. .PP
  223. Error index (max_repetitions in GetBulk). 
  224. .PP
  225. Definition at line 95 of file snmp_api.h.
  226. .PP
  227. Referenced by _reorder_getbulk(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
  228. .SS "long fBsnmp_pdu::errstatfP"
  229. .PP
  230. Error status (non_repeaters in GetBulk). 
  231. .PP
  232. Definition at line 93 of file snmp_api.h.
  233. .PP
  234. Referenced by _reorder_getbulk(), handle_snmp_packet(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
  235. .SS "long fBsnmp_pdu::msgidfP"
  236. .PP
  237. Message id for V3 messages note: incremented for each retry. 
  238. .PP
  239. Definition at line 87 of file snmp_api.h.
  240. .PP
  241. Referenced by snmp_fix_pdu(), snmp_pdu_create(), and snmpv3_parse().
  242. .SS "long fBsnmp_pdu::reqidfP"
  243. .PP
  244. Request id - note: not incremented on retries. 
  245. .PP
  246. Definition at line 85 of file snmp_api.h.
  247. .PP
  248. Referenced by snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
  249. .SS "u_char* fBsnmp_pdu::securityEngineIDfP"
  250. .PP
  251. authoritative snmpEngineID for security 
  252. .PP
  253. Definition at line 156 of file snmp_api.h.
  254. .PP
  255. Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
  256. .SS "size_t fBsnmp_pdu::securityEngineIDLenfP"
  257. .PP
  258. Length of securityEngineID. 
  259. .PP
  260. Definition at line 158 of file snmp_api.h.
  261. .PP
  262. Referenced by snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
  263. .SS "int fBsnmp_pdu::securityLevelfP"
  264. .PP
  265. noAuthNoPriv, authNoPriv, authPriv 
  266. .PP
  267. Definition at line 102 of file snmp_api.h.
  268. .PP
  269. Referenced by snmpv3_make_report(), snmpv3_packet_build(), and snmpv3_parse().
  270. .SS "char* fBsnmp_pdu::securityNamefP"
  271. .PP
  272. on behalf of this principal 
  273. .PP
  274. Definition at line 160 of file snmp_api.h.
  275. .PP
  276. Referenced by snmp_free_pdu(), snmpv3_packet_build(), and snmpv3_parse().
  277. .SS "size_t fBsnmp_pdu::securityNameLenfP"
  278. .PP
  279. Length of securityName. 
  280. .PP
  281. Definition at line 162 of file snmp_api.h.
  282. .PP
  283. Referenced by snmp_pdu_create(), snmpv3_packet_build(), and snmpv3_parse().
  284. .SS "long fBsnmp_pdu::sessidfP"
  285. .PP
  286. Session id for AgentX messages. 
  287. .PP
  288. Definition at line 91 of file snmp_api.h.
  289. .PP
  290. Referenced by send_trap_to_sess().
  291. .SS "long fBsnmp_pdu::specific_typefP"
  292. .PP
  293. specific type 
  294. .PP
  295. Definition at line 140 of file snmp_api.h.
  296. .PP
  297. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
  298. .SS "const oid* fBsnmp_pdu::tDomainfP"
  299. .PP
  300. The actual transport domain. 
  301. .PP
  302. This SHOULD NOT BE FREE()D.
  303. .PP
  304. Definition at line 117 of file snmp_api.h.
  305. .PP
  306. Referenced by snmp_create_sess_pdu().
  307. .SS "u_long fBsnmp_pdu::timefP"
  308. .PP
  309. Uptime. 
  310. .PP
  311. Definition at line 97 of file snmp_api.h.
  312. .PP
  313. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
  314. .SS "long fBsnmp_pdu::transidfP"
  315. .PP
  316. Unique ID for incoming transactions. 
  317. .PP
  318. Definition at line 89 of file snmp_api.h.
  319. .PP
  320. Referenced by check_delayed_request(), get_set_cache(), netsnmp_check_transaction_id(), netsnmp_create_delegated_cache(), and save_set_cache().
  321. .SS "void* fBsnmp_pdu::transport_datafP"
  322. .PP
  323. Transport-specific opaque data. 
  324. .PP
  325. This replaces the IP-centric address field.
  326. .PP
  327. Definition at line 110 of file snmp_api.h.
  328. .PP
  329. Referenced by snmp_create_sess_pdu(), snmp_free_pdu(), and snmp_pdu_create().
  330. .SS "long fBsnmp_pdu::trap_typefP"
  331. .PP
  332. trap type 
  333. .PP
  334. Definition at line 138 of file snmp_api.h.
  335. .PP
  336. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
  337. .SS "long fBsnmp_pdu::versionfP"
  338. .PP
  339. snmp version 
  340. .PP
  341. Definition at line 81 of file snmp_api.h.
  342. .PP
  343. Referenced by check_access(), handle_snmp_packet(), in_a_view(), netsnmp_acm_check_subtree(), netsnmp_wrap_up_request(), send_trap_to_sess(), snmp_pdu_create(), and snmpv3_parse().
  345. .SH "Author"
  346. .PP 
  347. Generated automatically by Doxygen for net-snmp from the source code.