Skip to content

Commit

Permalink
Issue jetty#5824 - improve javadocs for RemoteEndpoint maxOutgoingFrames
Browse files Browse the repository at this point in the history
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
  • Loading branch information
lachlan-roberts committed Sep 4, 2020
1 parent 52c9f87 commit b5810b9
Showing 1 changed file with 6 additions and 2 deletions.
Expand Up @@ -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.
*/
Expand All @@ -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.
*/
Expand Down

0 comments on commit b5810b9

Please sign in to comment.