Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify maximum websocket frame length configuration #3116

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Clarify maximum websocket frame length configuration #3116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -39,6 +39,7 @@ public interface WebsocketSpec {

/**
* Returns the configured maximum allowable frame payload length.
* <p>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.
*/
Expand Down Expand Up @@ -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.
* <p>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}
Expand Down
Loading