com.simsilica.es.server

Class EntityDataHostedService

java.lang.Object

com.jme3.network.service.AbstractService<com.jme3.network.service.HostedServiceManager>

com.jme3.network.service.AbstractHostedService

com.simsilica.es.server.EntityDataHostedService

All Implemented Interfaces:

com.jme3.network.ConnectionListener, com.jme3.network.service.HostedService, com.jme3.network.service.Service<com.jme3.network.service.HostedServiceManager>, EntityHostSettings

public class EntityDataHostedService
extends com.jme3.network.service.AbstractHostedService
implements EntityHostSettings

A HostedService that manages access to an EntityData instance for client connections. When added to the service manager, this will handle the networking necessary to facilitate client-server EntityData access. A reciprocal EntityDataClientService should be added to the Client's ClientServiceManager to complete the setup.

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

Constructor Summary

Constructors

Constructor and Description
EntityDataHostedService(int channel, com.simsilica.es.ObservableEntityData ed) Creates a new EntityDataHostedService for the specified EntityData that will communicate over the specified channel.
EntityDataHostedService(int channel, com.simsilica.es.ObservableEntityData ed, boolean autoHost) Creates a new EntityDataHostedService for the specified EntityData that will communicate over the specified channel and will automatically host for new connections depending on the specified autoHost value.

Method Summary

Modifier and Type	Method and Description
void	connectionAdded(com.jme3.network.Server server, com.jme3.network.HostedConnection hc)
void	connectionRemoved(com.jme3.network.Server server, com.jme3.network.HostedConnection hc)
boolean	getAutoHost()
int	getChannel()
com.simsilica.es.EntityData	getEntityData()
HostedEntityData	getHostedEntityData(com.jme3.network.HostedConnection hc) Returns the HostedEntityData for the specified connection.
int	getMaxChangeBatchSize()
int	getMaxEntityBatchSize()
protected void	onInitialize(com.jme3.network.service.HostedServiceManager services)
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	start()
void	startHostingOnConnection(com.jme3.network.HostedConnection hc) Sets up the specified connection for hosting remote entity data commands.
void	stop()
void	stopHostingOnConnection(com.jme3.network.HostedConnection hc) Terminates the specified connection for hosting remote entity data commands.
void	terminate(com.jme3.network.service.HostedServiceManager hsm)

Methods inherited from class com.jme3.network.service.AbstractHostedService

getServer

Methods inherited from class com.jme3.network.service.AbstractService

getService, getServiceManager, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDataHostedService

public EntityDataHostedService(int channel,
                               com.simsilica.es.ObservableEntityData ed)

Creates a new EntityDataHostedService for the specified EntityData that will communicate over the specified channel. Autohosting is set to true by default.

EntityDataHostedService

public EntityDataHostedService(int channel,
                               com.simsilica.es.ObservableEntityData ed,
                               boolean autoHost)

Creates a new EntityDataHostedService for the specified EntityData that will communicate over the specified channel and will automatically host for new connections depending on the specified autoHost value.

Method Detail

getEntityData

public com.simsilica.es.EntityData getEntityData()

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.

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().

getHostedEntityData

public HostedEntityData getHostedEntityData(com.jme3.network.HostedConnection hc)

Returns the HostedEntityData for the specified connection. This can be used to setup connection-specific entity data setup.

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()

onInitialize

protected void onInitialize(com.jme3.network.service.HostedServiceManager services)

Specified by:

onInitialize in class com.jme3.network.service.AbstractService<com.jme3.network.service.HostedServiceManager>

start

public void start()

Specified by:

start in interface com.jme3.network.service.HostedService

Specified by:

start in interface com.jme3.network.service.Service<com.jme3.network.service.HostedServiceManager>

Overrides:

start in class com.jme3.network.service.AbstractService<com.jme3.network.service.HostedServiceManager>

stop

public void stop()

Specified by:

stop in interface com.jme3.network.service.HostedService

Specified by:

stop in interface com.jme3.network.service.Service<com.jme3.network.service.HostedServiceManager>

Overrides:

stop in class com.jme3.network.service.AbstractService<com.jme3.network.service.HostedServiceManager>

terminate

public void terminate(com.jme3.network.service.HostedServiceManager hsm)

Specified by:

terminate in interface com.jme3.network.service.HostedService

Specified by:

terminate in interface com.jme3.network.service.Service<com.jme3.network.service.HostedServiceManager>

Overrides:

terminate in class com.jme3.network.service.AbstractHostedService

connectionAdded

public void connectionAdded(com.jme3.network.Server server,
                            com.jme3.network.HostedConnection hc)

Specified by:

connectionAdded in interface com.jme3.network.ConnectionListener

Overrides:

connectionAdded in class com.jme3.network.service.AbstractHostedService

connectionRemoved

public void connectionRemoved(com.jme3.network.Server server,
                              com.jme3.network.HostedConnection hc)

Specified by:

connectionRemoved in interface com.jme3.network.ConnectionListener

Overrides:

connectionRemoved in class com.jme3.network.service.AbstractHostedService