com.threerings.presents.client

Class ClientDObjectMgr

java.lang.Object

com.threerings.presents.client.ClientDObjectMgr

All Implemented Interfaces:

DObjectManager, Runnable

public class ClientDObjectMgr
extends Object
implements DObjectManager, Runnable

The client distributed object manager manages a set of proxy objects which mirror the distributed objects maintained on the server. Requests for modifications, etc. are forwarded to the server and events are dispatched from the server to this client for objects to which this client is subscribed.

Constructor Summary

Constructors

Constructor and Description
ClientDObjectMgr(Communicator comm, Client client) Constructs a client distributed object manager.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Called when the client is cleaned up due to having disconnected from the server.
boolean	isManager(DObject object) Returns true if this distributed object manager is the authoritative manager for the specified distributed object, or false if we are only providing a proxy to the object.
void	postEvent(DEvent event) Posts a distributed object event into the system.
void	processMessage(Message msg) Called by the communicator when a message arrives from the network layer.
void	registerFlushDelay(Class<?> objclass, long delay) Registers an object flush delay.
void	removedLastSubscriber(DObject obj, boolean deathWish) When a distributed object removes its last subscriber, it will call this function to let the object manager know.
void	run() Invoked on the main client thread to process any newly arrived messages that we have waiting in our queue.
<T extends DObject> void	subscribeToObject(int oid, Subscriber<T> target) Requests that the specified subscriber be subscribed to the object identified by the supplied object id.
<T extends DObject> void	unsubscribeFromObject(int oid, Subscriber<T> target) Requests that the specified subscriber be unsubscribed from the object identified by the supplied object id.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDObjectMgr

public ClientDObjectMgr(Communicator comm,
                        Client client)

Constructs a client distributed object manager.

Parameters:

comm - a communicator instance by which it can communicate with the server.

client - a reference to the client that is managing this whole communications and event dispatch business.

Method Detail

isManager

public boolean isManager(DObject object)

Description copied from interface: DObjectManager

Returns true if this distributed object manager is the authoritative manager for the specified distributed object, or false if we are only providing a proxy to the object.

Specified by:

isManager in interface DObjectManager

subscribeToObject

public <T extends DObject> void subscribeToObject(int oid,
                                                  Subscriber<T> target)

Description copied from interface: DObjectManager

Requests that the specified subscriber be subscribed to the object identified by the supplied object id. That subscriber will be notified when the object is available or if the subscription request failed.

Specified by:

subscribeToObject in interface DObjectManager

Parameters:

oid - The object id of the distributed object to which subscription is desired.

target - The subscriber to be subscribed.

See Also:

Subscriber.objectAvailable(T), Subscriber.requestFailed(int, com.threerings.presents.dobj.ObjectAccessException)

unsubscribeFromObject

public <T extends DObject> void unsubscribeFromObject(int oid,
                                                      Subscriber<T> target)

Description copied from interface: DObjectManager

Requests that the specified subscriber be unsubscribed from the object identified by the supplied object id.

Specified by:

unsubscribeFromObject in interface DObjectManager

Parameters:

oid - The object id of the distributed object from which unsubscription is desired.

target - The subscriber to be unsubscribed.

postEvent

public void postEvent(DEvent event)

Description copied from interface: DObjectManager

Posts a distributed object event into the system. Instead of requesting the modification of a distributed object attribute by calling the setter for that attribute on the object itself, an AttributeChangedEvent can be constructed and posted directly. This is true for all event types and is useful for situations where one doesn't have access to the object in question, but needs to affect some event.

This event will be forwarded to the ultimate manager of the object (on the client, this means it will be forwarded to the server) where it will be checked for validity and then applied to the object and dispatched to all its subscribers.

Specified by:

postEvent in interface DObjectManager

Parameters:

event - The event to be dispatched.

removedLastSubscriber

public void removedLastSubscriber(DObject obj,
                                  boolean deathWish)

Description copied from interface: DObjectManager

When a distributed object removes its last subscriber, it will call this function to let the object manager know. The manager might then choose to flush this object from the system or unregister from some upstream manager whose object it was proxying, for example.

Specified by:

removedLastSubscriber in interface DObjectManager

registerFlushDelay

public void registerFlushDelay(Class<?> objclass,
                               long delay)

Registers an object flush delay.

See Also:

Client.registerFlushDelay(java.lang.Class<?>, long)

processMessage

public void processMessage(Message msg)

Called by the communicator when a message arrives from the network layer. We queue it up for processing and request some processing time on the main thread.

run

public void run()

Invoked on the main client thread to process any newly arrived messages that we have waiting in our queue.

Specified by:

run in interface Runnable

cleanup

public void cleanup()

Called when the client is cleaned up due to having disconnected from the server.