From b5810b930d756f5e1f0878cb6b202abc78ecb164 Mon Sep 17 00:00:00 2001 From: Lachlan Roberts Date: Fri, 4 Sep 2020 17:43:36 +1000 Subject: [PATCH] Issue #5824 - improve javadocs for RemoteEndpoint maxOutgoingFrames Signed-off-by: Lachlan Roberts --- .../org/eclipse/jetty/websocket/api/RemoteEndpoint.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java index 37dcec929481..0b13c57fa3a0 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java @@ -144,7 +144,9 @@ public interface RemoteEndpoint /** * Set the maximum number of frames which allowed to be waiting to be sent at any one time. * The default value is -1, this indicates there is no limit on how many frames can be - * queued to be sent by the implementation. + * queued to be sent by the implementation. If the limit is exceeded, subsequent frames + * sent are failed with a {@link java.nio.channels.WritePendingException} but + * the connection is not failed and will remain open. * * @param maxOutgoingFrames the max number of frames. */ @@ -153,7 +155,9 @@ public interface RemoteEndpoint /** * Get the maximum number of frames which allowed to be waiting to be sent at any one time. * The default value is -1, this indicates there is no limit on how many frames can be - * queued to be sent by the implementation. + * queued to be sent by the implementation. If the limit is exceeded, subsequent frames + * sent are failed with a {@link java.nio.channels.WritePendingException} but + * the connection is not failed and will remain open. * * @return the max number of frames. */