comments on the generate() method

1 files changed, 7 insertions, 0 deletions

diff --git a/jetty-websocket/websocket-core/src/main/java/org/eclipse/jetty/websocket/protocol/Generator.java b/jetty-websocket/websocket-core/src/main/java/org/eclipse/jetty/websocket/protocol/Generator.java
index 59c223555d..1a39f17253 100644
--- a/jetty-websocket/websocket-core/src/main/java/org/eclipse/jetty/websocket/protocol/Generator.java
+++ b/jetty-websocket/websocket-core/src/main/java/org/eclipse/jetty/websocket/protocol/Generator.java
@@ -157,6 +157,13 @@ public class Generator
 
     }
 
+    /*
+     * The generate method needs to perform two functions.
+     * 
+     * 1 - on the initial call for a given frame it needs to generate the framing bytecode and as much of the payload as will fit in the given buffer size
+     * 
+     * 2 - on subsequent calls it needs to return as much of the payload as will fit in the given buffer size
+     */
     public ByteBuffer generate(int bufferSize, WebSocketFrame frame)
     {
         LOG.debug(String.format("Generate.Frame[opcode=%s,fin=%b,cont=%b,rsv1=%b,rsv2=%b,rsv3=%b,mask=%b,plength=%d]",frame.getOpCode().toString(),