SNMP编程

开发平台：
Unix_Linux

netsnmp_data_list.3：源码内容
							.TH "generic linked-list data handling with a string as a key." 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
.ad l
.nh
.SH NAME
generic linked-list data handling with a string as a key. - 
.SS "Functions"
.in +1c
.ti -1c
.RI "NETSNMP_INLINE void fBnetsnmp_free_list_datafP (fBnetsnmp_data_listfP *fBnodefP)"
.br
.RI "fIfrees the data and a name at a given data_list node. fP"
.ti -1c
.RI "NETSNMP_INLINE void fBnetsnmp_free_all_list_datafP (fBnetsnmp_data_listfP *head)"
.br
.RI "fIfrees all data and nodes in a list. fP"
.ti -1c
.RI "NETSNMP_INLINE fBnetsnmp_data_listfP * fBnetsnmp_create_data_listfP (const char *name, void *data, Netsnmp_Free_List_Data *beer)"
.br
.RI "fIadds creates a data_list node given a name, data and a free function ptr. fP"
.ti -1c
.RI "NETSNMP_INLINE void fBnetsnmp_add_list_datafP (fBnetsnmp_data_listfP **head, fBnetsnmp_data_listfP *fBnodefP)"
.br
.RI "fIdepreciated: use fBnetsnmp_data_list_add_node()fP fP"
.ti -1c
.RI "NETSNMP_INLINE void fBnetsnmp_data_list_add_nodefP (fBnetsnmp_data_listfP **head, fBnetsnmp_data_listfP *fBnodefP)"
.br
.RI "fIadds data to a datalist fP"
.ti -1c
.RI "NETSNMP_INLINE fBnetsnmp_data_listfP * fBnetsnmp_data_list_add_datafP (fBnetsnmp_data_listfP **head, const char *name, void *data, Netsnmp_Free_List_Data *beer)"
.br
.RI "fIadds data to a datalist fP"
.ti -1c
.RI "NETSNMP_INLINE void * fBnetsnmp_get_list_datafP (fBnetsnmp_data_listfP *head, const char *name)"
.br
.RI "fIreturns a data_list node's data for a given name within a data_list fP"
.ti -1c
.RI "NETSNMP_INLINE fBnetsnmp_data_listfP * fBnetsnmp_get_list_nodefP (fBnetsnmp_data_listfP *head, const char *name)"
.br
.RI "fIreturns a data_list node for a given name within a data_list fP"
.ti -1c
.RI "int fBnetsnmp_remove_list_nodefP (fBnetsnmp_data_listfP **realhead, const char *name)"
.br
.RI "fIRemoves a named node from a data_list (and frees it). fP"
.ti -1c
.RI "void fBnetsnmp_register_save_listfP (fBnetsnmp_data_listfP **datalist, const char *type, const char *token, Netsnmp_Save_List_Data *data_list_save_ptr, Netsnmp_Read_List_Data *data_list_read_ptr, Netsnmp_Free_List_Data *data_list_free_ptr)"
.br
.RI "fIregisters to store a data_list set of data at persistant storage time fP"
.ti -1c
.RI "int fBnetsnmp_save_all_data_callbackfP (int major, int minor, void *serverarg, void *clientarg)"
.br
.RI "fIintended to be registerd as a callback operation. fP"
.ti -1c
.RI "int fBnetsnmp_save_all_datafP (fBnetsnmp_data_listfP *head, const char *type, const char *token, Netsnmp_Save_List_Data *data_list_save_ptr)"
.br
.RI "fIintended to be called as a callback during persistent save operations. fP"
.ti -1c
.RI "void fBnetsnmp_read_data_callbackfP (const char *token, char *line)"
.br
.RI "fIintended to be registerd as a .conf parser It should be registered using: fP"
.in -1c
.SH "Function Documentation"
.PP 
.SS "NETSNMP_INLINE void netsnmp_add_list_data (fBnetsnmp_data_listfP ** head, fBnetsnmp_data_listfP * node)"
.PP
depreciated: use fBnetsnmp_data_list_add_node()fP 
.PP
Definition at line 83 of file data_list.c.
.PP
References netsnmp_data_list_add_node().
.PP
Referenced by netsnmp_agent_add_list_data(), netsnmp_data_list_add_data(), netsnmp_read_data_callback(), netsnmp_register_auto_data_table(), netsnmp_register_handler_by_name(), netsnmp_register_save_list(), and netsnmp_request_add_list_data().
.SS "NETSNMP_INLINE fBnetsnmp_data_listfP* netsnmp_create_data_list (const char * name, void * data, Netsnmp_Free_List_Data * beer)"
.PP
adds creates a data_list node given a name, data and a free function ptr. 
.PP
fBParameters:fP
.RS 4
fInamefP the name of the node to cache the data. 
.br
fIdatafP the data to be stored under that name 
.br
fIbeerfP A function that can free the data pointer (in the future) 
.RE
.PP
fBReturns:fP
.RS 4
a newly created data_list node which can be given to the netsnmp_add_list_data function.
.RE
.PP
.PP
fBExamples: fP
.in +1c
fBdelayed_instance.cfP.
.PP
Definition at line 64 of file data_list.c.
.PP
References netsnmp_data_list_s::data, netsnmp_data_list_s::free_func, netsnmp_data_list_s::name, NULL, and SNMP_MALLOC_TYPEDEF.
.PP
Referenced by netsnmp_cache_reqinfo_insert(), netsnmp_data_list_add_data(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_ulong_handler(), netsnmp_old_api_helper(), netsnmp_read_data_callback(), netsnmp_register_auto_data_table(), netsnmp_register_handler_by_name(), netsnmp_register_save_list(), netsnmp_stash_cache_update(), netsnmp_table_data_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
.SS "NETSNMP_INLINE fBnetsnmp_data_listfP* netsnmp_data_list_add_data (fBnetsnmp_data_listfP ** head, const char * name, void * data, Netsnmp_Free_List_Data * beer)"
.PP
adds data to a datalist 
.PP
fBParameters:fP
.RS 4
fIheadfP a pointer to the head node of a data_list 
.br
fInamefP the name of the node to cache the data. 
.br
fIdatafP the data to be stored under that name 
.br
fIbeerfP A function that can free the data pointer (in the future) 
.RE
.PP
fBReturns:fP
.RS 4
a newly created data_list node which was inserted in the list
.RE
.PP
.PP
Definition at line 137 of file data_list.c.
.PP
References netsnmp_add_list_data(), netsnmp_create_data_list(), NULL, and snmp_log().
.SS "NETSNMP_INLINE void netsnmp_data_list_add_node (fBnetsnmp_data_listfP ** head, fBnetsnmp_data_listfP * node)"
.PP
adds data to a datalist 
.PP
fBParameters:fP
.RS 4
fIheadfP a pointer to the head node of a data_list 
.br
fInodefP a node to stash in the data_list
.RE
.PP
.PP
Definition at line 93 of file data_list.c.
.PP
References netsnmp_data_list_s::name, netsnmp_data_list_s::next, NULL, and snmp_log().
.PP
Referenced by netsnmp_add_list_data().
.SS "NETSNMP_INLINE void netsnmp_free_all_list_data (fBnetsnmp_data_listfP * head)"
.PP
frees all data and nodes in a list. 
.PP
fBParameters:fP
.RS 4
fIheadfP the top node of the list to be freed.
.RE
.PP
.PP
Definition at line 46 of file data_list.c.
.PP
References netsnmp_free_list_data(), netsnmp_data_list_s::next, and SNMP_FREE.
.PP
Referenced by netsnmp_clear_handler_list(), netsnmp_free_agent_data_sets(), netsnmp_free_agent_request_info(), and netsnmp_free_request_data_sets().
.SS "NETSNMP_INLINE void netsnmp_free_list_data (fBnetsnmp_data_listfP * node)"
.PP
frees the data and a name at a given data_list node. 
.PP
Note that this doesn't free the node itself. 
.PP
fBParameters:fP
.RS 4
fInodefP the node for which the data should be freed
.RE
.PP
.PP
Definition at line 30 of file data_list.c.
.PP
References netsnmp_data_list_s::data, netsnmp_data_list_s::free_func, netsnmp_data_list_s::name, and SNMP_FREE.
.PP
Referenced by netsnmp_free_agent_data_set(), netsnmp_free_all_list_data(), netsnmp_free_request_data_set(), and netsnmp_remove_list_node().
.SS "NETSNMP_INLINE void* netsnmp_get_list_data (fBnetsnmp_data_listfP * head, const char * name)"
.PP
returns a data_list node's data for a given name within a data_list 
.PP
fBParameters:fP
.RS 4
fIheadfP the head node of a data_list 
.br
fInamefP the name to find 
.RE
.PP
fBReturns:fP
.RS 4
a pointer to the data cached at that node
.RE
.PP
.PP
Definition at line 157 of file data_list.c.
.PP
References netsnmp_data_list_s::data, netsnmp_data_list_s::name, netsnmp_data_list_s::next, and NULL.
.PP
Referenced by netsnmp_agent_get_list_data(), netsnmp_config_parse_add_row(), netsnmp_config_parse_table_set(), netsnmp_read_data_callback(), netsnmp_request_get_list_data(), and parse_injectHandler_conf().
.SS "NETSNMP_INLINE fBnetsnmp_data_listfP* netsnmp_get_list_node (fBnetsnmp_data_listfP * head, const char * name)"
.PP
returns a data_list node for a given name within a data_list 
.PP
fBParameters:fP
.RS 4
fIheadfP the head node of a data_list 
.br
fInamefP the name to find 
.RE
.PP
fBReturns:fP
.RS 4
a pointer to the data_list node
.RE
.PP
.PP
Definition at line 173 of file data_list.c.
.PP
References netsnmp_data_list_s::name, netsnmp_data_list_s::next, and NULL.
.PP
Referenced by netsnmp_table_iterator_helper_handler().
.SS "void netsnmp_read_data_callback (const char * token, char * line)"
.PP
intended to be registerd as a .conf parser It should be registered using: 
.PP
register_app_config_handler('token', netsnmp_read_data_callback, XXX)
.PP
where INFO_POINTER is a pointer to a netsnmp_data_list_saveinfo object containing apporpriate registration information
.PP
Definition at line 321 of file data_list.c.
.PP
References netsnmp_data_list_saveinfo_s::data_list_free_ptr, netsnmp_data_list_saveinfo_s::data_list_read_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_add_list_data(), netsnmp_create_data_list(), netsnmp_get_list_data(), NULL, read_config_read_data(), and snmp_log().
.PP
Referenced by netsnmp_register_save_list().
.SS "void netsnmp_register_save_list (fBnetsnmp_data_listfP ** datalist, const char * type, const char * token, Netsnmp_Save_List_Data * data_list_save_ptr, Netsnmp_Read_List_Data * data_list_read_ptr, Netsnmp_Free_List_Data * data_list_free_ptr)"
.PP
registers to store a data_list set of data at persistant storage time 
.PP
fBParameters:fP
.RS 4
fIdatalistfP the data to be saved 
.br
fItypefP the name of the application to save the data as. If left NULL the default application name that was registered during the init_snmp call will be used (recommended). 
.br
fItokenfP the unique token identifier string to use as the first word in the persistent file line. 
.br
fIdata_list_save_ptrfP a function pointer which will be called to save the rest of the data to a buffer. 
.br
fIdata_list_read_ptrfP a function pointer which can read the remainder of a saved line and return the application specific void * pointer. 
.br
fIdata_list_free_ptrfP a function pointer which will be passed to the data node for freeing it in the future when/if the list/node is cleaned up or destroyed.
.RE
.PP
fBTodofP
.RS 4
netsnmp_register_save_list should handle the same token name being saved from different types? 
.RE
.PP
.PP
Definition at line 220 of file data_list.c.
.PP
References netsnmp_data_list_saveinfo_s::data_list_free_ptr, netsnmp_data_list_saveinfo_s::data_list_read_ptr, netsnmp_data_list_saveinfo_s::data_list_save_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_add_list_data(), netsnmp_create_data_list(), netsnmp_ds_get_string(), netsnmp_read_data_callback(), netsnmp_save_all_data_callback(), NULL, register_config_handler(), snmp_log(), SNMP_MALLOC_TYPEDEF, snmp_register_callback(), netsnmp_data_list_saveinfo_s::token, and netsnmp_data_list_saveinfo_s::type.
.SS "int netsnmp_remove_list_node (fBnetsnmp_data_listfP ** realhead, const char * name)"
.PP
Removes a named node from a data_list (and frees it). 
.PP
fBParameters:fP
.RS 4
fIrealheadfP a pointer to the head node of a data_list 
.br
fInamefP the name to find and remove 
.RE
.PP
fBReturns:fP
.RS 4
0 on successful find-and-delete, 1 otherwise.
.RE
.PP
.PP
Definition at line 189 of file data_list.c.
.PP
References netsnmp_data_list_s::name, netsnmp_free_list_data(), netsnmp_data_list_s::next, and NULL.
.PP
Referenced by netsnmp_agent_remove_list_data(), and netsnmp_request_remove_list_data().
.SS "int netsnmp_save_all_data (fBnetsnmp_data_listfP * head, const char * type, const char * token, Netsnmp_Save_List_Data * data_list_save_ptr)"
.PP
intended to be called as a callback during persistent save operations. 
.PP
See the netsnmp_save_all_data_callback for where this is typically used. 
.PP
Definition at line 286 of file data_list.c.
.PP
References netsnmp_data_list_s::data, netsnmp_data_list_s::name, netsnmp_data_list_s::next, read_config_save_octet_string(), read_config_store(), and SNMP_MAXBUF.
.PP
Referenced by netsnmp_save_all_data_callback().
.SS "int netsnmp_save_all_data_callback (int major, int minor, void * serverarg, void * clientarg)"
.PP
intended to be registerd as a callback operation. 
.PP
It should be registered using:
.PP
snmp_register_callback(SNMP_CALLBACK_LIBRARY, SNMP_CALLBACK_STORE_DATA, netsnmp_save_all_data_callback, INFO_POINTER);
.PP
where INFO_POINTER is a pointer to a netsnmp_data_list_saveinfo object containing apporpriate registration information
.PP
Definition at line 269 of file data_list.c.
.PP
References netsnmp_data_list_saveinfo_s::data_list_save_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_save_all_data(), snmp_log(), netsnmp_data_list_saveinfo_s::token, and netsnmp_data_list_saveinfo_s::type.
.PP
Referenced by netsnmp_register_save_list().

						