TCPIP_STACK_HandlerRegister Function

TCPIP_EVENT_HANDLE TCPIP_STACK_HandlerRegister(
    TCPIP_NET_HANDLE hNet, 
    TCPIP_EVENT evMask, 
    TCPIP_STACK_EVENT_HANDLER notifyHandler, 
    const void* notifyfParam
);

This function sets a new event notification handler. The caller can use the handler to be notified of stack events.

The TCP/IP stack should have been initialized by TCPIP_STACK_Initialize() and the TCPIP_STACK_Status() returned SYS_STATUS_Ready. The network interface should be up and running.

• A valid TCPIP_EVENT_HANDLE - If the operation succeeded.

• NULL - If the operation failed.

The notification handler may be called from the ISR which detects the corresponding event. The event notification handler has to be kept as short as possible and non-blocking.

Without a notification handler the stack user can still call TCPIP_STACK_GetPending() to see if processing by the stack needed. Currently only a primary interface can report events. The call will fail if the specified network is an alias.

TCPIP_EVENT_HANDLE myHandle = TCPIP_STACK_HandlerRegister( hNet, TCPIP_EV_CONN_ALL, myEventHandler, myParam );