interface and strictly implement the to/from ByteBuffer protocol. In the future this will allow the message protocol to be swappable. Also moved out the buffering aspect since often buffers need to be created 'on the fly' and are separate from the protocol. This will allow me to play with fixing the issue related to messages being deserialized before the serialization registry message has been processed by swapping out the GreedyMessageBuffer implementation for a LazyMessageBuffer implementation.fix-openal-soft-deadlink
Paul Speed
5 years ago
parent
a9afcecc41
commit
1c37d5a92d
@ -0,0 +1,65 @@ |
||||
/* |
||||
* 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; |
||||
|
||||
import java.nio.ByteBuffer; |
||||
|
||||
import com.jme3.network.Message; |
||||
|
||||
/** |
||||
* Accumulates network data into Message objects. This allows |
||||
* random chunks of bytes to be assembled into messages even if |
||||
* the buffer boundaries don't line up. |
||||
* |
||||
* @author Paul Speed |
||||
*/ |
||||
public interface MessageBuffer { |
||||
|
||||
/** |
||||
* Returns the next message in the buffer or null if there are no more |
||||
* messages in the buffer. |
||||
*/ |
||||
public Message pollMessage(); |
||||
|
||||
/** |
||||
* Returns true if there is a message waiting in the buffer. |
||||
*/ |
||||
public boolean hasMessages(); |
||||
|
||||
/** |
||||
* Adds byte data to the message buffer. Returns true if there is |
||||
* a message waiting after this call. |
||||
*/ |
||||
public boolean addBytes( ByteBuffer buffer ); |
||||
} |
||||
|
||||
@ -0,0 +1,157 @@ |
||||
/* |
||||
* 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 aggressively create |
||||
* all messages as byte data comes in. In other words, if there |
||||
* are four messages in the ByteBuffer passed to addBuffer() then |
||||
* all of the messages will be deserialized during that call and |
||||
* queued up for later return. The down side is that if any of |
||||
* those messages was going to alter the MessageProtocol serialization |
||||
* behavior in a way that affects later messages then problems occur |
||||
* when those messages are all in one block. |
||||
* |
||||
* @author Paul Speed |
||||
*/ |
||||
public class GreedyMessageBuffer implements MessageBuffer { |
||||
|
||||
private MessageProtocol protocol; |
||||
private final LinkedList<Message> messages = new LinkedList<Message>(); |
||||
private ByteBuffer current; |
||||
private int size; |
||||
private Byte carry; |
||||
|
||||
public GreedyMessageBuffer( 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; |
||||
} |
||||
return messages.removeFirst(); |
||||
} |
||||
|
||||
/** |
||||
* 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); |
||||
|
||||
messages.add(protocol.toMessage(current)); |
||||
|
||||
current = null; |
||||
} else { |
||||
// Not yet a complete object so just copy what we have
|
||||
current.put(buffer); |
||||
} |
||||
} |
||||
|
||||
return hasMessages(); |
||||
} |
||||
} |
||||
|
||||
|
||||
@ -0,0 +1,102 @@ |
||||
/* |
||||
* 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; |
||||
import com.jme3.network.serializing.Serializer; |
||||
|
||||
/** |
||||
* Implements a MessageProtocol providing message serializer/deserialization |
||||
* based on the built-in Serializer code. |
||||
* |
||||
* <p>The protocol is based on a simple length + data format |
||||
* where two bytes represent the (short) length of the data |
||||
* and the rest is the raw data for the Serializers class.</p> |
||||
* |
||||
* @version $Revision$ |
||||
* @author Paul Speed |
||||
*/ |
||||
public class SerializerMessageProtocol implements MessageProtocol { |
||||
|
||||
public SerializerMessageProtocol() { |
||||
} |
||||
|
||||
/** |
||||
* Converts a message to a ByteBuffer using the com.jme3.network.serializing.Serializer |
||||
* and the (short length) + data protocol. If target is null |
||||
* then a 32k byte buffer will be created and filled. |
||||
*/ |
||||
public ByteBuffer toByteBuffer( Message message, ByteBuffer target ) { |
||||
|
||||
// Could let the caller pass their own in
|
||||
ByteBuffer buffer = target == null ? ByteBuffer.allocate(32767 + 2) : target; |
||||
|
||||
try { |
||||
buffer.position(2); |
||||
Serializer.writeClassAndObject(buffer, message); |
||||
buffer.flip(); |
||||
short dataLength = (short)(buffer.remaining() - 2); |
||||
buffer.putShort(dataLength); |
||||
buffer.position(0); |
||||
|
||||
return buffer; |
||||
} catch( IOException e ) { |
||||
throw new RuntimeException("Error serializing message", e); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Creates and returns a message from the properly sized byte buffer |
||||
* using com.jme3.network.serializing.Serializer. |
||||
*/ |
||||
public Message toMessage( ByteBuffer bytes ) { |
||||
try { |
||||
return (Message)Serializer.readClassAndObject(bytes); |
||||
} catch( IOException e ) { |
||||
throw new RuntimeException("Error deserializing object, class ID:" + bytes.getShort(0), e); |
||||
} |
||||
} |
||||
|
||||
public MessageBuffer createBuffer() { |
||||
return new GreedyMessageBuffer(this); |
||||
} |
||||
|
||||
} |
||||
|
||||
|
||||
|
||||
Loading…
Reference in new issue