Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes #1756 - improving javadoc for WebSocketPolicy max text/binary message size

This commit is contained in:
Joakim Erdfelt 2017-09-06 10:22:12 -07:00
parent acc7c97969
commit db77305550
1 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPolicy.java
View File

@ -205,9 +205,15 @@ public class WebSocketPolicy
}
/**
* Get the maximum size of a binary message during parsing/generating.
* Get the maximum size of a binary message during parsing.
* <p>
* Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* This is a memory conservation option, memory over this limit will not be
* allocated by Jetty for handling binary messages. This applies to individual frames,
* whole message handling, and partial message handling.
* </p>
* <p>
* Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* </p>
*
* @return the maximum size of a binary message
*/
@ -227,9 +233,15 @@ public class WebSocketPolicy
}
/**
* Get the maximum size of a text message during parsing/generating.
* Get the maximum size of a text message during parsing.
* <p>
* Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* This is a memory conservation option, memory over this limit will not be
* allocated by Jetty for handling text messages. This applies to individual frames,
* whole message handling, and partial message handling.
* </p>
* <p>
* Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* </p>
*
* @return the maximum size of a text message.
*/
@ -279,7 +291,7 @@ public class WebSocketPolicy
/**
* The maximum size of a binary message buffer.
* <p>
* Used ONLY for stream based message writing.
* Used ONLY for stream based binary message writing.
*
* @param size
* the maximum size of the binary message buffer
@ -292,9 +304,15 @@ public class WebSocketPolicy
}
/**
* The maximum size of a binary message during parsing/generating.
* The maximum size of a binary message during parsing.
* <p>
* Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* This is a memory conservation option, memory over this limit will not be
* allocated by Jetty for handling binary messages. This applies to individual frames,
* whole message handling, and partial message handling.
* </p>
* <p>
* Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* </p>
*
* @param size
* the maximum allowed size of a binary message.
@ -309,7 +327,7 @@ public class WebSocketPolicy
/**
* The maximum size of a text message buffer.
* <p>
* Used ONLY for stream based message writing.
* Used ONLY for stream based text message writing.
*
* @param size
* the maximum size of the text message buffer
@ -322,9 +340,15 @@ public class WebSocketPolicy
}
/**
* The maximum size of a text message during parsing/generating.
* The maximum size of a text message during parsing.
* <p>
* Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* This is a memory conservation option, memory over this limit will not be
* allocated by Jetty for handling text messages. This applies to individual frames,
* whole message handling, and partial message handling.
* </p>
* <p>
* Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE}
* </p>
*
* @param size
* the maximum allowed size of a text message.