WSASetUdpRecvMaxCoalescedSize function (ws2tcpip.h)

Article
02/22/2024

Sets the maximum size of a coalesced message set on a UDP socket.

Syntax

INT WSASetUdpRecvMaxCoalescedSize(
  [in] SOCKET Socket,
  [in] DWORD  MaxCoalescedMsgSize
);

Parameters

[in] Socket

A descriptor that identifies a UDP socket.

[in] MaxCoalescedMsgSize

Type: DWORD

The maximum coalesced message size to be set on the socket for UDP receive coalescing.

Return value

On success, the function returns 0. Otherwise, a value of SOCKET_ERROR is returned, and you can retrieve a specific error code by calling WSAGetLastError.

Remarks

UDP receive coalescing is supported through the UDP_RECV_MAX_COALESCED_SIZE socket option. WSASetUdpRecvMaxCoalescedSize is a type-safe wrapper for setting this socket option, and we recommend it over setsockopt.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 2004 (10.0; Build 19041)
Minimum supported server	Windows Server, version 2004 (10.0; Build 19041)
Target Platform	Windows
Header	ws2tcpip.h
Library	Ws2_32.lib
DLL	Ws2_32.dll

Share via