netsnmp_snmp_client.3
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:6k
源码类别:

SNMP编程

开发平台:

Unix_Linux

  1. .TH "various PDU processing routines" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. various PDU processing routines - 
  6. .SS "Defines"
  7. .in +1c
  8. .ti -1c
  9. .RI "#define fBBSD4_2fP"
  10. .br
  11. .ti -1c
  12. .RI "#define fBNFDBITSfP   (sizeof(fBfd_maskfP) * NBBY)"
  13. .br
  14. .ti -1c
  15. .RI "#define fBFD_SETfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))"
  16. .br
  17. .ti -1c
  18. .RI "#define fBFD_CLRfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))"
  19. .br
  20. .ti -1c
  21. .RI "#define fBFD_ISSETfP(n, p)   ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))"
  22. .br
  23. .ti -1c
  24. .RI "#define fBFD_ZEROfP(p)   memset((p), 0, sizeof(*(p)))"
  25. .br
  26. .in -1c
  27. .SS "Typedefs"
  28. .in +1c
  29. .ti -1c
  30. .RI "typedef long fBfd_maskfP"
  31. .br
  32. .in -1c
  33. .SS "Functions"
  34. .in +1c
  35. .ti -1c
  36. .RI "fBnetsnmp_pdufP * fBsnmp_pdu_createfP (int command)"
  37. .br
  38. .ti -1c
  39. .RI "fBnetsnmp_variable_listfP * fBsnmp_add_null_varfP (fBnetsnmp_pdufP *pdu, const oid *name, size_t name_length)"
  40. .br
  41. .ti -1c
  42. .RI "int fBsnmp_clone_varfP (fBnetsnmp_variable_listfP *var, fBnetsnmp_variable_listfP *newvar)"
  43. .br
  44. .ti -1c
  45. .RI "int fBsnmp_clone_memfP (void **dstPtr, void *srcPtr, unsigned len)"
  46. .br
  47. .ti -1c
  48. .RI "void fBsnmp_reset_var_buffersfP (fBnetsnmp_variable_listfP *var)"
  49. .br
  50. .ti -1c
  51. .RI "fBnetsnmp_variable_listfP * fBsnmp_clone_varbindfP (fBnetsnmp_variable_listfP *varlist)"
  52. .br
  53. .ti -1c
  54. .RI "fBnetsnmp_pdufP * fBsnmp_clone_pdufP (fBnetsnmp_pdufP *pdu)"
  55. .br
  56. .ti -1c
  57. .RI "fBnetsnmp_pdufP * fBsnmp_split_pdufP (fBnetsnmp_pdufP *pdu, int skip_count, int copy_count)"
  58. .br
  59. .ti -1c
  60. .RI "fBnetsnmp_pdufP * fBsnmp_fix_pdufP (fBnetsnmp_pdufP *pdu, int command)"
  61. .br
  62. .ti -1c
  63. .RI "unsigned long fBsnmp_varbind_lenfP (fBnetsnmp_pdufP *pdu)"
  64. .br
  65. .ti -1c
  66. .RI "int fBsnmp_set_var_objidfP (fBnetsnmp_variable_listfP *vp, const oid *objid, size_t name_length)"
  67. .br
  68. .ti -1c
  69. .RI "int fBsnmp_set_var_typed_valuefP (fBnetsnmp_variable_listfP *newvar, u_char type, const u_char *val_str, size_t val_len)"
  70. .br
  71. .RI "fIsnmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure. fP"
  72. .ti -1c
  73. .RI "int fBcount_varbindsfP (fBnetsnmp_variable_listfP *var_ptr)"
  74. .br
  75. .ti -1c
  76. .RI "int fBcount_varbinds_of_typefP (fBnetsnmp_variable_listfP *var_ptr, u_char type)"
  77. .br
  78. .ti -1c
  79. .RI "fBnetsnmp_variable_listfP * fBfind_varbind_of_typefP (fBnetsnmp_variable_listfP *var_ptr, u_char type)"
  80. .br
  81. .ti -1c
  82. .RI "int fBsnmp_set_var_valuefP (fBnetsnmp_variable_listfP *vars, const u_char *value, size_t len)"
  83. .br
  84. .ti -1c
  85. .RI "void fBsnmp_replace_var_typesfP (fBnetsnmp_variable_listfP *vbl, u_char old_type, u_char new_type)"
  86. .br
  87. .ti -1c
  88. .RI "void fBsnmp_reset_var_typesfP (fBnetsnmp_variable_listfP *vbl, u_char new_type)"
  89. .br
  90. .ti -1c
  91. .RI "int fBsnmp_synch_response_cbfP (fBnetsnmp_sessionfP *ss, fBnetsnmp_pdufP *pdu, fBnetsnmp_pdufP **response, snmp_callback pcb)"
  92. .br
  93. .ti -1c
  94. .RI "int fBsnmp_synch_responsefP (fBnetsnmp_sessionfP *ss, fBnetsnmp_pdufP *pdu, fBnetsnmp_pdufP **response)"
  95. .br
  96. .ti -1c
  97. .RI "int fBsnmp_sess_synch_responsefP (void *sessp, fBnetsnmp_pdufP *pdu, fBnetsnmp_pdufP **response)"
  98. .br
  99. .ti -1c
  100. .RI "const char * fBsnmp_errstringfP (int errstat)"
  101. .br
  102. .in -1c
  103. .SS "Variables"
  104. .in +1c
  105. .ti -1c
  106. .RI "const char * fBerror_stringfP [19]"
  107. .br
  108. .in -1c
  109. .SH "Function Documentation"
  110. .PP 
  111. .SS "int snmp_set_var_typed_value (fBnetsnmp_variable_listfP * newvar, u_char type, const u_char * val_str, size_t val_len)"
  112. .PP
  113. snmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure. 
  114. .PP
  115. Used to return data to the snmp request via the netsnmp_request_info structure's requestvb pointer.
  116. .PP
  117. fBParameters:fP
  118. .RS 4
  119. fInewvarfP the structure gets populated with the given data, type, val_str, and val_len. 
  120. .br
  121. fItypefP is the asn data type to be copied 
  122. .br
  123. fIval_strfP is a buffer containing the value to be copied into the newvar structure. 
  124. .br
  125. fIval_lenfP the length of val_str
  126. .RE
  127. .PP
  128. fBReturns:fP
  129. .RS 4
  130. returns 0 on success and 1 on a malloc error
  131. .RE
  132. .PP
  133. .PP
  134. fBExamples: fP
  135. .in +1c
  136. fBdelayed_instance.cfP.
  137. .PP
  138. Definition at line 685 of file snmp_client.c.
  139. .PP
  140. References snmp_set_var_value(), and variable_list::type.
  141. .PP
  142. Referenced by _reorder_getbulk(), check_acm(), check_getnext_results(), handle_pdu(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_counter32_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_ulong_handler(), netsnmp_old_api_helper(), netsnmp_stash_cache_helper(), netsnmp_table_build_result(), netsnmp_table_data_build_result(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_replace_var_types(), and snmp_reset_var_types().
  143. .SH "Variable Documentation"
  144. .PP 
  145. .SS "const char* fBerror_stringfP[19]"
  146. .PP
  147. fBInitial value:fP
  148. .PP
  149. .nf
  150.  {
  151.     '(noError) No Error',
  152.     '(tooBig) Response message would have been too large.',
  153.     '(noSuchName) There is no such variable name in this MIB.',
  154.     '(badValue) The value given has the wrong type or length.',
  155.     '(readOnly) The two parties used do not have access to use the specified SNMP PDU.',
  156.     '(genError) A general failure occured',
  157.     'noAccess',
  158.     'wrongType (The set datatype does not match the data type the agent expects)',
  159.     'wrongLength (The set value has an illegal length from what the agent expects)',
  160.     'wrongEncoding',
  161.     'wrongValue (The set value is illegal or unsupported in some way)',
  162.     'noCreation (That table does not support row creation or that object can not ever be created)',
  163.     'inconsistentValue (The set value is illegal or unsupported in some way)',
  164.     'resourceUnavailable (This is likely a out-of-memory failure within the agent)',
  165.     'commitFailed',
  166.     'undoFailed',
  167.     'authorizationError (access denied to that object)',
  168.     'notWritable (That object does not support modification)',
  169.     'inconsistentName (That object can not currently be created)'
  170. }
  171. .fi
  172. .PP
  173. Definition at line 1102 of file snmp_client.c.