watcher

Watch a specified variable and process it as an instance or scalar object. More...

Functions
netsnmp_watcher_info *	netsnmp_init_watcher_info6 (netsnmp_watcher_info *winfo, void *data, size_t size, u_char type, int flags, size_t max_size, size_t *size_p)
netsnmp_watcher_info *	netsnmp_create_watcher_info6 (void *data, size_t size, u_char type, int flags, size_t max_size, size_t *size_p)
netsnmp_watcher_info *	netsnmp_init_watcher_info (netsnmp_watcher_info *winfo, void *data, size_t size, u_char type, int flags)
netsnmp_watcher_info *	netsnmp_create_watcher_info (void *data, size_t size, u_char type, int flags)
int	netsnmp_register_watched_instance (netsnmp_handler_registration *reginfo, netsnmp_watcher_info *watchinfo)
	Register a watched scalar.
int	netsnmp_register_watched_instance2 (netsnmp_handler_registration *reginfo, netsnmp_watcher_info *watchinfo)
	Register a watched scalar.
int	netsnmp_register_watched_scalar (netsnmp_handler_registration *reginfo, netsnmp_watcher_info *watchinfo)
	Register a watched scalar.
int	netsnmp_register_watched_scalar2 (netsnmp_handler_registration *reginfo, netsnmp_watcher_info *watchinfo)
	Register a watched scalar.
void	netsnmp_owns_watcher_info (netsnmp_mib_handler *handler)
int	netsnmp_watcher_helper_handler (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)
netsnmp_mib_handler *	netsnmp_get_watched_timestamp_handler (void)
int	netsnmp_watched_timestamp_register (netsnmp_mib_handler *whandler, netsnmp_handler_registration *reginfo, marker_t timestamp)
int	netsnmp_register_watched_timestamp (netsnmp_handler_registration *reginfo, marker_t timestamp)
int	netsnmp_watched_timestamp_handler (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)
netsnmp_mib_handler *	netsnmp_get_watched_spinlock_handler (void)
int	netsnmp_register_watched_spinlock (netsnmp_handler_registration *reginfo, int *spinlock)
int	netsnmp_watched_spinlock_handler (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)
netsnmp_watcher_info *	netsnmp_clone_watcher_info (netsnmp_watcher_info *winfo)
int	netsnmp_register_ulong_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_read_only_ulong_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_long_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_read_only_long_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_int_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_read_only_int_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)
int	netsnmp_register_read_only_counter32_scalar (const char *name, const oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)
#define	NETSNMP_WATCHER_DIRECT   MIB_HANDLER_CUSTOM1
#define	WATCHER_FIXED_SIZE
	The size of the watched object is constant.
#define	WATCHER_MAX_SIZE
	The maximum size of the watched object is stored in max_size.
#define	WATCHER_SIZE_IS_PTR
	If set then the variable data_size_p points to is supposed to hold the current size of the watched object and will be updated on writes.
#define	WATCHER_SIZE_STRLEN
	If set then data is suppposed to be a zero-terminated character array and both data_size and data_size_p are ignored.
#define	WATCHER_SIZE_UNIT_OIDS
	If set then size is in units of object identifiers.
typedef struct netsnmp_watcher_info_s	netsnmp_watcher_info

---

Detailed Description

Watch a specified variable and process it as an instance or scalar object.

---

Define Documentation

#define WATCHER_FIXED_SIZE

The size of the watched object is constant.

Definition at line 26 of file watcher.h.

#define WATCHER_MAX_SIZE

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.

Examples:

watched.c.

Definition at line 32 of file watcher.h.

#define WATCHER_SIZE_IS_PTR

If set then the variable data_size_p points to is supposed to hold the current size of the watched object and will be updated on writes.

Since:

Net-SNMP 5.5

Definition at line 38 of file watcher.h.

#define WATCHER_SIZE_STRLEN

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.

Since:

Net-SNMP 5.5

Definition at line 45 of file watcher.h.

#define WATCHER_SIZE_UNIT_OIDS

If set then size is in units of object identifiers.

This is useful if you have an OID and tracks the OID_LENGTH of it as opposed to it's size.

Since:

Net-SNMP 5.5.1

Definition at line 52 of file watcher.h.

---

Function Documentation

int netsnmp_register_watched_instance	(	netsnmp_handler_registration *	reginfo,
		netsnmp_watcher_info *	watchinfo
	)

Register a watched scalar.

The caller remains the owner of watchinfo.

See also:

netsnmp_register_watched_instance2()

Examples:

watched.c.

Definition at line 107 of file watcher.c.

int netsnmp_register_watched_instance2	(	netsnmp_handler_registration *	reginfo,
		netsnmp_watcher_info *	watchinfo
	)

Register a watched scalar.

Ownership of watchinfo is transferred to the handler.

See also:

netsnmp_register_watched_instance()

Definition at line 125 of file watcher.c.

int netsnmp_register_watched_scalar	(	netsnmp_handler_registration *	reginfo,
		netsnmp_watcher_info *	watchinfo
	)

Register a watched scalar.

The caller remains the owner of watchinfo.

See also:

netsnmp_register_watched_scalar2()

Definition at line 144 of file watcher.c.

int netsnmp_register_watched_scalar2	(	netsnmp_handler_registration *	reginfo,
		netsnmp_watcher_info *	watchinfo
	)

Register a watched scalar.

Ownership of watchinfo is transferred to the handler.

See also:

netsnmp_register_watched_scalar()

Definition at line 162 of file watcher.c.