com.threerings.presents.dobj

Interface DObjectManager

All Known Subinterfaces:

RootDObjectManager

All Known Implementing Classes:

ClientDObjectMgr, LocalDObjectMgr, PresentsDObjectMgr

public interface DObjectManager

The distributed object manager is responsible for managing the creation and destruction of distributed objects and propagating dobj events to the appropriate subscribers. On the client, objects are managed as proxies to the real objects managed by the server, so attribute change requests are forwarded to the server and events coming down from the server are delivered to the local subscribers. On the server, the objects are managed directly.

Method Summary

Modifier and Type	Method and Description
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	removedLastSubscriber(DObject obj, boolean deathWish) When a distributed object removes its last subscriber, it will call this function to let the object manager know.
<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.

Method Detail

isManager

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.

subscribeToObject

<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. That subscriber will be notified when the object is available or if the subscription request failed.

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

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

Parameters:

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

target - The subscriber to be unsubscribed.

postEvent

void postEvent(DEvent event)

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.

Parameters:

event - The event to be dispatched.

removedLastSubscriber

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