com.simsilica.es.server

Class EntityDataHostService

java.lang.Object

com.simsilica.es.server.EntityDataHostService

All Implemented Interfaces:

EntityHostSettings

public class EntityDataHostService
extends java.lang.Object
implements EntityHostSettings

Provides server-side hosting capability for an EntityData instance. Once attached to a server, this will process messages and make sure client requests are granted and client updates are sent.

It is up to the game server to periodically call sendUpdates() to flush any pending EntitySet changes to clients.

For JME 3.1 and above, use EntityDataHostedService and EntityDataClientService instead of these more crude classes. They will be deprecated when JME 3.1 is full released.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EntityDataHostService.ConnectionObserver

Constructor Summary

Constructors

Constructor and Description
EntityDataHostService(com.jme3.network.Server server, int channel, com.simsilica.es.ObservableEntityData ed) Creates a new EntityDataHostService that will watch for new connections on the specified Server and provide access to the specified EntityData.

Method Summary

Modifier and Type	Method and Description
protected void	addConnection(com.jme3.network.HostedConnection hc)
boolean	getAutoHost()
int	getChannel()
int	getMaxChangeBatchSize()
int	getMaxEntityBatchSize()
protected void	removeConnection(com.jme3.network.HostedConnection hc)
void	sendUpdates() Must be called by the game server to send pending updates to the relevant clients.
void	setAutoHost(boolean b) Set to true to have new connections automatically 'hosted' by this entity service.
void	setMaxChangeBatchSize(int i) Sets the maximum number of EntityChanges that will be sent back in a single batched results message.
void	setMaxEntityBatchSize(int i) Sets the maximum number of entities that will be sent back in a single batched results message.
void	startHostingOnConnection(com.jme3.network.HostedConnection hc) Sets up the specified connection for hosting remote entity data commands.
void	stop() Causes this service to stop listening for new connections and all existing connections will have stopHostingOnConnection() called for them.
void	stopHostingOnConnection(com.jme3.network.HostedConnection hc) Terminates the specified connection for hosting remote entity data commands.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDataHostService

public EntityDataHostService(com.jme3.network.Server server,
                             int channel,
                             com.simsilica.es.ObservableEntityData ed)

Creates a new EntityDataHostService that will watch for new connections on the specified Server and provide access to the specified EntityData. Entity request and response messages will be sent on the specified channel.

Method Detail

getChannel

public int getChannel()

Specified by:

getChannel in interface EntityHostSettings

sendUpdates

public void sendUpdates()

Must be called by the game server to send pending updates to the relevant clients.

stop

public void stop()

Causes this service to stop listening for new connections and all existing connections will have stopHostingOnConnection() called for them.

startHostingOnConnection

public void startHostingOnConnection(com.jme3.network.HostedConnection hc)

Sets up the specified connection for hosting remote entity data commands. By default this is performed automatically in addConnection() and is controlled by the setAutoHost() property.

stopHostingOnConnection

public void stopHostingOnConnection(com.jme3.network.HostedConnection hc)

Terminates the specified connection for hosting remote entity data commands. By default this is performed automatically in removeConnection().

setMaxEntityBatchSize

public void setMaxEntityBatchSize(int i)

Sets the maximum number of entities that will be sent back in a single batched results message. The optimal number largely depends on the relative size of an average entity as the app retrieves it. Small components and small numbers of components per entity means larger batches are optimal. Defaults to 20.

getMaxEntityBatchSize

public int getMaxEntityBatchSize()

Specified by:

getMaxEntityBatchSize in interface EntityHostSettings

setMaxChangeBatchSize

public void setMaxChangeBatchSize(int i)

Sets the maximum number of EntityChanges that will be sent back in a single batched results message. The optimal number largely depends on the average size of components. Defaults to 20.

getMaxChangeBatchSize

public int getMaxChangeBatchSize()

Specified by:

getMaxChangeBatchSize in interface EntityHostSettings

setAutoHost

public void setAutoHost(boolean b)

Set to true to have new connections automatically 'hosted' by this entity service. In other words, any newly added connections will automatically have startHostingOnConnection() called. Set this to false if the application requires further client setup before letting them access entities. In that case, the game server will have to call startHostingOnConnection() manually. Defaults to true.

getAutoHost

public boolean getAutoHost()

addConnection

protected void addConnection(com.jme3.network.HostedConnection hc)

removeConnection

protected void removeConnection(com.jme3.network.HostedConnection hc)