www.beck-ipc.com

@CHIP-RTOS C Library V2.06 - TCP/IP API


Get_SNMP_DataEx

Get internal TCP/IP SNMP variables (Extended).

int Get_SNMP_DataEx ( unsigned char which,
                      void far * *snmp_mib_ptr,
                      int *max );

Parameters

which

Specifies which data to access.

1:   Get pointer to IfMib data structure
2:   Get pointer to IpMib data structure
3:   Get pointer to IcmpMib data structure
4:   Get pointer to TcpMib data structure
5:   Get pointer to UdpMib data structure
6:   Get pointer to atEntry data structure
7:   Set array of pointers to IfMib entries of all current open TCP/IP device interfaces (Local Loopback, Ethernet, PPP server, PPP client).   The value at max must specify the maximum number of pointers in this array.
8:   Get pointer to unsigned long system up-time variable (10 Hz counter).

snmp_mib_ptr

Output Parameter:

For cases where which is not set to 7, this is a pointer to a single far pointer in user memory which will be set by this API with a pointer to requested object within the @CHIP-RTOS memory space.

For case where which is set to 7, this is a pointer to an array of far pointers within the caller's memory.   This array will be set by this API call with pointers to IfMib data structures located in @CHIP-RTOS memory.   One pointer for each device interface will be reported, up to a maximum limited by the count specified at the max input parameter.

max

Input/Output Parameter:   This parameter only applies to case where which is set to 7.   It is otherwise not used.   For which case 7, this location must be preset by caller to the number of pointers in the array referenced by the snmp_mib_ptr input parameter.   On return, the referenced count will indicate the number of devices for which IfMib pointers have been listed in the snmp_mib_ptr output array.

Return Value

non-zero : RTOS version without internal SNMP mib variables
0: Location refereced by snmp_mib_ptr contains a pointer to the structure

Comments

This API provides access to the internal TCP/IP variables which will be required if the user is to implement a SNMP (Simple Network Management Protocol) agent.

SC1x3 Comments

This API currently only supports IPv4 protocol.

SC1x Comments

These structures are only available in @CHIP-RTOS versions which contain the SNMP option.   A SNMP agent is not part of the @CHIP-RTOS.

The SNMP variables are not a part of our current official 6 SC1x @CHIP-RTOS versions.   You must order directly an SC1x @CHIP-RTOS version which includes this feature.

See Also

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3
    V1.01V1.00V1.00V0.90

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document