From 401be64a7e13be63956045466747072971d6a69c Mon Sep 17 00:00:00 2001 From: Violeta Georgieva Date: Mon, 25 Mar 2024 12:04:39 +0200 Subject: [PATCH] [doc] Clarify maximum websocket frame length configuration Fixes #3108 --- .../java/reactor/netty/http/websocket/WebsocketSpec.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java index 307f65a6c8..199e266e79 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2024 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,6 +39,7 @@ public interface WebsocketSpec { /** * Returns the configured maximum allowable frame payload length. + *

Note: When a websocket compression extension is enabled, this setting is applied on the compressed data. * * @return returns the configured maximum allowable frame payload length. */ @@ -81,8 +82,9 @@ public final SPEC protocols(String protocols) { } /** - * Sets specifies a custom maximum allowable frame payload length. + * Sets a custom maximum allowable frame payload length. * 65536 by default. + *

Note: When a websocket compression extension is enabled, this setting is applied on the compressed data. * * @param maxFramePayloadLength maximum allowable frame payload length * @return {@literal this}