Network Component  Version 7.12.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetSNMP: SNMP Agent

Events generated by the Network - SNMP Agent functions. More...

Functions

__STATIC_INLINE void EvrNetSNMP_InitAgent (void)
 Event on SNMP agent initialize (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_GetSocketFailed (void)
 Event on SNMP agent failed to allocate UDP socket (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ShowCommunity (const char *community, uint32_t length)
 Event on SNMP agent display community (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_SetCommunity (const char *community, uint32_t length)
 Event on netSNMP_SetCommunity (API) More...
 
__STATIC_INLINE void EvrNetSNMP_SetCommunityInvalidParam (void)
 Event on netSNMP_SetCommunity invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_SetMibTable (uint32_t num_entries)
 Event on netSNMP_SetMIB_Table (API) More...
 
__STATIC_INLINE void EvrNetSNMP_SetMibTableInvalidParam (void)
 Event on netSNMP_SetMIB_Table invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_Trap (const uint8_t *ip4_addr, uint8_t generic, uint8_t specific, uint16_t nobj)
 Event on netSNMP_Trap (API) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapInvalidParameter (void)
 Event on netSNMP_Trap invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapMibTableNotSet (void)
 Event on netSNMP_Trap invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapMissingSysObjectId (void)
 Event on netSNMP_Trap missing 'sysObjectID' object in MIB table (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapGenericTrapInvalid (uint8_t generic, uint8_t max_generic)
 Event on netSNMP_Trap generic trap invalid (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapTooManyObjects (int32_t nobj, int32_t max_nobj)
 Event on netSNMP_Trap maximum number of objects exceeded (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapObjectNotExisting (int32_t obj, int32_t max_obj)
 Event on netSNMP_Trap requested TLV object not existing in MIB table (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TrapMessageTooBig (uint16_t size, uint16_t max_size)
 Event on netSNMP_Trap generated message too big (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_AddObject (int32_t obj, uint8_t obj_type)
 Event on SNMP add object to SNMP message (Detail) More...
 
__STATIC_INLINE void EvrNetSNMP_ReceiveFrame (const uint8_t *ip4_addr, uint32_t length)
 Event on SNMP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on SNMP receive frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_FrameProtocolError (void)
 Event on SNMP received frame protocol error detected (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_VersionNotSupported (int32_t version)
 Event on SNMP received protocol version not supported (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_WrongCommunityReceived (void)
 Event on SNMP received community wrong (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_InvalidRequestType (uint8_t req_type)
 Event on SNMP received invalid PDU request type (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ShowRequest (uint8_t req_type, int32_t req_id)
 Event on SNMP display received PDU request type and id (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_TooManyObjectsReceived (int32_t nobj, int32_t max_nobj)
 Event on SNMP received too many TLV objects (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ObjectNotFound (int32_t obj)
 Event on SNMP receive message object not found in the MIB table (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ObjectWrongType (int32_t obj)
 Event on SNMP receive message object type not the same as in the MIB table (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ObjectReadOnly (int32_t obj)
 Event on SNMP write read-only object not allowed (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_ObjectWriteFailed (int32_t obj)
 Event on SNMP object write attempt failed for unknown reason (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_SendErrorStatus (uint8_t stat, uint8_t obj_index)
 Event on SNMP send error status response to a SNMP request (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_ResponseMessageTooBig (uint16_t size, uint16_t max_size)
 Event on SNMP response message would be too big (Error) More...
 
__STATIC_INLINE void EvrNetSNMP_SendGetResponse (int32_t req_id)
 Event on SNMP send get-response to a SNMP request (Op) More...
 
__STATIC_INLINE void EvrNetSNMP_UninitAgent (void)
 Event on SNMP agent de-initialize (Op) More...
 

Description

Events generated by the Network - SNMP Agent functions.

Function Documentation

__STATIC_INLINE void EvrNetSNMP_AddObject ( int32_t  obj,
uint8_t  obj_type 
)

Event on SNMP add object to SNMP message (Detail)

Parameters
objobject identification number
obj_typeobject data type
  • 0x02: Integer Data Type (signed integer)
  • 0x04: Octet String Data Type
  • 0x05: Null Item Data Type
  • 0x06: Object Identifier Data Type
  • 0x30: Sequence Data Type
  • 0x40: IP Address Data Type
  • 0x41: Counter Data Type (pos.integer)
  • 0x42: Gauge Data Type (pos.integer)
  • 0x43: Time Ticks Data Type (pos.integer)
  • 0x44: Opaque Data Type (ASN.1 encoded)
__STATIC_INLINE void EvrNetSNMP_FrameProtocolError ( void  )

Event on SNMP received frame protocol error detected (Error)

__STATIC_INLINE void EvrNetSNMP_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on SNMP receive frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetSNMP_GetSocketFailed ( void  )

Event on SNMP agent failed to allocate UDP socket (Error)

__STATIC_INLINE void EvrNetSNMP_InitAgent ( void  )

Event on SNMP agent initialize (Op)

__STATIC_INLINE void EvrNetSNMP_InvalidRequestType ( uint8_t  req_type)

Event on SNMP received invalid PDU request type (Error)

Parameters
req_typePDU request type
  • 0xA0: GetRequest PDU
  • 0xA1: GetNextRequest PDU
  • 0xA2: Response PDU
  • 0xA3: SetRequest PDU
  • 0xA4: Trap PDU
__STATIC_INLINE void EvrNetSNMP_ObjectNotFound ( int32_t  obj)

Event on SNMP receive message object not found in the MIB table (Error)

Parameters
objobject identification number
__STATIC_INLINE void EvrNetSNMP_ObjectReadOnly ( int32_t  obj)

Event on SNMP write read-only object not allowed (Error)

Parameters
objobject identification number
__STATIC_INLINE void EvrNetSNMP_ObjectWriteFailed ( int32_t  obj)

Event on SNMP object write attempt failed for unknown reason (Error)

Parameters
objobject identification number
__STATIC_INLINE void EvrNetSNMP_ObjectWrongType ( int32_t  obj)

Event on SNMP receive message object type not the same as in the MIB table (Error)

Parameters
objobject identification number
__STATIC_INLINE void EvrNetSNMP_ReceiveFrame ( const uint8_t *  ip4_addr,
uint32_t  length 
)

Event on SNMP receive frame (Op)

Parameters
ip4_addrpointer to IPv4 address of the server
lengthframe length in bytes
__STATIC_INLINE void EvrNetSNMP_ResponseMessageTooBig ( uint16_t  size,
uint16_t  max_size 
)

Event on SNMP response message would be too big (Error)

Parameters
sizeresponse message size
max_sizemaximum message size allowed
__STATIC_INLINE void EvrNetSNMP_SendErrorStatus ( uint8_t  stat,
uint8_t  obj_index 
)

Event on SNMP send error status response to a SNMP request (Op)

Parameters
staterror status
obj_indexerror object index
__STATIC_INLINE void EvrNetSNMP_SendGetResponse ( int32_t  req_id)

Event on SNMP send get-response to a SNMP request (Op)

Parameters
req_idPDU request identifier
__STATIC_INLINE void EvrNetSNMP_SetCommunity ( const char *  community,
uint32_t  length 
)

Event on netSNMP_SetCommunity (API)

Parameters
communitypointer to SNMP community string
lengthlength of the community string
__STATIC_INLINE void EvrNetSNMP_SetCommunityInvalidParam ( void  )

Event on netSNMP_SetCommunity invalid parameter (Error)

__STATIC_INLINE void EvrNetSNMP_SetMibTable ( uint32_t  num_entries)

Event on netSNMP_SetMIB_Table (API)

Parameters
num_entriesnumber of entries in MIB table
__STATIC_INLINE void EvrNetSNMP_SetMibTableInvalidParam ( void  )

Event on netSNMP_SetMIB_Table invalid parameter (Error)

__STATIC_INLINE void EvrNetSNMP_ShowCommunity ( const char *  community,
uint32_t  length 
)

Event on SNMP agent display community (Op)

Parameters
communitypointer to SNMP community string
lengthlength of the community string
__STATIC_INLINE void EvrNetSNMP_ShowRequest ( uint8_t  req_type,
int32_t  req_id 
)

Event on SNMP display received PDU request type and id (Error)

Parameters
req_typePDU request type
  • 0xA0: GetRequest PDU
  • 0xA1: GetNextRequest PDU
  • 0xA2: Response PDU
  • 0xA3: SetRequest PDU
  • 0xA4: Trap PDU
req_idPDU request identifier
__STATIC_INLINE void EvrNetSNMP_TooManyObjectsReceived ( int32_t  nobj,
int32_t  max_nobj 
)

Event on SNMP received too many TLV objects (Error)

Parameters
nobjnumber of TLV objects
max_nobjmaximum number of TLV objects
__STATIC_INLINE void EvrNetSNMP_Trap ( const uint8_t *  ip4_addr,
uint8_t  generic,
uint8_t  specific,
uint16_t  nobj 
)

Event on netSNMP_Trap (API)

Parameters
ip4_addrtrap server IPv4 address
genericgeneric trap type
  • 0: coldStart trap
  • 1: warmStart trap
  • 2: linkDown trap
  • 3: linkUp trap
  • 4: authenticationFailure trap
  • 5: egpNeighborLoss trap
  • 6: enterpriseSpecific trap
specificspecific trap type for generic enterpriseSpecific trap
  • must be set to 0 for generic traps 0 .. 5
nobjnumber of objects in a trap message
__STATIC_INLINE void EvrNetSNMP_TrapGenericTrapInvalid ( uint8_t  generic,
uint8_t  max_generic 
)

Event on netSNMP_Trap generic trap invalid (Error)

Parameters
genericinvalid generic trap type
max_genericmaximum value for generic trap type
__STATIC_INLINE void EvrNetSNMP_TrapInvalidParameter ( void  )

Event on netSNMP_Trap invalid parameter (Error)

__STATIC_INLINE void EvrNetSNMP_TrapMessageTooBig ( uint16_t  size,
uint16_t  max_size 
)

Event on netSNMP_Trap generated message too big (Error)

Parameters
sizerequested message size
max_sizemaximum message size accepted
__STATIC_INLINE void EvrNetSNMP_TrapMibTableNotSet ( void  )

Event on netSNMP_Trap invalid parameter (Error)

__STATIC_INLINE void EvrNetSNMP_TrapMissingSysObjectId ( void  )

Event on netSNMP_Trap missing 'sysObjectID' object in MIB table (Error)

__STATIC_INLINE void EvrNetSNMP_TrapObjectNotExisting ( int32_t  obj,
int32_t  max_obj 
)

Event on netSNMP_Trap requested TLV object not existing in MIB table (Error)

Parameters
objobject identification number
max_objmaximum value for object identification number
__STATIC_INLINE void EvrNetSNMP_TrapTooManyObjects ( int32_t  nobj,
int32_t  max_nobj 
)

Event on netSNMP_Trap maximum number of objects exceeded (Error)

Parameters
nobjnumber of TLV objects
max_nobjmaximum number of TLV objects
__STATIC_INLINE void EvrNetSNMP_UninitAgent ( void  )

Event on SNMP agent de-initialize (Op)

__STATIC_INLINE void EvrNetSNMP_VersionNotSupported ( int32_t  version)

Event on SNMP received protocol version not supported (Op)

Parameters
versionreceived SNMP protocol version
  • 1: SNMPv1
  • 2: SNMPv2
  • 3: SNMPv3
Remarks
Only SNMPv1 is currently supported.
__STATIC_INLINE void EvrNetSNMP_WrongCommunityReceived ( void  )

Event on SNMP received community wrong (Op)