Created a LazyMessageBuffer class that differs from GreedyMessageBuff…

…er only

in that it delays serialization until the message is requested.  This should
fix the issue where the initial server messages would sometimes fail to
deserialize because the serialization registration message hadn't been processed
before the other messages in the block were deserialized.  Now each message will
be deserialized as it is encountered.
In the end the fix was simple enough that it's probably only a 2-3 line change to
MessageProtocol in JME 3.2 if someone wants to back port the fix.  (Just queue
up ByteBuffer instead of Message.)

jme3-networking/src/main/java/com/jme3/network/base/protocol/LazyMessageBuffer.java

@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2009-2019 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.network.base.protocol;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.util.LinkedList;
+
+import com.jme3.network.Message;
+import com.jme3.network.base.MessageBuffer;
+import com.jme3.network.base.MessageProtocol;
+
+
+/**
+ *  A MessageBuffer implementation that will deserialize messages as they
+ *  are returned instead of deserializing them as the data comes in.  This
+ *  allows the individual messages to be processed before later messages
+ *  are deserialized, thus allowing the serialization process itself to be
+ *  altered mid-stream.
+ *
+ *  @author    Paul Speed
+ */
+public class LazyMessageBuffer implements MessageBuffer {
+
+    private MessageProtocol protocol;
+    private final LinkedList<ByteBuffer> messages = new LinkedList<ByteBuffer>();
+    private ByteBuffer current;
+    private int size;
+    private Byte carry;
+
+    public LazyMessageBuffer( MessageProtocol protocol ) {
+        this.protocol = protocol;
+    }
+
+    /**
+     *  Returns the next message in the buffer or null if there are no more
+     *  messages in the buffer.  
+     */
+    public Message pollMessage() {
+        if( messages.isEmpty() ) {
+            return null;
+        }
+        ByteBuffer bytes = messages.removeFirst();
+        return protocol.toMessage(bytes);                
+    }
+
+    /**
+     *  Returns true if there is a message waiting in the buffer.
+     */
+    public boolean hasMessages() {
+        return !messages.isEmpty();
+    }
+
+    /**
+     *  Adds byte data to the message buffer.  Returns true if there is
+     *  a message waiting after this call.
+     */   
+    public boolean addBytes( ByteBuffer buffer ) {
+        // push the data from the buffer into as
+        // many messages as we can
+        while( buffer.remaining() > 0 ) {
+
+            if( current == null ) {
+
+                // If we have a left over carry then we need to
+                // do manual processing to get the short value
+                if( carry != null ) {
+                    byte high = carry;
+                    byte low = buffer.get();
+
+                    size = (high & 0xff) << 8 | (low & 0xff);
+                    carry = null;
+                }
+                else if( buffer.remaining() < 2 ) {
+                    // It's possible that the supplied buffer only has one
+                    // byte in it... and in that case we will get an underflow
+                    // when attempting to read the short below.
+
+                    // It has to be 1 or we'd never get here... but one
+                    // isn't enough so we stash it away.
+                    carry = buffer.get();
+                    break;
+                } else {
+                    // We are not currently reading an object so
+                    // grab the size.
+                    // Note: this is somewhat limiting... int would
+                    // be better.
+                    size = buffer.getShort();
+                }               
+
+                // Allocate the buffer into which we'll feed the
+                // data as we get it               
+                current = ByteBuffer.allocate(size);
+            } 
+
+            if( current.remaining() <= buffer.remaining() ) {
+                // We have at least one complete object so
+                // copy what we can into current, create a message,
+                // and then continue pulling from buffer.
+
+                // Artificially set the limit so we don't overflow
+                int extra = buffer.remaining() - current.remaining();
+                buffer.limit(buffer.position() + current.remaining());
+
+                // Now copy the data                   
+                current.put(buffer);
+                current.flip();
+
+                // Now set the limit back to a good value
+                buffer.limit(buffer.position() + extra);
+
+                // Just push the bytes and let the serialization happen later.
+                messages.add(current);
+
+                current = null;
+
+                // Note: I originally thought that lazy deserialization was
+                // going to be tricky/fancy because I'd imagined having to
+                // collect partial buffers, leave data in working buffers, etc..
+                // However, the buffer we are passed is reused by the caller
+                // (it's part of the API contract) and so we MUST copy the
+                // data into "something" before returning.  We already know
+                // what size buffer the message is going to need.  That can't
+                // change.  We are already creating per-message byte buffers.
+                // ...so we might as well just buffer this in our queue instead.
+                // The alternative is to somehow have an open-ended working buffer
+                // that expands/shrinks as needed to accomodate the 'unknown' number
+                // of messages that must be buffered before the caller asks for
+                // one.  Obviously, that's way more wasteful than just keeping
+                // per-message byte buffers around.  We already had them anyway.
+                // So in the end, I probably could have just altered the original 
+                // buffering code and called it a day... but I had to do the refactoring
+                // before I figured that out and now we have the ability to more easily
+                // swap out protocol implementations.  -pspeed:2019-09-08                                    
+            } else {                
+                // Not yet a complete object so just copy what we have
+                current.put(buffer); 
+            }            
+        }            
+
+        return hasMessages();        
+    }
+}
+
+

jme3-networking/src/main/java/com/jme3/network/base/protocol/SerializerMessageProtocol.java

@@ -93,7 +93,8 @@ public Message toMessage( ByteBuffer bytes ) {
     }
 
     public MessageBuffer createBuffer() {
-        return new GreedyMessageBuffer(this);
+        // Defaulting to LazyMessageBuffer
+        return new LazyMessageBuffer(this);
     }
 
 }