Skip to content

readProxyProtocolV2

function readProxyProtocolV2(
socket,
timeoutMs,
maximumBytes?): Promise<ProxyProtocolV2Address>;

Defined in: src/launcher/proxy-protocol-v2.ts:257

Consume exactly one preamble under a single independent deadline. Bytes received after its declared length are pushed back for Arrow IPC.

Parameter Type Default value
socket Socket undefined
timeoutMs number undefined
maximumBytes number DEFAULT_MAX_PROXY_V2_BYTES

Promise<ProxyProtocolV2Address>