QUIC_LISTENER_EVENT structure

QUIC listener events and the corresponding payload

Syntax

typedef enum QUIC_LISTENER_EVENT_TYPE {
    QUIC_LISTENER_EVENT_NEW_CONNECTION      = 0,
    QUIC_LISTENER_EVENT_STOP_COMPLETE       = 1,
    QUIC_LISTENER_EVENT_DOS_MODE_CHANGED    = 2,
} QUIC_LISTENER_EVENT_TYPE;

The payload for QUIC listener events.

typedef struct QUIC_LISTENER_EVENT {
    QUIC_LISTENER_EVENT_TYPE Type;
    union {
        struct {
            const QUIC_NEW_CONNECTION_INFO* Info;
            HQUIC Connection;
            const uint8_t* NewNegotiatedAlpn;
        } NEW_CONNECTION;
        struct {
            BOOLEAN AppCloseInProgress  : 1;
            BOOLEAN RESERVED            : 7;
        } STOP_COMPLETE;
        struct {
            BOOLEAN DosModeEnabled : 1;
            BOOLEAN RESERVED       : 7;
        } DOS_MODE_CHANGED;
    };
} QUIC_LISTENER_EVENT;

Parameters

Type

The QUIC_LISTENER_EVENT_TYPE that indicates which type of event this is, and which payload to reference (if any) for additional information.

Remarks

QUIC_LISTENER_EVENT_NEW_CONNECTION

This event is delivered when a new connection is received by the listener.

NEW_CONNECTION

Details of the new connection are passed in the NEW_CONNECTION struct/union.

Info

This field indicates the QUIC_NEW_CONNECTION_INFO structure for the new connection.

Connection

This field indicates the valid handle to the new incoming connection.

QUIC_LISTENER_EVENT_STOP_COMPLETE

This event is delivered when server app wants to stop receiving new incoming connections.

STOP_COMPLETE

Details of the listener stopping are indicated in STOP_COMPLETE struct/union.

AppCloseInProgress

This flag indicates the server has called ListenerClose.

RESERVED

This field reserved for future use. Do not use.

QUIC_LISTENER_EVENT_DOS_MODE_CHANGED

This event indicates an automated change in the DoS mode on the listener object in the MsQuic library. This event is delivered only for listener objects that have opted in for DoS mode change events. Refer to the Listener Parameters documentation for further information.

DOS_MODE_CHANGED

Details of the DoS mode change is indicated in the DOS_MODE_CHANGED struct/union.

DosModeEnabled

If TRUE, DoS mode is currently enabled on the listener object, else DoS mode is currently disabled on the listener object.