Methode ITcIoTcpProtocolRecv:ReceiveEvent

Wird vom TCP/UDP RT Modul als Callback aufgerufen, falls ein Event aufgetreten ist.

Syntax

HRESULT TCOMAPI ReceiveEvent(ULONG socketId, TCPIP_EVENT tcpEvent)

Methode ITcIoTcpProtocolRecv:ReceiveEvent 1: Rückgabewert

Name

Typ

Beschreibung

ReceiveEvent

HRESULT

Bezeichnet den Erfolg und muss vom implementierenden Modul entsprechend geliefert werden.

Parameter

Name

Typ

Beschreibung

socketId

ULONG

Der Socket auf dem Daten empfangen wurden.

tcpEvent

TCP_EVENT

Ein Element der Enum.

Das Enumeration TCP_EVENT bezeichnet unterschiedliche Ereignisse, die bei einer TCP-Verbindung auftreten können: 

enum TCPIP_EVENT : ULONG {
    TCPIP_EVENT_NONE = 0,
    TCPIP_EVENT_ERROR = 1,
    TCPIP_EVENT_RESET = 2,
    TCPIP_EVENT_TIMEOUT = 3,
    TCPIP_EVENT_CONN_ESTABLISHED = 4,
    TCPIP_EVENT_CONN_INCOMING = 5,
    TCPIP_EVENT_CONN_CLOSED = 6,
    TCPIP_EVENT_CONN_IDLE = 7,
    TCPIP_EVENT_DATA_RECEIVED = 8,
    TCPIP_EVENT_DATA_SENT = 9,
    TCPIP_EVENT_KEEP_ALIVE = 10,
    TCPIP_EVENT_LINKCONNECT = 11,
    TCPIP_EVENT_LINKDISCONNECT = 12
};

Eine Implementierung der Methode soll damit ein Switch-Case über alle Elemente bereitstellen, sodass entsprechend des Events reagiert werden kann.

Zur Verwendung der Events für ein TCP-Server wird die Verwendung in der Interface-Übersicht beschrieben.