www.beck-ipc.com

@CHIP-RTOS C Library - TCP/IP API


Register_ARP_User_CB

Register an ARP User callback handler.

void Register_ARP_User_CB(void far * funcPtr);

Parameters

funcptr

Pointer to ARP callback function (or set to null to remove a previously installed callback)

Return Value

returns nothing

Comments

The application programmer can implement a function fitting the following type definition:

    typedef int (huge *MyArpCallbackFuncPtr)(
                 ArpUserCallbackInfo_t far *arpInfo );


If a function of this type is installed by the user, the TCP/IP stack will call this function for any incoming ARP packet.   The input parameter to the callback function allows access to the ARP packet.   Inside of this function the user is able to check the content of the incoming ARP packet and decide whether the TCP/IP stack should process this packet or ignore it.   If the callback function returns -1, the incoming packet will be ignored by the TCP/IP stack.
If the size of the returned structure ArpUserCallbackInfo_t is equal or bigger 12, the structure now contains a devicehandle_ptr to determine the source device of the incoming packet for filtering.


For structure of an ARP packet see ArpHeader.

To remove the callback function, this function call must be called with a null pointer.   Do not forget to uninstall the callback if your application exits!

Refer to this RTOS API function's documentation for more details.

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

    SC12SC13SC11SC1x3SC2x
    V1.10V1.00V1.00V0.90V1.00

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


End of document