www.beck-ipc.com

@CHIP-RTOS C Library - TCP/IP API


RegisterIPCallbackHandler

Register an IP User callback handler.

int RegisterIPCallbackHandler ( void far *funcptr );

Parameters

funcptr

Pointer to user's IP callback Handler.

Return Value

0 = success

Comments

This function allows the application programmer to install a ip packet filter callback function. The application programmer can implement a function fitting the following type definition:

    typedef int (huge *IPSortOutFuncPtr)(
                 IpUserCallbackInfo *ipInfo );


If a function of this type is installed by the user, the TCP/IP stack will call this function at any incoming IP packet.   Inside of this function the user is able to check the given IP parameters and decide if 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.

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

SC1x3/SC2x Comments

Important:    The callback will only execute on incoming IPv4 packets.

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