SNMP编程

开发平台：
Unix_Linux

netsnmp_callback.3：源码内容
							.TH "A generic callback mechanism" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
.ad l
.nh
.SH NAME
A generic callback mechanism - 
.SS "Functions"
.in +1c
.ti -1c
.RI "void fBinit_callbacksfP (void)"
.br
.ti -1c
.RI "int fBsnmp_register_callbackfP (int major, int minor, SNMPCallback *new_callback, void *arg)"
.br
.RI "fIThis function registers a generic callback function. fP"
.ti -1c
.RI "int fBnetsnmp_register_callbackfP (int major, int minor, SNMPCallback *new_callback, void *arg, int priority)"
.br
.ti -1c
.RI "int fBsnmp_call_callbacksfP (int major, int minor, void *caller_arg)"
.br
.RI "fIThis function calls the callback function for each registered callback of type major and minor. fP"
.ti -1c
.RI "int fBsnmp_count_callbacksfP (int major, int minor)"
.br
.ti -1c
.RI "int fBsnmp_callback_availablefP (int major, int minor)"
.br
.ti -1c
.RI "int fBsnmp_unregister_callbackfP (int major, int minor, SNMPCallback *target, void *arg, int matchargs)"
.br
.RI "fIThis function unregisters a specified callback function given a major and minor type. fP"
.ti -1c
.RI "int fBnetsnmp_callback_clear_client_argfP (void *ptr, int i, int j)"
.br
.RI "fIfind and clear client args that match ptr fP"
.ti -1c
.RI "void fBclear_callbackfP (void)"
.br
.ti -1c
.RI "fBsnmp_gen_callbackfP * fBsnmp_callback_listfP (int major, int minor)"
.br
.in -1c
.SH "Function Documentation"
.PP 
.SS "int netsnmp_callback_clear_client_arg (void * ptr, int i, int j)"
.PP
find and clear client args that match ptr 
.PP
fBParameters:fP
.RS 4
fIptrfP pointer to search for 
.br
fIifP callback id to start at 
.br
fIjfP callback subid to start at
.RE
.PP
.PP
Definition at line 346 of file callback.c.
.PP
References snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, and snmp_gen_callback::sc_client_arg.
.PP
Referenced by clear_callback().
.SS "int snmp_call_callbacks (int major, int minor, void * caller_arg)"
.PP
This function calls the callback function for each registered callback of type major and minor. 
.PP
fBParameters:fP
.RS 4
fImajorfP is the SNMP callback major type used
.br
fIminorfP is the SNMP callback minor type used
.br
fIcaller_argfP is a void pointer which is sent in as the callback's serverarg parameter, if needed.
.RE
.PP
fBReturns:fP
.RS 4
Returns SNMPERR_GENERR if major is >= MAX_CALLBACK_IDS or minor is >= MAX_CALLBACK_SUBIDS, otherwise SNMPERR_SUCCESS is returned.
.RE
.PP
fBSee also:fP
.RS 4
fBsnmp_register_callbackfP 
.PP
fBsnmp_unregister_callbackfP
.RE
.PP
.PP
Definition at line 182 of file callback.c.
.PP
References snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, snmp_gen_callback::sc_client_arg, and snmp_log().
.PP
Referenced by add_trap_session(), check_access(), in_a_view(), log_handler_callback(), netsnmp_acm_check_subtree(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), netsnmp_send_traps(), netsnmp_unregister_mib_table_row(), read_configs(), read_premib_configs(), snmp_shutdown(), snmp_store(), unregister_mib_context(), and unregister_mibs_by_session().
.SS "int snmp_register_callback (int major, int minor, SNMPCallback * new_callback, void * arg)"
.PP
This function registers a generic callback function. 
.PP
The major and minor values are used to set the new_callback function into a global static multi-dimensional array of type struct fBsnmp_gen_callbackfP. The function makes sure to append this callback function at the end of the link list, snmp_gen_callback->next.
.PP
fBParameters:fP
.RS 4
fImajorfP is the SNMP callback major type used
.IP "(bu" 2
SNMP_CALLBACK_LIBRARY
.PP
.RE
.PP
.IP "(bu" 2
SNMP_CALLBACK_APPLICATION
.PP
.PP
fBParameters:fP
.RS 4
fIminorfP is the SNMP callback minor type used
.IP "(bu" 2
SNMP_CALLBACK_POST_READ_CONFIG
.IP "(bu" 2
SNMP_CALLBACK_STORE_DATA
.IP "(bu" 2
SNMP_CALLBACK_SHUTDOWN
.IP "(bu" 2
SNMP_CALLBACK_POST_PREMIB_READ_CONFIG
.IP "(bu" 2
SNMP_CALLBACK_LOGGING
.IP "(bu" 2
SNMP_CALLBACK_SESSION_INIT
.PP
.br
fInew_callbackfP is the callback function that is registered.
.br
fIargfP when not NULL is a void pointer used whenever new_callback function is exercised.
.RE
.PP
fBReturns:fP
.RS 4
Returns SNMPERR_GENERR if major is >= MAX_CALLBACK_IDS or minor is >= MAX_CALLBACK_SUBIDS or a fBsnmp_gen_callbackfP pointer could not be allocated, otherwise SNMPERR_SUCCESS is returned.
.IP "(bu" 2
define MAX_CALLBACK_IDS 2
.IP "(bu" 2
define MAX_CALLBACK_SUBIDS 16
.PP
.RE
.PP
fBSee also:fP
.RS 4
fBsnmp_call_callbacksfP 
.PP
fBsnmp_unregister_callbackfP
.RE
.PP
.PP
Definition at line 115 of file callback.c.
.PP
References netsnmp_register_callback().
.PP
Referenced by init_snmp_alarm(), netsnmp_init_handler_conf(), and netsnmp_register_save_list().
.SS "int snmp_unregister_callback (int major, int minor, SNMPCallback * target, void * arg, int matchargs)"
.PP
This function unregisters a specified callback function given a major and minor type. 
.PP
Note: no bound checking on major and minor.
.PP
fBParameters:fP
.RS 4
fImajorfP is the SNMP callback major type used
.br
fIminorfP is the SNMP callback minor type used
.br
fItargetfP is the callback function that will be unregistered.
.br
fIargfP is a void pointer used for comparison against the registered callback's sc_client_arg variable.
.br
fImatchargsfP is an integer used to bypass the comparison of arg and the callback's sc_client_arg variable only when matchargs is set to 0.
.RE
.PP
fBReturns:fP
.RS 4
Returns the number of callbacks that were unregistered.
.RE
.PP
fBSee also:fP
.RS 4
fBsnmp_register_callbackfP 
.PP
fBsnmp_call_callbacksfP
.RE
.PP
set cleanup flag? 
.PP
Definition at line 295 of file callback.c.
.PP
References snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, snmp_gen_callback::sc_client_arg, SNMP_FREE, and snmp_log().

						