SNMP Internal Members

Microchip TCP/IP Stack Help

The following functions and variables are designated as internal to the SNMP module.

Enumerations

Functions

	Name	Description
	_SNMPDuplexInit	Prepare for full duplex transfer.
	_SNMPGet	Read byte from snmp udp socket rx buffer.
	_SNMPPut	Copy byte to tx buffer.
	FindOIDsInRequest	Finds number of varbinds in the varbind list received in a pdu.
	GetDataTypeInfo	Get ASN data type info.
	IsASNNull	Verifies the value type as ASN_NULL.
	SetErrorStatus	Set snmp error status in the response pdu.
	IsValidLength	Retrieves the packet length and actual pdu length.
	GetNextLeaf	Searches for the next leaf node in the MIP tree.
	GetOIDStringByAddr	Get OID string from MPFS using the node address.
	GetOIDStringByID	Get complete notification variable OID string from MPFS using var id.
	IsValidCommunity	Verifies for the community string datatype and the max community name and length, this agent can process.
	IsValidInt	Verifies variable datatype as INT and retrieves its value.
	IsValidOID	Populates OID type, length and oid string from the received pdu.
	IsValidPDU	Verifies for the snmp request type.
	IsValidStructure	Decode variable length structure.
	OIDLookup	To search and validate whether the requested OID is in the MIB database.
	ProcessGetSetHeader	Validates the received udp packet Get/Set request header.
	ProcessHeader	Validates the received udp packet Snmp header.
	ProcessSetVar	Processes snmp Set request pdu.
	ProcessVariables	This routine processes the snmp request and parallely creates the response pdu.
	ReadMIBRecord	Get OID string from MPFS using the node address.
	SNMPCheckIfPvtMibObjRequested	To find whether requested OID is only for private access.

Macros

	Name	Description
	_SNMPGetTxOffset	This is macro _SNMPGetTxOffset.
	_SNMPSetTxOffset
	AGENT_NOTIFY_PORT	This is macro AGENT_NOTIFY_PORT.
	ASN_INT	This is macro ASN_INT.
	ASN_NULL	This is macro ASN_NULL.
	ASN_OID	This is macro ASN_OID.
	DATA_TYPE_TABLE_SIZE
	GET_BULK_REQUEST	This is macro GET_BULK_REQUEST.
	GET_NEXT_REQUEST	This is macro GET_NEXT_REQUEST.
	GET_REQUEST
	GET_RESPONSE	This is macro GET_RESPONSE.
	IS_AGENT_PDU	This is macro IS_AGENT_PDU.
	IS_ASN_INT	This is macro IS_ASN_INT.
	IS_ASN_NULL	This is macro IS_ASN_NULL.
	IS_GET_NEXT_REQUEST	This is macro IS_GET_NEXT_REQUEST.
	IS_GET_REQUEST	This is macro IS_GET_REQUEST.
	IS_GET_RESPONSE	This is macro IS_GET_RESPONSE.
	IS_OCTET_STRING	This is macro IS_OCTET_STRING.
	IS_OID	This is macro IS_OID.
	IS_SET_REQUEST	This is macro IS_SET_REQUEST.
	IS_STRUCTURE
	IS_TRAP	This is macro IS_TRAP.
	OCTET_STRING	This is macro OCTET_STRING.
	SET_REQUEST	This is macro SET_REQUEST.
	SNMP_AGENT_PORT
	SNMP_BIB_FILE_NAME	This is the file that contains SNMP bib file. File name must contain all upper case letter and must match with what was included in MPFS2 image.
	SNMP_COUNTER32	This is macro SNMP_COUNTER32.
	SNMP_GAUGE32	This is macro SNMP_GAUGE32.
	SNMP_IP_ADDR	This is macro SNMP_IP_ADDR.
	SNMP_NMS_PORT	This is macro SNMP_NMS_PORT.
	SNMP_NSAP_ADDR	This is macro SNMP_NSAP_ADDR.
	SNMP_OPAQUE	This is macro SNMP_OPAQUE.
	SNMP_TIME_TICKS	This is macro SNMP_TIME_TICKS.
	SNMP_V1
	SNMP_V2C	This is macro SNMP_V2C.
	STRUCTURE
	TRAP	This is macro TRAP.

Module

Structures

Unions

Variables

	Name	Description
	appendZeroToOID	global flag to modify OID by appending zero
	dataTypeTable	ASN format datatype for snmp v1 and v2c
	hMPFS	MPFS file handler
	SNMPAgentSocket	Snmp udp socket
	SNMPNotifyInfo	notify info for trap
	snmpReqVarErrStatus	vars from req list processing err status
	SNMPRxOffset	Snmp udp buffer rx offset
	SNMPStatus	MIB file access status
	SNMPTxOffset	Snmp udp buffer tx offset
	trapInfo	Initialize trap table with no entries.