com.threerings.bureau.data

Class AgentObject

java.lang.Object

com.threerings.presents.dobj.DObject

com.threerings.bureau.data.AgentObject

All Implemented Interfaces:

Streamable

public class AgentObject
extends DObject

Contains information for configuring and communicating with an agent.

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.io.Streamable

Streamable.Closure

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUREAU_ID The field name of the bureauId field.
static String	BUREAU_TYPE The field name of the bureauType field.
String	bureauId The id of the bureau the agent is running in.
String	bureauType The type of bureau that the agent is running in.
static String	CLASS_NAME The field name of the className field.
String	className The main class within the code to use when launching an agent.
static String	CLIENT_OID The field name of the clientOid field.
int	clientOid The id of the client running this agent (only set after the agent is assigned to a bureau and run).
String	code The location of the code for the agent.
static String	CODE The field name of the code field.

Constructor Summary

Constructors

Constructor and Description
AgentObject()

Method Summary

Modifier and Type	Method and Description
void	setBureauId(String value) Requests that the bureauId field be set to the specified value.
void	setBureauType(String value) Requests that the bureauType field be set to the specified value.
void	setClassName(String value) Requests that the className field be set to the specified value.
void	setClientOid(int value) Requests that the clientOid field be set to the specified value.
void	setCode(String value) Requests that the code field be set to the specified value.
String	which() Returns a brief string that identifies this agent.

Methods inherited from class com.threerings.presents.dobj.DObject

acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet

Methods inherited from class java.lang.Object

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

Field Detail

BUREAU_ID

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final String BUREAU_ID

The field name of the bureauId field.

See Also:

Constant Field Values

BUREAU_TYPE

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final String BUREAU_TYPE

The field name of the bureauType field.

See Also:

Constant Field Values

CODE

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final String CODE

The field name of the code field.

See Also:

Constant Field Values

CLASS_NAME

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final String CLASS_NAME

The field name of the className field.

See Also:

Constant Field Values

CLIENT_OID

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final String CLIENT_OID

The field name of the clientOid field.

See Also:

Constant Field Values

bureauId

public String bureauId

The id of the bureau the agent is running in. This is normally a unique id corresponding to the game or item that requires some server-side processing.

bureauType

public String bureauType

The type of bureau that the agent is running in. This is normally derived from the kind of media that the game or item has specified for its code and determines the method of launching the bureau when the first agent is requested.

code

public String code

The location of the code for the agent. This could be a URL to an action script file or some other description that the bureau can use to load and execute the agent's code.

className

public String className

The main class within the code to use when launching an agent. Whether this value is used depends on the type of bureau and will be resolve in the bureau client.

clientOid

public int clientOid

The id of the client running this agent (only set after the agent is assigned to a bureau and run).

Constructor Detail

AgentObject

public AgentObject()

Method Detail

which

public String which()

Returns a brief string that identifies this agent. Use this instead of Object.toString() when you wish to report an agent object in a log message.

Overrides:

which in class DObject

setBureauId

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public void setBureauId(String value)

Requests that the bureauId field be set to the specified value. The local value will be updated immediately and an event will be propagated through the system to notify all listeners that the attribute did change. Proxied copies of this object (on clients) will apply the value change when they received the attribute changed notification.

setBureauType

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public void setBureauType(String value)

Requests that the bureauType field be set to the specified value. The local value will be updated immediately and an event will be propagated through the system to notify all listeners that the attribute did change. Proxied copies of this object (on clients) will apply the value change when they received the attribute changed notification.

setCode

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public void setCode(String value)

Requests that the code field be set to the specified value. The local value will be updated immediately and an event will be propagated through the system to notify all listeners that the attribute did change. Proxied copies of this object (on clients) will apply the value change when they received the attribute changed notification.

setClassName

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public void setClassName(String value)

Requests that the className field be set to the specified value. The local value will be updated immediately and an event will be propagated through the system to notify all listeners that the attribute did change. Proxied copies of this object (on clients) will apply the value change when they received the attribute changed notification.

setClientOid

@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public void setClientOid(int value)

Requests that the clientOid field be set to the specified value. The local value will be updated immediately and an event will be propagated through the system to notify all listeners that the attribute did change. Proxied copies of this object (on clients) will apply the value change when they received the attribute changed notification.