com.simsilica.ethereal

Class NetworkStateListener

java.lang.Object

com.simsilica.ethereal.NetworkStateListener

All Implemented Interfaces:

StateListener

public class NetworkStateListener
extends java.lang.Object
implements StateListener

A server-side per-player state listener that streams shared space changes to the client based on the current local zones.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor and Description
NetworkStateListener(EtherealHost host, com.jme3.network.HostedConnection conn, LocalZoneIndex zoneIndex, IdIndex idIndex)
NetworkStateListener(EtherealHost host, com.jme3.network.HostedConnection conn, ZoneGrid grid, int zoneRadius)
NetworkStateListener(EtherealHost host, com.jme3.network.HostedConnection conn, ZoneGrid grid, com.simsilica.mathd.Vec3i zoneExtents)

Method Summary

Modifier and Type	Method and Description
void	beginFrame(long time)
void	beginFrameBlock()
void	endFrame(long time)
void	endFrameBlock()
java.util.Set<java.lang.Long>	getActiveIds() Returns the set of all active IDs at this point in time.
ConnectionStats	getConnectionStats()
java.util.List<ZoneKey>	getEnteredZones()
java.util.List<ZoneKey>	getExitedZones()
int	getMaxMessageSize()
java.lang.Long	getSelf()
boolean	hasChangedZones()
void	objectWarped(StateBlock.StateEntry entry) Called after beginFrameBlock() but before beginFrame(), this lets the listener know that an object had warped beyond any previous zone ranges.
protected void	postResponse(ClientStateMessage m) Called when client state is received.
void	setMaxMessageSize(int max) Sets the desired maximum message size.
void	setSelf(java.lang.Long self, com.simsilica.mathd.Vec3d startingPosition)
void	stateChanged(StateBlock b)

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_KEY

public static final java.lang.String ATTRIBUTE_KEY

See Also:

Constant Field Values

Constructor Detail

NetworkStateListener

public NetworkStateListener(EtherealHost host,
                            com.jme3.network.HostedConnection conn,
                            ZoneGrid grid,
                            int zoneRadius)

NetworkStateListener

public NetworkStateListener(EtherealHost host,
                            com.jme3.network.HostedConnection conn,
                            ZoneGrid grid,
                            com.simsilica.mathd.Vec3i zoneExtents)

NetworkStateListener

public NetworkStateListener(EtherealHost host,
                            com.jme3.network.HostedConnection conn,
                            LocalZoneIndex zoneIndex,
                            IdIndex idIndex)

Method Detail

setSelf

public void setSelf(java.lang.Long self,
                    com.simsilica.mathd.Vec3d startingPosition)

getSelf

public java.lang.Long getSelf()

getActiveIds

public java.util.Set<java.lang.Long> getActiveIds()

Returns the set of all active IDs at this point in time.

getConnectionStats

public ConnectionStats getConnectionStats()

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. This setting is provided for applications that want to try changing the max message size for connections that seem to be dropping a lot of packets. Making this size smaller may help fall under that particular connections MTU and thus make it more likely that a single message makes it through since it won't need to be split by the network connection.

Set this to a really large value to avoid ever splitting a frame into multiple messages. This may make the actual transport of the message more likely to fail over disadvantaged comms and it may make the message take a little longer to reach the endpoint.

Notes on MTU and why this setting exists: for a particular connection there is a maximum message transmit unit size over which a UDP message will be split and reassembled. If any of the parts of that UDP message fail to arrive then the message is discarded completely. SimEthereal attempts to keep its own messages under a theoretical MTU size (by default 1500) in order to avoid this splitting. We trade calculation time and complexity for (hopefully) a higher likelihood that our messages make it there and in a timely manner (split UDP packets are only as fast as their slowest part, after all). Even if one of our self-split messages makes it then at least you get a partial frame update. If part of the UDP fails to make it then you get nothing.

getMaxMessageSize

public int getMaxMessageSize()

hasChangedZones

public boolean hasChangedZones()

Specified by:

hasChangedZones in interface StateListener

getEnteredZones

public java.util.List<ZoneKey> getEnteredZones()

Specified by:

getEnteredZones in interface StateListener

getExitedZones

public java.util.List<ZoneKey> getExitedZones()

Specified by:

getExitedZones in interface StateListener

postResponse

protected void postResponse(ClientStateMessage m)

Called when client state is received. Autowired through the SessionDataDelegator setup in EtherealHost.

beginFrameBlock

public void beginFrameBlock()

Specified by:

beginFrameBlock in interface StateListener

endFrameBlock

public void endFrameBlock()

Specified by:

endFrameBlock in interface StateListener

objectWarped

public void objectWarped(StateBlock.StateEntry entry)

Description copied from interface: StateListener

Called after beginFrameBlock() but before beginFrame(), this lets the listener know that an object had warped beyond any previous zone ranges. The listener can then determine if this would update its own active zones and adjust accordingly.

Specified by:

objectWarped in interface StateListener

beginFrame

public void beginFrame(long time)

Specified by:

beginFrame in interface StateListener

endFrame

public void endFrame(long time)

Specified by:

endFrame in interface StateListener

stateChanged

public void stateChanged(StateBlock b)

Specified by:

stateChanged in interface StateListener