Author: markt Date: Wed Nov 20 11:09:12 2013 New Revision: 1543773 URL: http://svn.apache.org/r1543773 Log: Clarify purposes of buffers.
Modified: tomcat/tc7.0.x/trunk/ (props changed) tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml tomcat/tc7.0.x/trunk/webapps/docs/web-socket-howto.xml Propchange: tomcat/tc7.0.x/trunk/ ------------------------------------------------------------------------------ Merged /tomcat/trunk:r1543772 Modified: tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml?rev=1543773&r1=1543772&r2=1543773&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Wed Nov 20 11:09:12 2013 @@ -244,6 +244,10 @@ in the security how-to section of the documentation web application. (markt) </add> + <fix> + Expand the description of the WebSocket buffers in the documentation web + application to clarify their purpose. (markt) + </fix> </changelog> </subsection> <subsection name="Extras"> Modified: tomcat/tc7.0.x/trunk/webapps/docs/web-socket-howto.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/web-socket-howto.xml?rev=1543773&r1=1543772&r2=1543773&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/web-socket-howto.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/web-socket-howto.xml Wed Nov 20 11:09:12 2013 @@ -65,15 +65,23 @@ the timeout to use in milliseconds. For an infinite timeout, use <code>-1</code>.</p> -<p>The default buffer size for binary messages is 8192 bytes. This may be - changed for a web application by setting the servlet context initialization - parameter <code>org.apache.tomcat.websocket.binaryBufferSize</code> to the - desired value in bytes.</p> - -<p>The default buffer size for text messages is 8192 bytes. This may be - changed for a web application by setting the servlet context initialization - parameter <code>org.apache.tomcat.websocket.textBufferSize</code> to the - desired value in bytes.</p> +<p>If the application does not define a <code>MessageHandler.Partial</code> for + incoming binary messages, any incoming binary messages must be buffered so + the entire message can be delivered in a single call to the registered + <code>MessageHandler.Whole</code> for binary messages. The default buffer + size for binary messages is 8192 bytes. This may be changed for a web + application by setting the servlet context initialization parameter + <code>org.apache.tomcat.websocket.binaryBufferSize</code> to the desired + value in bytes.</p> + +<p>If the application does not define a <code>MessageHandler.Partial</code> for + incoming text messages, any incoming text messages must be buffered so the + entire message can be delivered in a single call to the registered + <code>MessageHandler.Whole</code> for text messages. The default buffer size + for text messages is 8192 bytes. This may be changed for a web application by + setting the servlet context initialization parameter + <code>org.apache.tomcat.websocket.textBufferSize</code> to the desired value + in bytes.</p> <p>The Java WebSocket specification 1.0 does not permit programmatic deployment after the first endpoint has started a WebSocket handshake. By default, --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org