user/net-snmp/man/netsnmp_watcher.3

   1 .TH "watcher" 3 "23 Sep 2009" "Version 5.5" "net-snmp" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 watcher \-
   6 .PP
   7 Watch a specified \fBvariable\fP and process it as an instance or scalar object.
   8
   9 .SS "Functions"
  10
  11 .in +1c
  12 .ti -1c
  13 .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_watcher_handler\fP (void)"
  14 .br
  15 .ti -1c
  16 .RI "\fBnetsnmp_watcher_info\fP * \fBnetsnmp_init_watcher_info6\fP (\fBnetsnmp_watcher_info\fP *winfo, void *data, size_t size, u_char type, int flags, size_t max_size, size_t *size_p)"
  17 .br
  18 .ti -1c
  19 .RI "\fBnetsnmp_watcher_info\fP * \fBnetsnmp_create_watcher_info6\fP (void *data, size_t size, u_char type, int flags, size_t max_size, size_t *size_p)"
  20 .br
  21 .ti -1c
  22 .RI "\fBnetsnmp_watcher_info\fP * \fBnetsnmp_init_watcher_info\fP (\fBnetsnmp_watcher_info\fP *winfo, void *data, size_t size, u_char type, int flags)"
  23 .br
  24 .ti -1c
  25 .RI "\fBnetsnmp_watcher_info\fP * \fBnetsnmp_create_watcher_info\fP (void *data, size_t size, u_char type, int flags)"
  26 .br
  27 .ti -1c
  28 .RI "int \fBnetsnmp_register_watched_instance\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_watcher_info\fP *watchinfo)"
  29 .br
  30 .ti -1c
  31 .RI "int \fBnetsnmp_register_watched_scalar\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_watcher_info\fP *watchinfo)"
  32 .br
  33 .ti -1c
  34 .RI "int \fBnetsnmp_watcher_helper_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
  35 .br
  36 .ti -1c
  37 .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_watched_timestamp_handler\fP (void)"
  38 .br
  39 .ti -1c
  40 .RI "int \fBnetsnmp_watched_timestamp_register\fP (\fBnetsnmp_mib_handler\fP *whandler, \fBnetsnmp_handler_registration\fP *reginfo, marker_t timestamp)"
  41 .br
  42 .ti -1c
  43 .RI "int \fBnetsnmp_register_watched_timestamp\fP (\fBnetsnmp_handler_registration\fP *reginfo, marker_t timestamp)"
  44 .br
  45 .ti -1c
  46 .RI "int \fBnetsnmp_watched_timestamp_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
  47 .br
  48 .ti -1c
  49 .RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_watched_spinlock_handler\fP (void)"
  50 .br
  51 .ti -1c
  52 .RI "int \fBnetsnmp_register_watched_spinlock\fP (\fBnetsnmp_handler_registration\fP *reginfo, int *spinlock)"
  53 .br
  54 .ti -1c
  55 .RI "int \fBnetsnmp_watched_spinlock_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
  56 .br
  57 .ti -1c
  58 .RI "int \fBnetsnmp_register_ulong_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
  59 .br
  60 .ti -1c
  61 .RI "int \fBnetsnmp_register_read_only_ulong_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
  62 .br
  63 .ti -1c
  64 .RI "int \fBnetsnmp_register_long_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
  65 .br
  66 .ti -1c
  67 .RI "int \fBnetsnmp_register_read_only_long_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
  68 .br
  69 .ti -1c
  70 .RI "int \fBnetsnmp_register_int_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
  71 .br
  72 .ti -1c
  73 .RI "int \fBnetsnmp_register_read_only_int_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
  74 .br
  75 .ti -1c
  76 .RI "int \fBnetsnmp_register_read_only_counter32_scalar\fP (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
  77 .br
  78 .in -1c
  79 .in +1c
  80 .ti -1c
  81 .RI "#define \fBNETSNMP_WATCHER_DIRECT\fP   MIB_HANDLER_CUSTOM1"
  82 .br
  83 .ti -1c
  84 .RI "#define \fBWATCHER_FIXED_SIZE\fP"
  85 .br
  86 .RI "\fIThe size of the watched object is constant. \fP"
  87 .ti -1c
  88 .RI "#define \fBWATCHER_MAX_SIZE\fP"
  89 .br
  90 .RI "\fIThe maximum size of the watched object is stored in max_size. \fP"
  91 .ti -1c
  92 .RI "#define \fBWATCHER_SIZE_IS_PTR\fP"
  93 .br
  94 .RI "\fIIf set then the \fBvariable\fP data_size_p points to is supposed to hold the current size of the watched object and will be updated on writes. \fP"
  95 .ti -1c
  96 .RI "#define \fBWATCHER_SIZE_STRLEN\fP"
  97 .br
  98 .RI "\fIIf set then data is suppposed to be a zero-terminated character array and both data_size and data_size_p are ignored. \fP"
  99 .ti -1c
 100 .RI "typedef struct \fBnetsnmp_watcher_info_s\fP \fBnetsnmp_watcher_info\fP"
 101 .br
 102 .in -1c
 103 .SH "Detailed Description"
 104 .PP
 105 Watch a specified \fBvariable\fP and process it as an instance or scalar object.
 106 .SH "Define Documentation"
 107 .PP
 108 .SS "#define WATCHER_FIXED_SIZE"
 109 .PP
 110 The size of the watched object is constant.
 111 .PP
 112 Definition at line 26 of file watcher.h.
 113 .SS "#define WATCHER_MAX_SIZE"
 114 .PP
 115 The maximum size of the watched object is stored in max_size. If WATCHER_SIZE_STRLEN is set then it is supposed that max_size + 1 bytes could be stored in the buffer.
 116 .PP
 117 \fBExamples: \fP
 118 .in +1c
 119 \fBwatched.c\fP.
 120 .PP
 121 Definition at line 32 of file watcher.h.
 122 .SS "#define WATCHER_SIZE_IS_PTR"
 123 .PP
 124 If set then the \fBvariable\fP data_size_p points to is supposed to hold the current size of the watched object and will be updated on writes. \fBSince:\fP
 125 .RS 4
 126 Net-SNMP 5.5
 127 .RE
 128 .PP
 129
 130 .PP
 131 Definition at line 38 of file watcher.h.
 132 .SS "#define WATCHER_SIZE_STRLEN"
 133 .PP
 134 If set then data is suppposed to be a zero-terminated character array and both data_size and data_size_p are ignored. Additionally \\0 is a forbidden character in the data set.
 135 .PP
 136 \fBSince:\fP
 137 .RS 4
 138 Net-SNMP 5.5
 139 .RE
 140 .PP
 141
 142 .PP
 143 Definition at line 45 of file watcher.h.
 144 .SH "Author"
 145 .PP
 146 Generated automatically by Doxygen for net-snmp from the source code.