VxWorks Reference Manual : Libraries
snmpProcLib - manipulate variable-bindings in an SNMP packet
getproc_started( ) - indicate that a getproc operation has begun
getproc_good( ) - indicate successful completion of a getproc procedure
getproc_error( ) - indicate that a getproc operation encountered an error
nextproc_started( ) - indicate that a nextproc operation has begun
nextproc_good( ) - indicate successful completion of a nextproc procedure
nextproc_no_next( ) - indicate that there exists no next instance
nextproc_error( ) - indicate that a nextproc operation encountered an error
getproc_got_int32( ) - indicate retrieval of a 32-bit integer
getproc_got_uint32( ) - indicate retrieval of a 32-bit unsigned integer
getproc_got_ip_address( ) - indicate retrieval of an IP address
getproc_got_empty( ) - indicate retrieval of a null value
getproc_got_string( ) - indicate retrieval of a string
testproc_started( ) - indicate that a testproc operation has begun
testproc_good( ) - indicate successful completion of a testproc procedure
testproc_error( ) - indicate that a testproc operation encountered an error
setproc_started( ) - indicate that a setproc operation has begun
setproc_good( ) - indicates successful completion of a setproc procedure
setproc_error( ) - indicate that a setproc operation encountered an error
undoproc_started( ) - indicate that an undoproc operation has begun
undoproc_good( ) - indicates successful completion of an undoproc operation
undoproc_error( ) - indicate that an undproc operation encountered an error
getproc_got_uint64( ) - indicate retrieval of a 64-bit unsigned integer
getproc_got_uint64_high_low( ) - indicate retrieval of a 64-bit unsigned
getproc_nosuchins( ) - indicates that no such instance exists
getproc_got_object_id( ) - indicate retrieval of an object identifier
nextproc_next_instance( ) - install instance part of next instance
This module defines routines used to manipulate variable bindings in an SNMP packet. These are equivalents for macros defined in snmpdefs.h.
snmpdefs.h
getproc_started( ) - indicate that a getproc operation has begun
void getproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that getproc for the specified SNMP variable binding has been started and should not be started again.
N/A
getproc_good( ) - indicate successful completion of a getproc procedure
void getproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine is called when getproc successfully retrieves the value for an SNMP variable binding.
N/A
getproc_error( ) - indicate that a getproc operation encountered an error
void getproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )
This routine indicates that getproc encountered an error and cannot retrieve the requested value.
N/A
nextproc_started( ) - indicate that a nextproc operation has begun
void nextproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that nextproc has begun for the specified variable binding.
N/A
nextproc_good( ) - indicate successful completion of a nextproc procedure
void nextproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that nextproc for the specified variable binding has completed successfully.
N/A
nextproc_no_next( ) - indicate that there exists no next instance
void nextproc_no_next ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine is called from within nextproc if there is no next instance for the requested variable binding.
N/A
nextproc_error( ) - indicate that a nextproc operation encountered an error
void nextproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )
This routine is called when nextproc encounters an error and cannot retreive a next instance for the requested variable binding.
N/A
getproc_got_int32( ) - indicate retrieval of a 32-bit integer
void getproc_got_int32 ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T data /* 32 bit integer value for varbind */ )
This routine is called from getproc or nextproc when a 32-bit integer value is retreived for a variable binding.
N/A
getproc_got_uint32( ) - indicate retrieval of a 32-bit unsigned integer
void getproc_got_uint32 ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_32_T data, /* unsigned 32 bit integer value for varbind */ OCTET_T type /* SNMP type of value */ )
This routine is called from getproc or nextproc when a 32-bit unsigned integer value is retrieved for a variable binding.
N/A
getproc_got_ip_address( ) - indicate retrieval of an IP address
void getproc_got_ip_address ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_32_T addrData /* ip address value */ )
This routine is called from getproc or nextproc when an IP address is retrieved for a variable binding.
N/A
getproc_got_empty( ) - indicate retrieval of a null value
void getproc_got_empty ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine is called from getproc or nextproc when a null value is retrieved for a variable binding.
N/A
getproc_got_string( ) - indicate retrieval of a string
void getproc_got_string ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ ALENGTH_T size, /* size of string in octets */ OCTET_T * data, /* string data */ int dynamicFlg, /* storage type - dynamic or static */ OCTET_T type /* SNMP type of string data */ )
This routine is called from getproc or nextproc when a string is retrieved for a variable binding. The string data is stored in an extended buffer in the variable-binding structure. Tha parameter dynamicFlg indicates the storage type used by the extended buffer; if dynamicFlg is non-zero, then the buffer is assumed to have been allocated dynamically via snmpdMemoryAlloc( ) and will be freed later with snmpdMemoryFree( ). Otherwise, the buffer is assumed to be static.
N/A
testproc_started( ) - indicate that a testproc operation has begun
void testproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that testproc for the specified variable binding has been started by the user.
pPkt is the internal representation of the SNMP packet. pvarBind is a pointer to the variable-binding being processed.
N/A
testproc_good( ) - indicate successful completion of a testproc procedure
void testproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that testproc has successfully completed the checks to be performed prior to carrying out a set operation for a given variable binding.
N/A
testproc_error( ) - indicate that a testproc operation encountered an error
void testproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )
This routine indicates that testproc encountered an error which will prevent a set operation from being successful.
N/A
setproc_started( ) - indicate that a setproc operation has begun
void setproc_started ( SNMP_PKT_T * pPkt, VB_T * pVarBind )
This routine indicates that setproc has been started by the user for the specified variable binding.
N/A
setproc_good( ) - indicates successful completion of a setproc procedure
void setproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicate that setproc has successfully completed the set operation for a variable binding.
N/A
setproc_error( ) - indicate that a setproc operation encountered an error
void setproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )
This routine indicates that setproc encountered an error while perorming a set operation for a variable binding.
N/A
undoproc_started( ) - indicate that an undoproc operation has begun
void undoproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that undoproc has been started by the user for the specified variable binding.
N/A
undoproc_good( ) - indicates successful completion of an undoproc operation
void undoproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine indicates that an undoproc operation completed successfully.
N/A
undoproc_error( ) - indicate that an undproc operation encountered an error
void undoproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error value */ )
This routine indicates that undoproc encountered an error for a specified variable binding.
N/A
getproc_got_uint64( ) - indicate retrieval of a 64-bit unsigned integer
void getproc_got_uint64 ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_64_T * data /* 64 bit data */ )
This routine is called from getproc or nextproc when a 64-bit unsigned integer value is retrieved for a variable binding.
N/A
getproc_got_uint64_high_low( ) - indicate retrieval of a 64-bit unsigned
void getproc_got_uint64_high_low ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_32_T high, /* high half of data */ UINT_32_T low /* lower half of data */ )
integer with high and low halves
This routine is called from getproc or nextproc when a 64-bit unsigned integer value with both high and low halves is retrieved for a variable binding.
N/A
getproc_nosuchins( ) - indicates that no such instance exists
void getproc_nosuchins ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )
This routine is called from getproc if the requested instance does not exist.
N/A
getproc_got_object_id( ) - indicate retrieval of an object identifier
void getproc_got_object_id ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ int length, /* The length of the oid */ OIDC_T * pOid, /* The oid to attach */ int flag /* The dynamic flag static (0), dynamic (1) */ )
This routine is called from getproc or nextproc when an object identifier is retrieved for a variable binding. If flag is 1, then pOid is assumed to point to dynamic memory which will be later freed by the agent.
N/A
nextproc_next_instance( ) - install instance part of next instance
void nextproc_next_instance ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ int length, /* The length of the instance part */ OIDC_T * pOid /* The instance part */ )
This routine is called from nextproc to install into the variable-binding list the instance part (pOid) of the next instance that it is going to place into the variable binding.
N/A