AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move SceneProvider stuff into the SceneRegistry as all the cool kids use the

Browse Source 
new pattern of having a Provider interface which is implemented by a Manager or
other server-side entity.


git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@358 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
Michael Bayne
2007-07-13 23:48:42 +00:00
parent 5fbf4e17da
commit 5015ec26c2
5 changed files with 157 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/java/com/threerings/whirled/server/SceneProvider.java
+8 -152
View File
@@ -21,167 +21,23 @@
package com.threerings.whirled.server;
import com.threerings.crowd.data.PlaceConfig;
import com.threerings.presents.client.Client;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.data.InvocationMarshaller;
import com.threerings.presents.server.InvocationException;
import com.threerings.presents.server.InvocationProvider;
import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.data.PlaceConfig;
import com.threerings.crowd.server.LocationProvider;
import com.threerings.whirled.Log;
import com.threerings.whirled.client.SceneService.SceneMoveListener;
import com.threerings.whirled.data.SceneCodes;
import com.threerings.whirled.client.SceneService;
import com.threerings.whirled.data.SceneModel;
import com.threerings.whirled.data.SceneUpdate;
import com.threerings.whirled.data.ScenedBodyObject;
/**
* The scene provider handles the server side of the scene related
* invocation services (e.g. moving from scene to scene).
* Defines the server-side of the {@link SceneService}.
*/
public class SceneProvider
implements InvocationProvider, SceneCodes
public interface SceneProvider extends InvocationProvider
{
/**
* Constructs a scene provider that will interact with the supplied
* scene registry.
* Handles a {@link SceneService#moveTo} request.
*/
public SceneProvider (LocationProvider locprov, SceneRegistry screg)
{
_locprov = locprov;
_screg = screg;
}
/**
* Processes a request from a client to move to a new scene.
*/
public void moveTo (ClientObject caller, int sceneId,
final int sceneVer, final SceneMoveListener listener)
{
final BodyObject source = (BodyObject)caller;
// create a callback object that will handle the resolution or
// failed resolution of the scene
SceneRegistry.ResolutionListener rl = null;
rl = new SceneRegistry.ResolutionListener() {
public void sceneWasResolved (SceneManager scmgr) {
// make sure our caller is still around; under heavy load,
// clients might end their session while the scene is
// resolving
if (!source.isActive()) {
Log.info("Abandoning scene move, client gone " +
"[who=" + source.who() +
", dest=" + scmgr.where() + "].");
InvocationMarshaller.setNoResponse(listener);
return;
}
finishMoveToRequest(source, scmgr, sceneVer, listener);
}
public void sceneFailedToResolve (int rsceneId, Exception reason) {
Log.warning("Unable to resolve scene [sceneid=" + rsceneId +
", reason=" + reason + "].");
// pretend like the scene doesn't exist to the client
listener.requestFailed(NO_SUCH_PLACE);
}
};
// make sure the scene they are headed to is actually loaded into
// the server
_screg.resolveScene(sceneId, rl);
}
/**
* This is called after the scene to which we are moving is guaranteed
* to have been loaded into the server.
*/
protected void finishMoveToRequest (
BodyObject source, SceneManager scmgr, int sceneVersion,
SceneMoveListener listener)
{
try {
effectSceneMove(source, scmgr, sceneVersion, listener);
} catch (InvocationException sfe) {
listener.requestFailed(sfe.getMessage());
} catch (RuntimeException re) {
Log.logStackTrace(re);
listener.requestFailed(INTERNAL_ERROR);
}
}
/**
* Moves the supplied body into the supplied (already resolved) scene
* and informs the supplied listener if the move is successful.
*
* @exception InvocationException thrown if a failure occurs
* attempting to move the user into the place associated with the
* scene.
*/
public void effectSceneMove (BodyObject source, SceneManager scmgr,
int sceneVersion, SceneMoveListener listener)
throws InvocationException
{
// move to the place object associated with this scene
int ploid = scmgr.getPlaceObject().getOid();
PlaceConfig config = _locprov.moveTo(source, ploid);
// now that we've finally moved, we can update the user object
// with the new scene id
((ScenedBodyObject)source).setSceneId(scmgr.getScene().getId());
// check to see if they need a newer version of the scene data
SceneModel model = scmgr.getScene().getSceneModel();
if (sceneVersion != model.version) {
SceneUpdate[] updates = null;
if (sceneVersion < model.version) {
// try getting updates to bring the client to the right version
updates = scmgr.getUpdates(sceneVersion);
}
if (updates != null) {
listener.moveSucceededWithUpdates(ploid, config, updates);
} else {
listener.moveSucceededWithScene(ploid, config, model);
}
} else {
listener.moveSucceeded(ploid, config);
}
}
/**
* Ejects the specified body from their current scene and sends them a
* request to move to the specified new scene. This is the
* scene-equivalent to {@link LocationProvider#moveBody}.
*/
public void moveBody (BodyObject source, int sceneId)
{
// first remove them from their old place
_locprov.leaveOccupiedPlace(source);
// then send a forced move notification
SceneSender.forcedMove(source, sceneId);
}
/**
* Ejects the specified body from their current scene and zone. This
* is the zone equivalent to {@link
* LocationProvider#leaveOccupiedPlace}.
*/
public void leaveOccupiedScene (ScenedBodyObject source)
{
// remove them from their occupied place
_locprov.leaveOccupiedPlace((BodyObject)source);
// and clear out their scene information
source.setSceneId(0);
}
/** The location provider we use to handle low-level location stuff. */
protected LocationProvider _locprov;
/** The scene registry with which we interact. */
protected SceneRegistry _screg;
public void moveTo (ClientObject caller, int arg1, int arg2, SceneService.SceneMoveListener arg3)
throws InvocationException;
}
src/java/com/threerings/whirled/server/SceneRegistry.java
+145 -28
View File
@@ -26,17 +26,24 @@ import java.util.ArrayList;
import com.samskivert.util.HashIntMap;
import com.samskivert.util.Invoker;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.data.InvocationMarshaller;
import com.threerings.presents.server.InvocationException;
import com.threerings.presents.server.InvocationManager;
import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.data.PlaceConfig;
import com.threerings.crowd.server.CrowdServer;
import com.threerings.crowd.server.PlaceManager;
import com.threerings.crowd.server.PlaceRegistry;
import com.threerings.whirled.Log;
import com.threerings.whirled.client.SceneService;
import com.threerings.whirled.data.Scene;
import com.threerings.whirled.data.SceneCodes;
import com.threerings.whirled.data.SceneModel;
import com.threerings.whirled.data.SceneUpdate;
import com.threerings.whirled.data.ScenedBodyObject;
import com.threerings.whirled.server.persist.SceneRepository;
import com.threerings.whirled.util.SceneFactory;
import com.threerings.whirled.util.UpdateList;
@@ -54,6 +61,7 @@ import com.threerings.whirled.util.UpdateList;
* <p><em>Note:</em> All access to the scene registry should take place from the dobjmgr thread.
*/
public class SceneRegistry
implements SceneCodes, SceneProvider
{
/**
* Used to create {@link PlaceConfig} instances for scenes.
@@ -66,8 +74,26 @@ public class SceneRegistry
PlaceConfig createPlaceConfig (SceneModel model);
}
/** Used to provide scene-related server-side services. */
public SceneProvider sceneprov;
/**
* Because scenes must be loaded from the scene repository and this must not be done on the
* dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for
* a scene to be resolved implement this callback interface so that it can be notified when a
* scene has been loaded and initialized.
*/
public static interface ResolutionListener
{
/**
* Called when the scene has been successfully resolved. The scene manager instance
* provided can be used to obtain a reference to the scene, or the scene distributed
* object.
*/
public void sceneWasResolved (SceneManager scmgr);
/**
* Called if some failure occurred in the scene resolution process.
*/
public void sceneFailedToResolve (int sceneId, Exception reason);
}
/**
* Constructs a scene registry, instructing it to load and store scenes using the supplied
@@ -80,9 +106,8 @@ public class SceneRegistry
_scfact = scfact;
_confact = confact;
// create/register a scene provider with the invocation services
sceneprov = new SceneProvider(CrowdServer.plreg.locprov, this);
invmgr.registerDispatcher(new SceneDispatcher(sceneprov), SceneCodes.WHIRLED_GROUP);
// register our scene service
invmgr.registerDispatcher(new SceneDispatcher(this), SceneCodes.WHIRLED_GROUP);
}
/**
@@ -114,27 +139,6 @@ public class SceneRegistry
return (scmgr == null) ? ("null:" + sceneId) : scmgr.where();
}
/**
* Because scenes must be loaded from the scene repository and this must not be done on the
* dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for
* a scene to be resolved implement this callback interface so that it can be notified when a
* scene has been loaded and initialized.
*/
public static interface ResolutionListener
{
/**
* Called when the scene has been successfully resolved. The scene manager instance
* provided can be used to obtain a reference to the scene, or the scene distributed
* object.
*/
public void sceneWasResolved (SceneManager scmgr);
/**
* Called if some failure occurred in the scene resolution process.
*/
public void sceneFailedToResolve (int sceneId, Exception reason);
}
/**
* Requests that the specified scene be resolved, which means loaded into the server and
* initialized if the scene is not currently active. The supplied callback instance will be
@@ -216,11 +220,124 @@ public class SceneRegistry
}
}
// from interface SceneService
public void moveTo (ClientObject caller, int sceneId, final int sceneVer,
final SceneService.SceneMoveListener listener)
{
final BodyObject source = (BodyObject)caller;
// create a callback object to handle the resolution or failed resolution of the scene
SceneRegistry.ResolutionListener rl = null;
rl = new SceneRegistry.ResolutionListener() {
public void sceneWasResolved (SceneManager scmgr) {
// make sure our caller is still around; under heavy load, clients might end their
// session while the scene is resolving
if (!source.isActive()) {
Log.info("Abandoning scene move, client gone [who=" + source.who() +
", dest=" + scmgr.where() + "].");
InvocationMarshaller.setNoResponse(listener);
return;
}
finishMoveToRequest(source, scmgr, sceneVer, listener);
}
public void sceneFailedToResolve (int rsceneId, Exception reason) {
Log.warning("Unable to resolve scene [sceneid=" + rsceneId +
", reason=" + reason + "].");
// pretend like the scene doesn't exist to the client
listener.requestFailed(NO_SUCH_PLACE);
}
};
// make sure the scene they are headed to is actually loaded into the server
resolveScene(sceneId, rl);
}
/**
* Moves the supplied body into the supplied (already resolved) scene and informs the supplied
* listener if the move is successful.
*
* @exception InvocationException thrown if a failure occurs attempting to move the user into
* the place associated with the scene.
*/
public void effectSceneMove (BodyObject source, SceneManager scmgr,
int sceneVersion, SceneService.SceneMoveListener listener)
throws InvocationException
{
// move to the place object associated with this scene
int ploid = scmgr.getPlaceObject().getOid();
PlaceConfig config = CrowdServer.plreg.locprov.moveTo(source, ploid);
// now that we've finally moved, we can update the user object with the new scene id
((ScenedBodyObject)source).setSceneId(scmgr.getScene().getId());
// check to see if they need a newer version of the scene data
SceneModel model = scmgr.getScene().getSceneModel();
if (sceneVersion != model.version) {
SceneUpdate[] updates = null;
if (sceneVersion < model.version) {
// try getting updates to bring the client to the right version
updates = scmgr.getUpdates(sceneVersion);
}
if (updates != null) {
listener.moveSucceededWithUpdates(ploid, config, updates);
} else {
listener.moveSucceededWithScene(ploid, config, model);
}
} else {
listener.moveSucceeded(ploid, config);
}
}
/**
* Ejects the specified body from their current scene and sends them a request to move to the
* specified new scene. This is the scene-equivalent to {@link LocationProvider#moveBody}.
*/
public void moveBody (BodyObject source, int sceneId)
{
// first remove them from their old place
CrowdServer.plreg.locprov.leaveOccupiedPlace(source);
// then send a forced move notification
SceneSender.forcedMove(source, sceneId);
}
/**
* Ejects the specified body from their current scene and zone. This is the zone equivalent to
* {@link LocationProvider#leaveOccupiedPlace}.
*/
public void leaveOccupiedScene (ScenedBodyObject source)
{
// remove them from their occupied place
CrowdServer.plreg.locprov.leaveOccupiedPlace((BodyObject)source);
// and clear out their scene information
source.setSceneId(0);
}
/**
* This is called after the scene to which we are moving is guaranteed to have been loaded into
* the server.
*/
protected void finishMoveToRequest (BodyObject source, SceneManager scmgr, int sceneVersion,
SceneService.SceneMoveListener listener)
{
try {
effectSceneMove(source, scmgr, sceneVersion, listener);
} catch (InvocationException sfe) {
listener.requestFailed(sfe.getMessage());
} catch (RuntimeException re) {
Log.logStackTrace(re);
listener.requestFailed(INTERNAL_ERROR);
}
}
/**
* Called when the scene resolution has completed successfully.
*/
protected void processSuccessfulResolution (
SceneModel model, final UpdateList updates)
protected void processSuccessfulResolution (SceneModel model, final UpdateList updates)
{
// now that the scene is loaded, we can create a scene manager for it. that will be
// initialized by the place registry and when that is finally complete, then we can let our
src/java/com/threerings/whirled/server/WhirledClient.java
+1 -2
View File
@@ -34,7 +34,6 @@ public class WhirledClient extends CrowdClient
// documentation inherited from interface
protected void clearLocation (BodyObject bobj)
{
WhirledServer.screg.sceneprov.leaveOccupiedScene(
(ScenedBodyObject)bobj);
WhirledServer.screg.leaveOccupiedScene((ScenedBodyObject)bobj);
}
}
src/java/com/threerings/whirled/spot/server/SpotProvider.java
+1 -2
View File
@@ -159,8 +159,7 @@ public class SpotProvider
try {
// move to the place object associated with this scene
_screg.sceneprov.effectSceneMove(
source, destmgr, sceneVer, listener);
_screg.effectSceneMove(source, destmgr, sceneVer, listener);
} catch (InvocationException sfe) {
listener.requestFailed(sfe.getMessage());
// and let the destination scene manager know that we're no
src/java/com/threerings/whirled/zone/server/ZoneProvider.java
+2 -2
View File
@@ -248,7 +248,7 @@ public class ZoneProvider
{
if (source.getZoneId() == zoneId) {
// handle the case of moving somewhere in the same zone
_screg.sceneprov.moveBody((BodyObject) source, sceneId);
_screg.moveBody((BodyObject) source, sceneId);
} else {
// first remove them from their old location
@@ -284,7 +284,7 @@ public class ZoneProvider
}
// remove them from their occupied scene
_screg.sceneprov.leaveOccupiedScene(source);
_screg.leaveOccupiedScene(source);
// and clear out their zone information
source.setZoneId(-1);