TCPIP_MODULE_SignalFunctionDeregister Function

C

bool TCPIP_MODULE_SignalFunctionDeregister(
    TCPIP_MODULE_SIGNAL_HANDLE signalHandle
);

Description

This function deregisters a previous signal function. The caller will no longer be notified of stack internal signals.

Preconditions

The TCP/IP stack should have been initialized by TCPIP_STACK_Initialize() and the TCPIP_STACK_Status() returned SYS_STATUS_Ready. signalHandle - a valid signal handle.

Parameters

ParametersDescription
signalHandleSignal handle obtained from a registration call.

Returns

  • True - If the operation succeeded.

  • False - If the operation failed (i.e, no such module, invalid handle, etc.).

Remarks

See the remarks for TCPIP_MODULE_SignalFunctionRegister().

Example

void appSignalFunc(TCPIP_STACK_MODULE moduleId, TCPIP_MODULE_SIGNAL signal)
{
    // process incoming signal for the incoming module
}

TCPIP_MODULE_SIGNAL_HANDLE signalH = TCPIP_MODULE_SignalFunctionRegister( TCPIP_MODULE_HTTP_SERVER, appSignalFunc);

// when done with this signal notification
TCPIP_MODULE_SignalFunctionDeregister(signalH);