Author: markt
Date: Thu Dec 27 21:40:39 2012
New Revision: 1426336
URL: http://svn.apache.org/viewvc?rev=1426336&view=rev
Log:
Javadoc
Modified:
tomcat/trunk/java/javax/websocket/PongMessage.java
tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java
tomcat/trunk/java/org/apache/tomcat/websocket/Utf8Decoder.java
tomcat/trunk/java/org/apache/tomcat/websocket/WsFrame.java
Modified: tomcat/trunk/java/javax/websocket/PongMessage.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/PongMessage.java?rev=1426336&r1=1426335&r2=1426336&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/PongMessage.java (original)
+++ tomcat/trunk/java/javax/websocket/PongMessage.java Thu Dec 27 21:40:39 2012
@@ -18,6 +18,13 @@ package javax.websocket;
import java.nio.ByteBuffer;
+/**
+ * Represents a WebSocket Pong message and used by message handlers to enable
+ * applications to process the response to any Pings they send.
+ */
public interface PongMessage {
+ /**
+ * Obtain the payload of the Pong message as a ByteBuffer.
+ */
ByteBuffer getApplicationData();
}
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java?rev=1426336&r1=1426335&r2=1426336&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java
(original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java Thu
Dec 27 21:40:39 2012
@@ -37,7 +37,8 @@ import javax.websocket.server.WebSocketP
/**
* For a POJO class annotated with
* {@link javax.websocket.server.WebSocketEndpoint}, an instance of this class
- * caches the method and parameter information for the onXXX calls.
+ * caches the method handlers and the method and parameter information for the
+ * onXXX calls.
*/
public class PojoMethodMapping {
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Utf8Decoder.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/Utf8Decoder.java?rev=1426336&r1=1426335&r2=1426336&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/Utf8Decoder.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/Utf8Decoder.java Thu Dec 27
21:40:39 2012
@@ -26,7 +26,9 @@ import org.apache.tomcat.util.buf.B2CCon
/**
* Decodes bytes to UTF-8. Extracted from Apache Harmony and modified to reject
* code points from U+D800 to U+DFFF as per RFC3629. The standard Java decoder
- * does not reject these.
+ * does not reject these. It has also been modified to reject code points
+ * greater than U+10FFFF which the standard Java decoder rejects but the
harmony
+ * one does not.
*/
public class Utf8Decoder extends CharsetDecoder {
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsFrame.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsFrame.java?rev=1426336&r1=1426335&r2=1426336&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/WsFrame.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/WsFrame.java Thu Dec 27
21:40:39 2012
@@ -33,8 +33,9 @@ import javax.websocket.PongMessage;
import org.apache.tomcat.util.res.StringManager;
/**
- * Takes the ServletInputStream and converts the received data into WebSocket
- * frames.
+ * Takes the ServletInputStream process the WebSocket frames it contains and
+ * extracts the messages. WebSocket Pings received will be responded to
+ * automatically without any action required by the application.
*/
public class WsFrame {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
