com.simsilica.ethereal.net

Class StateWriter

java.lang.Object

com.simsilica.ethereal.net.StateWriter

public class StateWriter
extends java.lang.Object

Buffers the state information, flushing it to real messages when it exceeds a certain message threshold.

Constructor Summary

Constructors

Constructor and Description
StateWriter(com.jme3.network.HostedConnection conn, ObjectStateProtocol objectProtocol, TimeSource timeSource, ConnectionStats stats)

Method Summary

Modifier and Type	Method and Description
SentState	ackSentState(int messageId)
void	addState(ObjectState state)
protected void	endFrame() Adds the frame to an existing outbound message or closes/sends the previous outbound message and starts a new one.
protected void	endMessage()
void	flush()
int	getMaxMessageSize()
void	setMaxMessageSize(int max) Sets the desired maximum message size.
void	startFrame(long time, ZoneKey centerZone)
protected void	startMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateWriter

public StateWriter(com.jme3.network.HostedConnection conn,
                   ObjectStateProtocol objectProtocol,
                   TimeSource timeSource,
                   ConnectionStats stats)

Method Detail

setMaxMessageSize

public void setMaxMessageSize(int max)

Sets the desired maximum message size. Typically the ideal situation would be to keep this under the MTU of the connection. By default, StateWriter estimates this as 1500 bytes. It can vary and there is no direct way to know. Set this to a really large value to avoid ever splitting messages.

getMaxMessageSize

public int getMaxMessageSize()

ackSentState

public SentState ackSentState(int messageId)

startFrame

public void startFrame(long time,
                       ZoneKey centerZone)
                throws java.io.IOException

Throws:

java.io.IOException

addState

public void addState(ObjectState state)
              throws java.io.IOException

Throws:

java.io.IOException

startMessage

protected void startMessage()

endFrame

protected void endFrame()
                 throws java.io.IOException

Adds the frame to an existing outbound message or closes/sends the previous outbound message and starts a new one.

Throws:

java.io.IOException

endMessage

protected void endMessage()
                   throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException