netsnmp_scalar.3
上传用户：wxp200602
上传日期：2007-10-30
资源大小：4028k
文件大小：4k
- .TH "scalar: process scalars easily." 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
- .ad l
- .nh
- .SH NAME
- scalar: process scalars easily. -
- .SS "Functions"
- .in +1c
- .ti -1c
- .RI "fBnetsnmp_mib_handlerfP * fBnetsnmp_get_scalar_handlerfP (void)"
- .br
- .RI "fICreates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler. fP"
- .ti -1c
- .RI "int fBnetsnmp_register_scalarfP (fBnetsnmp_handler_registrationfP *reginfo)"
- .br
- .RI "fIThis function registers a scalar helper handler. fP"
- .ti -1c
- .RI "int fBnetsnmp_register_read_only_scalarfP (fBnetsnmp_handler_registrationfP *reginfo)"
- .br
- .RI "fIThis function registers a read only scalar helper handler. fP"
- .ti -1c
- .RI "int fBnetsnmp_scalar_helper_handlerfP (fBnetsnmp_mib_handlerfP *handler, fBnetsnmp_handler_registrationfP *reginfo, fBnetsnmp_agent_request_infofP *reqinfo, fBnetsnmp_request_infofP *requests)"
- .br
- .in -1c
- .SH "Function Documentation"
- .PP
- .SS "fBnetsnmp_mib_handlerfP* netsnmp_get_scalar_handler (void)"
- .PP
- Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler.
- .PP
- fBParameters:fP
- .RS 4
- fIvoidfP
- .RE
- .PP
- fBReturns:fP
- .RS 4
- Returns a pointer to a netsnmp_mib_handler struct which contains the handler's name and the access method
- .RE
- .PP
- fBSee also:fP
- .RS 4
- fBnetsnmp_get_scalar_handlerfP
- .PP
- fBnetsnmp_register_scalarfP
- .RE
- .PP
- .PP
- Definition at line 51 of file scalar.c.
- .PP
- References netsnmp_create_handler(), and netsnmp_scalar_helper_handler().
- .PP
- Referenced by netsnmp_register_read_only_scalar(), netsnmp_register_scalar(), and netsnmp_register_scalar_group().
- .SS "int netsnmp_register_read_only_scalar (fBnetsnmp_handler_registrationfP * reginfo)"
- .PP
- This function registers a read only scalar helper handler.
- .PP
- This function is very similar to netsnmp_register_scalar the only addition is that the 'read_only' handler is injected into the handler chain prior to injecting the serialize handler and registering reginfo.
- .PP
- fBParameters:fP
- .RS 4
- fIreginfofP a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a read only scalar helper handler.
- .RE
- .PP
- fBReturns:fP
- .RS 4
- MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.
- .RE
- .PP
- fBSee also:fP
- .RS 4
- fBnetsnmp_register_scalarfP
- .PP
- fBnetsnmp_get_scalar_handlerfP
- .RE
- .PP
- .PP
- Definition at line 114 of file scalar.c.
- .PP
- References netsnmp_get_instance_handler(), netsnmp_get_read_only_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
- .SS "int netsnmp_register_scalar (fBnetsnmp_handler_registrationfP * reginfo)"
- .PP
- This function registers a scalar helper handler.
- .PP
- The registered OID, reginfo->rootoid, space is extended for the instance subid using realloc() but the reginfo->rootoid_len length is not extended just yet. .This function subsequently injects the instance, scalar, and serialize helper handlers before actually registering reginfo.
- .PP
- Each handler is injected/pushed to the top of the handler chain list and will be processed last in first out, LIFO.
- .PP
- fBParameters:fP
- .RS 4
- fIreginfofP a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a scalar helper handler.
- .RE
- .PP
- fBReturns:fP
- .RS 4
- MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.
- .RE
- .PP
- fBSee also:fP
- .RS 4
- fBnetsnmp_register_read_only_scalarfP
- .PP
- fBnetsnmp_get_scalar_handlerfP
- .RE
- .PP
- .PP
- Definition at line 79 of file scalar.c.
- .PP
- References netsnmp_get_instance_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
- .PP
- Referenced by netsnmp_register_watched_scalar(), and netsnmp_register_watched_timestamp().
English
