TCPIP_IGMP_HandlerRegister Function

C

TCPIP_IGMP_HANDLE TCPIP_IGMP_HandlerRegister(
    IPV4_ADDR mcastAddress, 
    TCPIP_IGMP_EVENT_HANDLER handler, 
    const void* hParam
);

Description

This function registers an IGMP client event handler. The IGMP client module will call the registered handler when an IGMP client event (TCPIP_IGMP_EVENT_TYPE) occurs.

Preconditions

The IGMP module must be initialized.

Parameters

ParametersDescription
hNetInterface handle. Use hNet == 0 to register on all interfaces available.
handlerHandler to be called when an IGMP client event occurs.
hParamPointer to be used by the application to differentiate between IGMP events. Not used by IGMP.

Returns

  • Valid handle - if the call succeeds.

  • NULL handle - if the call failed (out of memory, for example).

Remarks

The handler has to be short and fast. It is meant for setting an event flag, not for lengthy processing.