Jump to main content

##

# TCPIP_MODULE_SIGNAL Enumeration

## C

    typedef enum {
    TCPIP_MODULE_SIGNAL_NONE = 0x0000,
    TCPIP_MODULE_SIGNAL_RX_PENDING = 0x0001,
    TCPIP_MODULE_SIGNAL_TMO = 0x0002,
    TCPIP_MODULE_SIGNAL_INTERFACE_CONFIG = 0x0004,
    TCPIP_MODULE_SIGNAL_INTERFACE_CHANGE = 0x0008,
    TCPIP_MODULE_SIGNAL_ASYNC = 0x0100,
    TCPIP_MODULE_SIGNAL_MASK_ALL = (TCPIP_MODULE_SIGNAL_RX_PENDING | TCPIP_MODULE_SIGNAL_TMO | TCPIP_MODULE_SIGNAL_INTERFACE_CONFIG | TCPIP_MODULE_SIGNAL_INTERFACE_CHANGE)
    } TCPIP_MODULE_SIGNAL;

## Description

Enumeration: TCPIP_MODULE_SIGNAL.

These signals are generated by the stack manager towards the internal stack modules; A stack app could use them to provide wake up conditions for a thread waiting for a signal to occur. This is mainly useful when the stack module's tasks functions are executed at the app level and the app needs a way to identify that a module needs attention.

## Preconditions

None.

## Parameters

Parameters | Description
--- | ---
TCPIP_MODULE_SIGNAL_NONE = 0x0000 | No pending signal.
TCPIP_MODULE_SIGNAL_RX_PENDING = 0x0001 | RX packet pending for processing.
TCPIP_MODULE_SIGNAL_TMO = 0x0002 | Module timeout has occurred for modules that implement a state machine advancing on timer signals.
TCPIP_MODULE_SIGNAL_INTERFACE_CONFIG = 0x0004 | Interface entered the configuration mode. interface is not ready to use. Address could change as a result of this configuration. The signal parameter carries the interface mask: 1 << if index occurs for modules that maintain connected sockets depending on the interface address: UDP and TCP.
TCPIP_MODULE_SIGNAL_INTERFACE_CHANGE = 0x0008 | Interface address change. Interface is out of configuration mode and ready. Address could have changed. Occurs for modules that maintain connected sockets depending on the interface address: UDP and TCP ARP module. Also processes the signal. The signal parameter carries the interface mask: 1 << if index.
TCPIP_MODULE_SIGNAL_ASYNC = 0x0100 | Special signals module. Asynchronous attention required. This is a signal that's requested by modules that need special attention. Module is required to clear this flag when out of the critical processing.
TCPIP_MODULE_SIGNAL_MASK_ALL = (TCPIP_MODULE_SIGNAL_RX_PENDING | TCPIP_MODULE_SIGNAL_TMO

## Returns

None.

## Remarks

Multiple signals could be ORed. Only 16-bit values are maintained for this type of signal.