Jump to main content

##

# TCPIP_TCP_SIGNAL_TYPE Enumeration

## C

    typedef enum {
    TCPIP_TCP_SIGNAL_TX_DONE = 0x0001,
    TCPIP_TCP_SIGNAL_TX_DATA_DONE = 0x0002,
    TCPIP_TCP_SIGNAL_TX_SPACE = 0x0004,
    TCPIP_TCP_SIGNAL_TX_RST = 0x0008,
    TCPIP_TCP_SIGNAL_ESTABLISHED = 0x0100,
    TCPIP_TCP_SIGNAL_RX_DATA = 0x0200,
    TCPIP_TCP_SIGNAL_RX_FIN = 0x0400,
    TCPIP_TCP_SIGNAL_RX_RST = 0x0800,
    TCPIP_TCP_SIGNAL_KEEP_ALIVE_TMO = 0x1000,
    TCPIP_TCP_SIGNAL_IF_DOWN = 0x2000,
    TCPIP_TCP_SIGNAL_IF_CHANGE = 0x4000
    } TCPIP_TCP_SIGNAL_TYPE;

## Description

Enumeration: TCPIP_TCP_SIGNAL_TYPE.

Description of the signals/events that a TCP socket can generate.

## Members

Members | Description
--- | ---
TCPIP_TCP_SIGNAL_TX_DONE = 0x0001 | A TCP packet was successfully transmitted on the interface. This may indicate or not that new data can be sent with this socket. Note 1: The TCP buffer space is controlled by the TCP state machine; The fact that a packet was transmitted, doesn't necessarily mean that new data can be written into the socket buffer: 2: The packet may be an ACK only packet, retry packet, etc., and does not free any writing space in the socket buffer 3: A new socket writing space may not be available because the other party has not acknowledged the data it was sent so far. Therefore, the information carried by this signal has limited usage. 4: This notification is the result of an user action (explicit call to TCPIP_TCP_Flush) or as a result of the internal TCP state machine.
TCPIP_TCP_SIGNAL_TX_DATA_DONE = 0x0002 | A TCP data packet carrying valid payload was successfully transmitted on the interface. This may indicate or not that new data can be sent with this socket.
TCPIP_TCP_SIGNAL_TX_SPACE = 0x0004 | New TX space is available in the socket TX buffer. This event signals that the remote party has acknowledged some data and, as a result, TX buffer space is available.
TCPIP_TCP_SIGNAL_TX_RST = 0x0008 | Reset sent to the remote host and connection is reset.
TCPIP_TCP_SIGNAL_ESTABLISHED = 0x0100 | Socket established a connection (client or server socket).
TCPIP_TCP_SIGNAL_RX_DATA = 0x0200 | A data packet was successfully received and there is data available for this socket.
TCPIP_TCP_SIGNAL_RX_FIN = 0x0400 | Remote host finished its data and sent a FIN.
TCPIP_TCP_SIGNAL_RX_RST = 0x0800 | Remote host reset the connection.
TCPIP_TCP_SIGNAL_KEEP_ALIVE_TMO = 0x1000 | Keep alive has timed out; Connection to the remote host has been aborted.
TCPIP_TCP_SIGNAL_IF_DOWN = 0x2000 | Associated interface is going down; sockets connected on this interface will be disconnected, but still alive.
TCPIP_TCP_SIGNAL_IF_CHANGE = 0x4000 | Associated interface has changed address sockets connected on this interface will be disconnected, but still alive.

## Remarks

These signals are used in the socket event handling notification functions. It is possible that multiple flags are set as part of the same notification.

The signals are 16 bits wide.